Skip to main content
Astra Automation
È disponibile una versione più recente di questo prodotto.
La versione in lingua italiana fornita proviene da una traduzione automatica. Per eventuali incoerenze, fare riferimento alla versione in lingua inglese.

Elenca tutte le impostazioni

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

Restituisce un array JSON di tutte le risorse corrispondenti nella raccolta. Se nella richiesta vengono specificati singoli campi, l'array JSON degli elementi conterrà i campi richiesti per ciascuna risorsa corrispondente nell'ordine specificato.

Parametri

Nome Tipo In Obbligatorio Descrizione

ID account

stringa

percorso

Vero

ID della risorsa account contenitore

  • esempio: {{.Account}}

includi

stringa

query

Falso

Indica quali campi devono essere restituiti durante l'elenco di una raccolta.

Esempi di URL: "include=id", "include=id,name"

Esempi OpenAPI: "id"

limite

stringa

query

Falso

Indica il numero massimo di risorse da restituire quando si elenca una raccolta.

Esempi di URL: "limit=2"

Esempi OpenAPI: "2"

filtro

stringa

query

Falso

Indica quali campi devono essere confrontati per restituire una risorsa durante l'elenco di una collezione.

Gli operatori supportati sono:

  • eq - Uguaglianza

  • lt/gt - Minore di/Maggiore di

  • lte/gte - Minore o uguale a/Maggiore o uguale a

Esempio di URL: "filter=field%20eq%20%27value%27"

Esempi OpenAPI: "field eq 'value'"

conta

stringa

query

Falso

Indica se il numero totale di risorse deve essere restituito nell'oggetto metadata.

Esempi di URL: "count=true"

Esempi OpenAPI: "true"

OrderBy

stringa

query

Falso

Indica l'ordine di visualizzazione delle risorse durante l'elenco di una collezione.

Esempi di URL: "orderBy=name", "orderBy=name%20desc"

Esempi OpenAPI: "name desc"

saltare

stringa

query

Falso

Indica il numero di risorse da saltare durante l'elenco di una raccolta.

Esempi di URL: "skip=1"

Esempi OpenAPI: "1"

Risposta

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Nome Tipo Obbligatorio Descrizione

elementi

array[Qualsiasi tra: "impostazione_1.1_ottieni_corpo_della_risposta", array[]]

Vero

metadati

"elenco_metadati_tipo_astra"

Vero

Risposta tipo
{
  "type": "application/astra-settings",
  "version": "1.1",
  "items": [
    {
      "type": "application/astra-setting",
      "version": "1.0",
      "id": "5da0a2ed-c51d-4d91-8b98-ed3aa8a88cc5",
      "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": "2021-06-04T20:14:52Z",
        "modificationTimestamp": "2021-06-04T20:14:52Z",
        "createdBy": "c9550bbb-e70b-4578-8504-07397f875bcb",
        "modifiedBy": "65e1571b-1b46-4f05-95b0-7d7f5a93da6a"
      }
    }
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Risposta

Status: 401, Unauthorized
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso

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

Risposta

Status: 400, Bad request
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso

invalidParams

vettore["invalidParams"]

Falso

Elenco dei parametri di query non validi

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

Risposta

Status: 403, Forbidden
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso

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

Risposta

Status: 503, Service unavailable
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso

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

Errore

Status: 404, Not found
Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

titolo

stringa

Vero

dettaglio

stringa

Vero

stato

stringa

Vero

ID correlazione

stringa

Falso

Esempio di risposta di errore
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definizioni

Vedi definizioni

tipo_json

Oggetto JSON contenente chiavi e valori che costituiscono la configurazione corrente per questa impostazione. Il contenuto di questo oggetto deve essere conforme allo schema JSON contenuto nel campo configSchema. I valori predefiniti sono forniti dalla configmap. Dopo che i valori predefiniti sono stati modificati dall'utente, non verranno sovrascritti.

tipo_json

Oggetto JSON contenente chiavi e valori che costituiscono la configurazione richiesta per questa impostazione. Il contenuto di questo oggetto deve essere conforme allo schema JSON contenuto nel campo configSchema. L'oggetto non esiste finché non viene specificato. Quando viene specificato, questo attiva il servizio di funzionalità per notificare al servizio corrispondente di richiedere che la configurazione desiderata possa essere applicata. Il servizio corrispondente può quindi eseguire la convalida e applicare la configurazione desiderata alla configurazione corrente.

proprietà

tipo_json_schema

Oggetto JSON contenente lo schema JSON per la proprietà config in questa risorsa. Deve essere conforme alla JSON Schema Draft 7. Se nella risorsa sono presenti valori di configurazione, la convalida rispetto al configSchema indicato è obbligatoria. Come convenzione comune, si raccomanda che le configurazioni abbiano un campo "isEnabled", quando appropriato. Il campo "isEnabled" contiene un valore che indica se l’impostazione è attiva ("true") o disattiva ("false").

Nome Tipo Obbligatorio Descrizione

$schema

stringa

Vero

tipo

stringa

Vero

proprietà

"proprietà"

Vero

additionalProperties

booleano

Vero

necessario

array[string]

Vero

etichetta tipo_astra

Nome Tipo Obbligatorio Descrizione

nome

stringa

Vero

valore

stringa

Vero

aggiornamento dei metadati di tipo Astra

Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:

  • Conforme allo schema dei metadati Astra. Se non specificato durante l'aggiornamento, le etichette dell'oggetto metadati, creationTimestamp e createdBy, verranno conservate senza modifiche.

Nome Tipo Obbligatorio Descrizione

etichette

vettore["etichetta tipo_astra"]

Falso

CreationTimestamp

stringa

Falso

ModificationTimestamp

stringa

Falso

CreatedBy

stringa

Falso

modifiedBy

stringa

Falso

impostazione_1.1_ottieni_corpo_della_risposta

Nome Tipo Obbligatorio Descrizione

tipo

stringa

Vero

Tipo di media della risorsa. I valori definiti sono:

  • "application/astra-setting"

versione

stringa

Vero

Versione della risorsa. I valori definiti sono:

  • "1,0"

  • "1,1"

id

stringa

Vero

Identificatore univoco globale della risorsa. I valori definiti sono:

  • Conforme allo schema UUIDv4

nome

stringa

Vero

Stringa JSON contenente un nome per l'impostazione, in notazione gerarchica con punti (.). I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 63

  • Questa stringa viene convalidata internamente per prevenire attacchi XSS, Unicode, directory traversal e SQL-injection. Questo valore è specificato dalla configmap che viene caricata in fase di esecuzione e non può essere modificato dall'utente.

currentConfig

"tipo_json"

Vero

Oggetto JSON contenente chiavi e valori che costituiscono la configurazione corrente per questa impostazione. Il contenuto di questo oggetto deve essere conforme allo schema JSON contenuto nel campo configSchema. I valori predefiniti sono forniti dalla configmap. Dopo che i valori predefiniti sono stati modificati dall'utente, non verranno sovrascritti.

desiredConfig

"tipo_json"

Falso

Oggetto JSON contenente chiavi e valori che costituiscono la configurazione richiesta per questa impostazione. Il contenuto di questo oggetto deve essere conforme allo schema JSON contenuto nel campo configSchema. L'oggetto non esiste finché non viene specificato. Quando viene specificato, questo attiva il servizio di funzionalità per notificare al servizio corrispondente di richiedere che la configurazione desiderata possa essere applicata. Il servizio corrispondente può quindi eseguire la convalida e applicare la configurazione desiderata alla configurazione corrente.

configSchema

"tipo_json_schema"

Vero

Oggetto JSON contenente lo schema JSON per la proprietà config in questa risorsa. Deve essere conforme alla JSON Schema Draft 7. Se nella risorsa sono presenti valori di configurazione, la convalida rispetto al configSchema indicato è obbligatoria. Come convenzione comune, si raccomanda che le configurazioni abbiano un campo "isEnabled", quando appropriato. Il campo "isEnabled" contiene un valore che indica se l’impostazione è attiva ("true") o disattiva ("false").

stato

stringa

Vero

Stringa JSON contenente un valore che indica lo stato operativo dell'applicazione. I valori definiti sono:

  • "valido" - La configurazione corrente corrisponde alla configurazione desiderata.

  • "in sospeso" - La configurazione desiderata è in fase di applicazione.

  • "error" - La configurazione desiderata non può essere applicata.

stateUnready

array[string]

Vero

Array JSON di stringhe JSON, ognuna delle quali indica il motivo per cui l'impostazione non è stata applicata correttamente. I valori definiti sono:

  • Lunghezza minima: 1

  • Lunghezza massima: 127

metadati

"aggiornamento dei metadati di tipo Astra"

Vero

Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:

  • Conforme allo schema dei metadati Astra. Se non specificato durante l'aggiornamento, le etichette dell'oggetto metadati, creationTimestamp e createdBy, verranno conservate senza modifiche.

elenco_metadati_tipo_astra

Nome Tipo Obbligatorio Descrizione

continuare

stringa

Falso

conta

numero

Falso

etichette

vettore["etichetta tipo_astra"]

Falso

CreationTimestamp

stringa

Falso

ModificationTimestamp

stringa

Falso

CreatedBy

stringa

Falso

modifiedBy

stringa

Falso

invalidParams

Nome Tipo Obbligatorio Descrizione

nome

stringa

Vero

Nome del parametro di query non valido

motivo

stringa

Vero

Motivo per cui il parametro di query non è valido