Skip to main content
Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

Eine Einstellung ändern

Änderungen vorschlagen
PDFs

PUT /accounts/{account_id}/core/v1/settings/{setting_id}

Ersetzt die gesamte gespeicherte Ressource durch den bereitgestellten JSON-Anfragetext, wobei Schlüsselwerte erhalten bleiben, die vom Benutzer nicht geändert werden können.

Parameter

Name Typ In Erforderlich Beschreibung

Konto-ID

Zeichenkette

Pfad

Wahr

ID der übergeordneten Kontoressource

  • Beispiel: {{.Account}}

Einstellungs-ID

Zeichenkette

Pfad

Wahr

ID der aufzulistenden Einstellungssammlung

Anfragetext

Ersetzt die gesamte gespeicherte Ressource durch den bereitgestellten JSON-Anfragetext, wobei Schlüsselwerte erhalten bleiben, die vom Benutzer nicht geändert werden können.

Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

Wahr

Medientyp der Ressource. Definierte Werte sind:

  • "application/astra-setting"

Version

Zeichenkette

Wahr

Version der Ressource. Definierte Werte sind:

  • "1,0"

  • "1,1"

id

Zeichenkette

Falsch

Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:

  • Entspricht dem UUIDv4-Schema

Name

Zeichenkette

Falsch

JSON-Zeichenkette mit einem Namen für die Einstellung in hierarchischer Punktnotation (.). Definierte Werte sind:

  • Mindestlänge: 1

  • Maximale Länge: 63

  • Diese Zeichenkette wird intern validiert, um XSS-, Unicode-, Directory-Traversal- und SQL-Injection-Angriffe zu verhindern. Dieser Wert wird durch die zur Laufzeit geladene configmap festgelegt und kann vom Benutzer nicht geändert werden.

currentConfig

"type_json"

Falsch

Ein JSON-Objekt mit Schlüsseln und Werten, die die aktuelle Konfiguration für diese Einstellung bilden. Der Inhalt dieses Objekts muss dem im configSchema-Feld enthaltenen JSON-Schema entsprechen. Standardwerte werden von der configmap bereitgestellt. Nachdem die Standardwerte vom Benutzer geändert wurden, werden sie nicht überschrieben.

desiredConfig

"type_json"

Falsch

Ein JSON-Objekt mit Schlüsseln und Werten, die die angeforderte Konfiguration für diese Einstellung bilden. Der Inhalt dieses Objekts muss dem im configSchema-Feld enthaltenen JSON-Schema entsprechen. Das Objekt existiert erst, wenn es angegeben wurde. Wenn angegeben, veranlasst dies den Feature-Service, den entsprechenden Service zu benachrichtigen, damit die gewünschte Konfiguration angefordert werden kann. Der entsprechende Service kann dann die Validierung durchführen und die gewünschte Konfiguration auf die aktuelle Konfiguration anwenden.

configSchema

"type_json_schema"

Falsch

JSON-Objekt, das das JSON-Schema für die config-Eigenschaft in dieser Ressource enthält. Muss JSON Schema Draft 7 entsprechen. Wenn config-Werte in der Ressource vorhanden sind, ist die Validierung gegen das angegebene configSchema obligatorisch. Als allgemeine Konvention wird empfohlen, dass Konfigurationen ein "isEnabled"-Feld haben, wenn angemessen. Das "isEnabled"-Feld enthält einen Wert, der angibt, ob die Einstellung eingeschaltet ("true") oder ausgeschaltet ("false") ist.

Zustand

Zeichenkette

Falsch

JSON-Zeichenkette mit einem Wert, der den Betriebszustand der Anwendung angibt. Folgende Werte sind definiert:

  • "gültig" - Die aktuelle Konfiguration entspricht der gewünschten Konfiguration.

  • "Ausstehend" - Die gewünschte Konfiguration wird angewendet.

  • "Fehler" - Die gewünschte Konfiguration kann nicht angewendet werden.

stateUnready

Array[string]

Falsch

JSON-Array von JSON-Zeichenketten, die jeweils einen Grund dafür angeben, warum die Einstellung nicht erfolgreich angewendet wurde. Definierte Werte sind:

  • Mindestlänge: 1

  • Maximale Länge: 127

Metadaten

"type_astra_metadata_update"

Falsch

Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:

  • Entspricht dem Astra-Metadatenschema. Falls beim Aktualisieren nichts anderes angegeben wird, werden die Bezeichnungen, creationTimestamp und createdBy des Metadatenobjekts unverändert beibehalten.
Beispielanfrage 
{
  "type": "application/astra-setting",
  "version": "1.1",
  "desiredConfig": {
    "credential": "e3d2ea77-398e-49be-85fd-ec66d9426a06",
    "port": 587,
    "relayServer": "smtp.sendgrid.net",
    "isEnabled": "true"
  }
}

Antwort

Status: 204, Indicates if the setting resource was updated.

Antwort

Status: 401, Unauthorized
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

Wahr

Titel

Zeichenkette

Wahr

Detail

Zeichenkette

Wahr

Status

Zeichenkette

Wahr

Korrelations-ID

Zeichenkette

Falsch
Beispielantwort 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Antwort

Status: 400, Bad request
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

Wahr

Titel

Zeichenkette

Wahr

Detail

Zeichenkette

Wahr

Status

Zeichenkette

Wahr

Korrelations-ID

Zeichenkette

Falsch

invalidFields

Array["invalidFields"]

Falsch

Liste ungültiger Anfragetextfelder
Beispielantwort 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Antwort

Status: 409, Conflict
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

Wahr

Titel

Zeichenkette

Wahr

Detail

Zeichenkette

Wahr

Status

Zeichenkette

Wahr

Korrelations-ID

Zeichenkette

Falsch

invalidFields

Array["invalidFields"]

Falsch

Liste ungültiger Anfragetextfelder
Beispielantwort 
{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

Antwort

Status: 403, Forbidden
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

Wahr

Titel

Zeichenkette

Wahr

Detail

Zeichenkette

Wahr

Status

Zeichenkette

Wahr

Korrelations-ID

Zeichenkette

Falsch
Beispielantwort 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Antwort

Status: 503, Service unavailable
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

Wahr

Titel

Zeichenkette

Wahr

Detail

Zeichenkette

Wahr

Status

Zeichenkette

Wahr

Korrelations-ID

Zeichenkette

Falsch
Beispielantwort 
{
  "type": "https://astra.netapp.io/problems/41",
  "title": "Service not ready",
  "detail": "Currently, the service can't respond to this request.",
  "status": "503"
}

Fehler

Status: 404, Not found
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

Wahr

Titel

Zeichenkette

Wahr

Detail

Zeichenkette

Wahr

Status

Zeichenkette

Wahr

Korrelations-ID

Zeichenkette

Falsch
Beispiel-Fehlermeldung 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definitionen

Siehe Definitionen

type_json

Ein JSON-Objekt mit Schlüsseln und Werten, die die aktuelle Konfiguration für diese Einstellung bilden. Der Inhalt dieses Objekts muss dem im configSchema-Feld enthaltenen JSON-Schema entsprechen. Standardwerte werden von der configmap bereitgestellt. Nachdem die Standardwerte vom Benutzer geändert wurden, werden sie nicht überschrieben.

type_json

Ein JSON-Objekt mit Schlüsseln und Werten, die die angeforderte Konfiguration für diese Einstellung bilden. Der Inhalt dieses Objekts muss dem im configSchema-Feld enthaltenen JSON-Schema entsprechen. Das Objekt existiert erst, wenn es angegeben wurde. Wenn angegeben, veranlasst dies den Feature-Service, den entsprechenden Service zu benachrichtigen, damit die gewünschte Konfiguration angefordert werden kann. Der entsprechende Service kann dann die Validierung durchführen und die gewünschte Konfiguration auf die aktuelle Konfiguration anwenden.

Eigenschaften

type_json_schema

JSON-Objekt, das das JSON-Schema für die config-Eigenschaft in dieser Ressource enthält. Muss JSON Schema Draft 7 entsprechen. Wenn config-Werte in der Ressource vorhanden sind, ist die Validierung gegen das angegebene configSchema obligatorisch. Als allgemeine Konvention wird empfohlen, dass Konfigurationen ein "isEnabled"-Feld haben, wenn angemessen. Das "isEnabled"-Feld enthält einen Wert, der angibt, ob die Einstellung eingeschaltet ("true") oder ausgeschaltet ("false") ist.

Name Typ Erforderlich Beschreibung

$schema

Zeichenkette

Wahr

Typ

Zeichenkette

Wahr

Eigenschaften

"Eigenschaften"

Wahr

additionalProperties

boolescher Wert

Wahr

erforderlich

Array[string]

Wahr

Typ_Astra_Label

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

Wahr

Wert

Zeichenkette

Wahr

type_astra_metadata_update

Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:

  • Entspricht dem Astra-Metadatenschema. Falls beim Aktualisieren nichts anderes angegeben wird, werden die Bezeichnungen, creationTimestamp und createdBy des Metadatenobjekts unverändert beibehalten.

Name Typ Erforderlich Beschreibung

Etiketten

Array["Typ_Astra_Label"]

Falsch

CreationZeitstempel

Zeichenkette

Falsch

Änderungszeitstempel

Zeichenkette

Falsch

Erstellt von

Zeichenkette

Falsch

modifiedBy

Zeichenkette

Falsch

invalidParams

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

Wahr

Name des ungültigen Abfrageparameters

Grund

Zeichenkette

Wahr

Grund, warum der Abfrageparameter ungültig ist

invalidFields

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

Wahr

Name des ungültigen Anfragetextfelds

Grund

Zeichenkette

Wahr

Grund, warum das Anfragekörperfeld ungültig ist