Skip to main content
Astra Automation
Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

Lista todas las cuentas

PDF

GET /accounts

Devuelve una matriz JSON de todos los recursos coincidentes de la colección. Si se especifican campos individuales en la solicitud, la matriz JSON de elementos contendrá los campos solicitados para cada recurso coincidente en el orden especificado.

Parámetros

Nombre Tipo En Obligatorio Descripción

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

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"

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"

continuar

consulta

Falso

Indica el token desde el que reanudar el listado.

Ejemplos de URL: "continue="

Ejemplos OpenAPI: ""</continue>

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: "account_1.0_get_response_body", array[]]

Verdadero

metadatos

"type_astra_metadata_list"

Verdadero
Ejemplo de respuesta 
{
  "type": "application/astra-accounts",
  "version": "1.0",
  "items": [
    {
      "type": "application/astra-account",
      "version": "1.0",
      "id": "70796606-79ba-480b-966c-e4c600fbf622",
      "name": "fraught-pines",
      "state": "active",
      "isEnabled": "true",
      "enabledTimestamp": "2020-08-06T12:24:52.256624Z",
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-08-06T12:24:52.256624Z",
        "createdBy": "1723a17e-9fd1-4636-86e1-2ec9e04bce51"
      }
    },
    {
      "type": "application/astra-account",
      "version": "1.0",
      "id": "7976114d-35ec-48a7-ba31-22d8e94a8bb2",
      "name": "sad-dino",
      "state": "active",
      "isEnabled": "true",
      "enabledTimestamp": "2020-08-06T12:24:52.256624Z",
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-08-06T12:24:52.256624Z",
        "createdBy": "1723a17e-9fd1-4636-86e1-2ec9e04bce51"
      }
    }
  ],
  "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 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
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 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"
}

Error

Status: 404, Not found
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

postalAddress

Objeto JSON que contiene una colección de cadenas JSON que especifican una dirección. Si esta clave no existe, indica que no se ha proporcionado una dirección. Si esta clave existe, las seis cadenas JSON contenidas estarán presentes. Si no proporcionas nada, la cadena estará vacía.

Nombre Tipo Obligatorio Descripción

addressCountry

cadena

Verdadero

Cadena JSON que contiene el nombre del país o el código de país asociado a la dirección postal, tal como se especifica en ISO 3166 Alpha-2. Los valores definidos son:

  • Longitud mínima: 2

  • Longitud máxima: 2

addressLocality

cadena

Verdadero

Cadena JSON que contiene la localidad (por ejemplo, ciudad) asociada a la dirección postal. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

addressRegion

cadena

Verdadero

Cadena JSON que contiene la región (por ejemplo, estado) asociada a la dirección postal. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

postalCode

cadena

Verdadero

Cadena JSON que contiene el código postal asociado a la dirección postal. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 31

streetAddress1

cadena

Verdadero

Cadena JSON que contiene la dirección de la calle asociada a la dirección postal. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

streetAddress2

cadena

Falso

Cadena JSON que contiene información auxiliar opcional sobre la dirección, el apartado de correos y más. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

accountContact

Objeto JSON que contiene información de contacto del usuario para crear un usuario propietario en el momento de la activación de la cuenta.

Nombre Tipo Obligatorio Descripción

firstName

cadena

Verdadero

Cadena JSON que contiene un nombre largo especificado por el usuario. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

  • Esta cadena se valida internamente para prevenir ataques XSS, Unicode, directory traversal y SQL-injection.

lastName

cadena

Verdadero

Cadena JSON que contiene un apellido largo especificado por el usuario. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

  • Esta cadena se valida internamente para prevenir ataques XSS, Unicode, directory traversal y SQL-injection.

companyName

cadena

Falso

Cadena JSON que contiene el nombre de la empresa asociada al usuario. Si esta clave no existe, indica que no se ha proporcionado un nombre de empresa. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

  • Esta cadena se valida internamente para prevenir ataques XSS, Unicode, directory traversal y SQL-injection.

correo electrónico

cadena

Verdadero

Cadenas JSON que contienen una dirección de correo electrónico especificada por el usuario. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

teléfono

cadena

Falso

Cadena JSON que contiene el número de teléfono del usuario. Si esta clave no existe, indica que no se ha proporcionado un número de teléfono. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 31

postalAddress

"postalAddress"

Verdadero

Objeto JSON que contiene una colección de cadenas JSON que especifican una dirección. Si esta clave no existe, indica que no se ha proporcionado una dirección. Si esta clave existe, las seis cadenas JSON contenidas estarán presentes. Si no proporcionas nada, la cadena estará vacía.

etiqueta_tipo_astra

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:

  • Conforme al esquema de metadatos de Astra. Si no se especifica al crear, se creará un objeto de metadatos sin etiquetas. Si no se especifica al actualizar, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.

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

account_1.0_get_response_body

Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

Tipo de medio del recurso. Los valores definidos son:

  • "application/astra-account"

versión

cadena

Verdadero

Versión del recurso. Los valores definidos son:

  • "1,0"

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 la cuenta. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

  • Esta cadena se valida internamente para prevenir ataques XSS, Unicode, directory traversal y SQL-injection.

estado

cadena

Verdadero

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

  • "pendiente" - Solo se pueden realizar cambios en los recursos de usuario y rol de la cuenta (valor por defecto)

  • "activo" - Se pueden realizar cambios en cualquier recurso de la cuenta

  • "deletePending" - Los usuarios no pueden iniciar sesión, las operaciones de protección de datos se suspenden, los cargos dejan de acumularse

isEnabled

cadena

Verdadero

Cadena JSON que indica que la cuenta está habilitada. Los valores definidos son:

  • "false" - Los usuarios no pueden utilizar esta cuenta

  • "true" - Los usuarios pueden utilizar esta cuenta

enabledTimestamp

cadena

Falso

Cadena JSON que contiene la marca de tiempo que indica cuándo se habilitó la cuenta por última vez. Si la cuenta nunca se ha habilitado, este campo está ausente. Los valores definidos son:

  • Cumple con el esquema de fecha y hora ISO-8601

accountContact

"accountContact"

Falso

Objeto JSON que contiene información de contacto del usuario para crear un usuario propietario en el momento de la activación de la cuenta.

metadatos

"type_astra_metadatos_update"

Verdadero

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

  • Conforme al esquema de metadatos de Astra. Si no se especifica al crear, se creará un objeto de metadatos sin etiquetas. Si no se especifica al actualizar, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.

type_astra_metadata_list

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