Lista de todos los ajustes

Parámetros

Nombre	Tipo	En	Obligatorio	Descripción
account_id	cadena	ruta	Verdadero	ID del recurso de cuenta que lo contiene ejemplo: {{.Account}}
incluya	cadena	consulta	Falso	Indica qué campos deben devolverse al listar una colección. Ejemplos de URL: "include=id", "include=id,name" Ejemplos OpenAPI: "id"
límite	cadena	consulta	Falso	Indica el número máximo de recursos a devolver al listar una colección. Ejemplos de URL: "limit=2" Ejemplos OpenAPI: "2"
filtro	cadena	consulta	Falso	Indica qué campos deben coincidir para devolver un recurso al listar una colección. Los operadores admitidos son: eq - Igualdad lt/gt - Menor que/Mayor que lte/gte - Menor o igual que/Mayor o igual que Ejemplo de URL: "filter=field%20eq%20%27value%27" Ejemplos OpenAPI: "field eq 'value'"
cuente	cadena	consulta	Falso	Indica si se debe devolver el número total de recursos en el objeto de metadatos. Ejemplos de URL: "count=true" Ejemplos de OpenAPI: "true"
OrderBy	cadena	consulta	Falso	Indica el orden de clasificación de los recursos al listar una colección. Ejemplos de URL: "orderBy=name", "orderBy=name%20desc" Ejemplos OpenAPI: "name desc"
omitir	cadena	consulta	Falso	Indica el número de recursos que deben omitirse al listar una colección. Ejemplos de URL: "skip=1" Ejemplos OpenAPI: "1"

Nombre

Tipo

En

Obligatorio

Descripción

account_id

cadena

ruta

Verdadero

ID del recurso de cuenta que lo contiene

ejemplo: {{.Account}}

incluya

cadena

consulta

Falso

Indica qué campos deben devolverse al listar una colección.

Ejemplos de URL: "include=id", "include=id,name"

Ejemplos OpenAPI: "id"

límite

cadena

consulta

Falso

Indica el número máximo de recursos a devolver al listar una colección.

Ejemplos de URL: "limit=2"

Ejemplos OpenAPI: "2"

filtro

cadena

consulta

Falso

Indica qué campos deben coincidir para devolver un recurso al listar una colección.

Los operadores admitidos son:

eq - Igualdad
lt/gt - Menor que/Mayor que
lte/gte - Menor o igual que/Mayor o igual que

Ejemplo de URL: "filter=field%20eq%20%27value%27"

Ejemplos OpenAPI: "field eq 'value'"

cuente

cadena

consulta

Falso

Indica si se debe devolver el número total de recursos en el objeto de metadatos.

Ejemplos de URL: "count=true"

Ejemplos de OpenAPI: "true"

OrderBy

cadena

consulta

Falso

Indica el orden de clasificación de los recursos al listar una colección.

Ejemplos de URL: "orderBy=name", "orderBy=name%20desc"

Ejemplos OpenAPI: "name desc"

omitir

cadena

consulta

Falso

Indica el número de recursos que deben omitirse al listar una colección.

Ejemplos de URL: "skip=1"

Ejemplos OpenAPI: "1"

Respuesta

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.

Nombre	Tipo	Obligatorio	Descripción
artículos	array[Cualquiera de: "setting_1.1_get_response_body", array[]]	Verdadero
metadatos	"type_astra_metadata_list"	Verdadero

Nombre

Tipo

Obligatorio

Descripción

artículos

array[Cualquiera de: "setting_1.1_get_response_body", array[]]

Verdadero

metadatos

"type_astra_metadata_list"

Verdadero

Ejemplo de respuesta

{
  "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"
  }
}

Respuesta

Status: 401, Unauthorized

Nombre	Tipo	Obligatorio
tipo	cadena	Verdadero
título	cadena	Verdadero
detalle	cadena	Verdadero
estado	cadena	Verdadero
correlationID	cadena	Falso

Nombre

Tipo

Obligatorio

Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso

Ejemplo de respuesta

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

Respuesta

Status: 400, Bad request

Nombre	Tipo	Obligatorio	Descripción
tipo	cadena	Verdadero
título	cadena	Verdadero
detalle	cadena	Verdadero
estado	cadena	Verdadero
correlationID	cadena	Falso
invalidParams	matriz["invalidParams"]	Falso	Lista de parámetros de consulta no válidos

Nombre

Tipo

Obligatorio

Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso

invalidParams

matriz["invalidParams"]

Falso

Lista de parámetros de consulta no válidos

Ejemplo de respuesta

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

Respuesta

Status: 403, Forbidden

Nombre	Tipo	Obligatorio
tipo	cadena	Verdadero
título	cadena	Verdadero
detalle	cadena	Verdadero
estado	cadena	Verdadero
correlationID	cadena	Falso

Nombre

Tipo

Obligatorio

Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso

Ejemplo de respuesta

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

Respuesta

Status: 503, Service unavailable

Nombre	Tipo	Obligatorio
tipo	cadena	Verdadero
título	cadena	Verdadero
detalle	cadena	Verdadero
estado	cadena	Verdadero
correlationID	cadena	Falso

Nombre

Tipo

Obligatorio

Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso

Ejemplo de respuesta

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

Error

Status: 404, Not found

Nombre	Tipo	Obligatorio
tipo	cadena	Verdadero
título	cadena	Verdadero
detalle	cadena	Verdadero
estado	cadena	Verdadero
correlationID	cadena	Falso

Nombre

Tipo

Obligatorio

Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso

Ejemplo de respuesta de error

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

Definiciones

Ver definiciones

tipo_json

Objeto JSON que contiene las claves y valores que componen la configuración actual para este ajuste. El contenido de este objeto debe ajustarse al esquema JSON contenido en el campo configSchema. Los valores por defecto son suministrados por el configmap. Después de que los valores por defecto sean modificados por el usuario, no serán sobrescritos.

tipo_json

Objeto JSON que contiene claves y valores que conforman la configuración solicitada para esta configuración. El contenido de este objeto debe ajustarse al esquema JSON contenido en el campo configSchema. El objeto no existe hasta que se especifica. Cuando se especifica, esto hace que el servicio de características notifique al servicio correspondiente para solicitar que se pueda aplicar la configuración deseada. El servicio correspondiente puede entonces realizar la validación y aplicar la configuración deseada a la configuración actual.

propiedades

type_json_schema

Objeto JSON que contiene el esquema JSON para la propiedad config en este recurso. Debe ajustarse a JSON Schema Draft 7. Si los valores config están presentes en el recurso, la validación contra el configSchema indicado es obligatoria. Como convención común, se recomienda que las configuraciones tengan un campo "isEnabled", cuando sea apropiado. El campo "isEnabled" contiene un valor que indica si la configuración está activada ("true") o desactivada ("false").

Nombre	Tipo	Obligatorio
$schema	cadena	Verdadero
tipo	cadena	Verdadero
propiedades	"propiedades"	Verdadero
additionalProperties	booleano	Verdadero
obligatorio	array[string]	Verdadero

Nombre

Tipo

Obligatorio

Descripción

$schema

cadena

Verdadero

tipo

cadena

Verdadero

propiedades

"propiedades"

Verdadero

additionalProperties

booleano

Verdadero

obligatorio

array[string]

Verdadero

etiqueta_tipo_astra

Nombre	Tipo	Obligatorio	Descripción
nombre	cadena	Verdadero
valor	cadena	Verdadero

Nombre

Tipo

Obligatorio

Descripción

nombre

cadena

Verdadero

valor

cadena

Verdadero

type_astra_metadatos_update

Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son:

Se ajusta al esquema de metadatos de Astra Si no se especifica en la actualización, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.

Nombre	Tipo	Obligatorio
etiquetas	array["etiqueta_tipo_astra"]	Falso
CreationTimestamp	cadena	Falso
Modificación.Marca de hora	cadena	Falso
CreatedBy	cadena	Falso
modifiedBy	cadena	Falso

Nombre

Tipo

Obligatorio

Descripción

etiquetas

array["etiqueta_tipo_astra"]

Falso

CreationTimestamp

cadena

Falso

Modificación.Marca de hora

cadena

Falso

CreatedBy

cadena

Falso

modifiedBy

cadena

Falso

setting_1.1_get_response_body

Nombre	Tipo	Obligatorio	Descripción
tipo	cadena	Verdadero	Tipo de medio del recurso. Los valores definidos son: "application/astra-setting"
versión	cadena	Verdadero	Versión del recurso. Los valores definidos son: "1,0" "1,1"
id	cadena	Verdadero	Identificador único global del recurso. Los valores definidos son: Cumple con el esquema UUIDv4
nombre	cadena	Verdadero	Cadena JSON que contiene un nombre para el ajuste, en notación jerárquica de puntos (.). Los valores definidos son: Longitud mínima: 1 Longitud máxima: 63 Esta cadena es validada internamente para prevenir ataques XSS, Unicode, directory traversal y SQL-injection. Este valor es especificado por el configmap que es cargado en tiempo de ejecución y no puede ser actualizado por el usuario.
currentConfig	"tipo_json"	Verdadero	Objeto JSON que contiene las claves y valores que componen la configuración actual para este ajuste. El contenido de este objeto debe ajustarse al esquema JSON contenido en el campo configSchema. Los valores por defecto son suministrados por el configmap. Después de que los valores por defecto sean modificados por el usuario, no serán sobrescritos.
desiredConfig	"tipo_json"	Falso	Objeto JSON que contiene claves y valores que conforman la configuración solicitada para esta configuración. El contenido de este objeto debe ajustarse al esquema JSON contenido en el campo configSchema. El objeto no existe hasta que se especifica. Cuando se especifica, esto hace que el servicio de características notifique al servicio correspondiente para solicitar que se pueda aplicar la configuración deseada. El servicio correspondiente puede entonces realizar la validación y aplicar la configuración deseada a la configuración actual.
configSchema	"type_json_schema"	Verdadero	Objeto JSON que contiene el esquema JSON para la propiedad config en este recurso. Debe ajustarse a JSON Schema Draft 7. Si los valores config están presentes en el recurso, la validación contra el configSchema indicado es obligatoria. Como convención común, se recomienda que las configuraciones tengan un campo "isEnabled", cuando sea apropiado. El campo "isEnabled" contiene un valor que indica si la configuración está activada ("true") o desactivada ("false").
estado	cadena	Verdadero	Cadena JSON que contiene un valor que indica el estado operativo de la aplicación. Los valores definidos son: "válido" - La configuración actual coincide con la configuración deseada. "pendiente" - Se está aplicando la configuración deseada. "error" - No se puede aplicar la configuración deseada.
stateUnready	array[string]	Verdadero	Matriz JSON de cadenas JSON, cada una de las cuales indica un motivo por el que la configuración no se ha aplicado correctamente. Los valores definidos son: Longitud mínima: 1 Longitud máxima: 127
metadatos	"type_astra_metadatos_update"	Verdadero	Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son: Se ajusta al esquema de metadatos de Astra Si no se especifica en la actualización, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.

Nombre

Tipo

Obligatorio

Descripción

tipo

cadena

Verdadero

Tipo de medio del recurso. Los valores definidos son:

"application/astra-setting"

versión

cadena

Verdadero

Versión del recurso. Los valores definidos son:

"1,0"
"1,1"

id

cadena

Verdadero

Identificador único global del recurso. Los valores definidos son:

Cumple con el esquema UUIDv4

nombre

cadena

Verdadero

Cadena JSON que contiene un nombre para el ajuste, en notación jerárquica de puntos (.). Los valores definidos son:

Longitud mínima: 1
Longitud máxima: 63
Esta cadena es validada internamente para prevenir ataques XSS, Unicode, directory traversal y SQL-injection. Este valor es especificado por el configmap que es cargado en tiempo de ejecución y no puede ser actualizado por el usuario.

currentConfig

"tipo_json"

Verdadero

Objeto JSON que contiene las claves y valores que componen la configuración actual para este ajuste. El contenido de este objeto debe ajustarse al esquema JSON contenido en el campo configSchema. Los valores por defecto son suministrados por el configmap. Después de que los valores por defecto sean modificados por el usuario, no serán sobrescritos.

desiredConfig

"tipo_json"

Falso

Objeto JSON que contiene claves y valores que conforman la configuración solicitada para esta configuración. El contenido de este objeto debe ajustarse al esquema JSON contenido en el campo configSchema. El objeto no existe hasta que se especifica. Cuando se especifica, esto hace que el servicio de características notifique al servicio correspondiente para solicitar que se pueda aplicar la configuración deseada. El servicio correspondiente puede entonces realizar la validación y aplicar la configuración deseada a la configuración actual.

configSchema

"type_json_schema"

Verdadero

Objeto JSON que contiene el esquema JSON para la propiedad config en este recurso. Debe ajustarse a JSON Schema Draft 7. Si los valores config están presentes en el recurso, la validación contra el configSchema indicado es obligatoria. Como convención común, se recomienda que las configuraciones tengan un campo "isEnabled", cuando sea apropiado. El campo "isEnabled" contiene un valor que indica si la configuración está activada ("true") o desactivada ("false").

estado

cadena

Verdadero

Cadena JSON que contiene un valor que indica el estado operativo de la aplicación. Los valores definidos son:

"válido" - La configuración actual coincide con la configuración deseada.
"pendiente" - Se está aplicando la configuración deseada.
"error" - No se puede aplicar la configuración deseada.

stateUnready

array[string]

Verdadero

Matriz JSON de cadenas JSON, cada una de las cuales indica un motivo por el que la configuración no se ha aplicado correctamente. Los valores definidos son:

Longitud mínima: 1
Longitud máxima: 127

metadatos

"type_astra_metadatos_update"

Verdadero

Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son:

Se ajusta al esquema de metadatos de Astra Si no se especifica en la actualización, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.

type_astra_metadata_list

Nombre	Tipo	Obligatorio
continuar	cadena	Falso
cuente	número	Falso
etiquetas	array["etiqueta_tipo_astra"]	Falso
CreationTimestamp	cadena	Falso
Modificación.Marca de hora	cadena	Falso
CreatedBy	cadena	Falso
modifiedBy	cadena	Falso

Nombre

Tipo

Obligatorio

Descripción

continuar

cadena

Falso

cuente

número

Falso

etiquetas

array["etiqueta_tipo_astra"]

Falso

CreationTimestamp

cadena

Falso

Modificación.Marca de hora

cadena

Falso

CreatedBy

cadena

Falso

modifiedBy

cadena

Falso

invalidParams

Nombre	Tipo	Obligatorio	Descripción
nombre	cadena	Verdadero	Nombre del parámetro de consulta no válido
motivo	cadena	Verdadero	Razón por la que el parámetro de consulta no es válido

Nombre

Tipo

Obligatorio

Descripción

nombre

cadena

Verdadero

Nombre del parámetro de consulta no válido

motivo

cadena

Verdadero

Razón por la que el parámetro de consulta no es válido

Lista de todos los ajustes

Creating your file...

Parámetros

Respuesta

Respuesta

Respuesta

Respuesta

Respuesta

Error

Definiciones