Skip to main content
Eine neuere Version dieses Produkts ist erhältlich.
Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

Eine Einstellung abrufen

Änderungen vorschlagen

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

Gibt die gespeicherte Setting-API-Ressource im JSON-Antworttext zurück.

Parameter

Name Typ In Erforderlich Beschreibung

Konto-ID

Zeichenkette

Pfad

True

ID der übergeordneten Kontoressource

  • Beispiel: {{.Account}}

Einstellungs-ID

Zeichenkette

Pfad

True

ID der aufzulistenden Einstellungssammlung

Antwort

Status: 200, Returns the stored Setting API resource in the JSON response body.
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Medientyp der Ressource. Folgende Werte sind definiert:

  • "application/astra-setting"

Version

Zeichenkette

True

Version der Ressource. Folgende Werte sind definiert:

  • "1,0"

  • "1,1"

id

Zeichenkette

True

Weltweit eindeutiger Bezeichner der Ressource. Folgende Werte sind definiert:

  • Entspricht dem UUIDv4-Schema

Name

Zeichenkette

True

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

  • 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"

True

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"

True

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

True

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]

True

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

  • Mindestlänge: 1

  • Maximale Länge: 127

Metadaten

"type_astra_metadata_update"

True

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

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

Beispielantwort
{
  "type": "application/astra-setting",
  "version": "1.1",
  "id": "ea510866-47d3-5130-8468-563df4cd6a28",
  "name": "astra.account.smtp",
  "currentConfig": {
    "credential": "",
    "isEnabled": "false",
    "port": 587,
    "relayServer": "smtp.sendgrid.net"
  },
  "configSchema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "astra.account.smtp",
    "type": "object",
    "properties": {
      "credential": {
        "type": "string",
        "description": "The credential ID for SMTP authentication."
      },
      "isEnabled": {
        "type": "string",
        "description": "This property determines if this setting is enabled or not."
      },
      "port": {
        "type": "integer",
        "description": "The SMTP port. For an unencrypted or a TLS connection, use port 25, 2525, or 587."
      },
      "relayServer": {
        "type": "string",
        "description": "This setting is sometimes referred to as the external SMTP server or the SMTP relay."
      }
    },
    "additionalProperties": false,
    "required": [
      "relayServer",
      "port",
      "isEnabled"
    ]
  },
  "state": "valid",
  "stateUnready": [],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Antwort

Status: 401, Unauthorized
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

Korrelations-ID

Zeichenkette

Falsch

invalidParams

Array["invalidParams"]

Falsch

Liste ungültiger Abfrageparameter

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

Antwort

Status: 403, Forbidden
Name Typ Erforderlich Beschreibung

Typ

Zeichenkette

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

True

Titel

Zeichenkette

True

Detail

Zeichenkette

True

Status

Zeichenkette

True

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

True

Typ

Zeichenkette

True

Eigenschaften

"Eigenschaften"

True

additionalProperties

boolescher Wert

True

erforderlich

Array[string]

True

Typ_Astra_Label

Name Typ Erforderlich Beschreibung

Name

Zeichenkette

True

Wert

Zeichenkette

True

type_astra_metadata_update

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

  • 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

True

Name des ungültigen Abfrageparameters

Grund

Zeichenkette

True

Grund, warum der Abfrageparameter ungültig ist