Skip to main content
Astra Automation
Hay disponible una nueva versión de este producto.
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.

Listar todos los buckets

PDF

GET /accounts/{account_id}/topology/v1/buckets

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

account_id

cadena

ruta

Verdadero

ID del recurso de cuenta que lo contiene

  • ejemplo: {{.Account}}

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

Verdadero

metadatos

"type_astra_metadata_list"

Verdadero
Ejemplo de respuesta 
{
  "type": "application/astra-buckets",
  "version": "1.2",
  "items": [
    [
      "4c753e39-25e9-4b36-a8de-69f168aa59cd",
      "Test Bucket",
      "gcp"
    ],
    [
      "d8fd585d-6429-4c08-a308-af193a88eac7",
      "Local",
      "ontap-s3"
    ]
  ],
  "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

array["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

type_astra_stateDetail

Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

s3

Objeto JSON que proporciona parámetros de protocolo de Simple Storage Service (S3). (Usa este objeto para todos los proveedores de tipo S3).

Nombre Tipo Obligatorio Descripción

serverURL

cadena

Verdadero

Cadena JSON que contiene una URL a la ruta base para el bucket. Los valores definidos son:

  • Longitud mínima: 0

  • Longitud máxima: 1023

bucketName

cadena

Verdadero

Cadena JSON que contiene el nombre del bucket S3. Los valores definidos son:

  • Longitud mínima: 0

  • Longitud máxima: 63

gcp

Objeto JSON que proporciona los parámetros del protocolo de Google Cloud.

Nombre Tipo Obligatorio Descripción

bucketName

cadena

Verdadero

Cadena JSON que contiene el nombre del bucket de Google Cloud de respaldo. Los valores definidos son:

  • Longitud mínima: 0

  • Longitud máxima: 63

azure

Objeto JSON que proporciona los parámetros del protocolo Azure.

Nombre Tipo Obligatorio Descripción

storageAccount

cadena

Verdadero

Cadena JSON que contiene el nombre de la cuenta de almacenamiento Azure. Los valores definidos son:

  • Longitud mínima: 0

  • Longitud máxima: 63

bucketName

cadena

Verdadero

Cadena JSON que contiene el nombre del blob Azure de respaldo. Los valores definidos son:

  • Longitud mínima: 0

  • Longitud máxima: 63

bucketParameters

Objeto JSON que proporciona información específica del proveedor del bucket necesaria para acceder al bucket. Los valores específicos de este bucket varían según el proveedor.

Nombre Tipo Obligatorio Descripción

s3

"s3"

Falso

Objeto JSON que proporciona parámetros de protocolo de Simple Storage Service (S3). (Usa este objeto para todos los proveedores de tipo S3).

gcp

"gcp"

Falso

Objeto JSON que proporciona los parámetros del protocolo de Google Cloud.

azure

"azure"

Falso

Objeto JSON que proporciona los parámetros del protocolo Azure.

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 al recurso. Los valores definidos son:

  • Se ajusta 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

bucket_1.2_get_response_body

Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

Tipo de medio del recurso. Los valores definidos son:

  • "application/astra-bucket"

versión

cadena

Verdadero

Versión del recurso. Los valores definidos son:

  • "1,0"

  • "1,1"

  • "1,2"

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 asignado por el usuario para el bucket. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 256

credentialID

cadena

Verdadero

Cadena JSON que contiene el identificador de las credenciales utilizadas para acceder al bucket. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

estado

cadena

Verdadero

Cadena JSON que contiene un valor que indica el estado operativo del bucket. Los valores definidos son:

  • "pendiente" - El bucket está programado para ser descubierto

  • "available" - El bucket está disponible para su uso

  • "failed" - El bucket está en estado de fallo permanente

  • "eliminado" - El bucket no es accesible actualmente

  • "desconocido" - No se puede determinar el estado del bucket

stateDetails

array["type_astra_stateDetail"]

Verdadero

Matriz JSON de objetos JSON que enumera detalles adicionales sobre por qué "state" pasó a "removed" o "failed". Si no hay detalles disponibles, esta matriz estará vacía.

  • Elementos mínimos: 0

proveedor

cadena

Verdadero

Cadena JSON que indica el protocolo del bucket que puede utilizarse para acceder al bucket. Los valores definidos son:

  • "ontap-s3"

  • "storagegrid-s3"

  • "generic-s3"

  • "gcp"

  • "azure"

  • "aws"

bucketParameters

"bucketParameters"

Verdadero

Objeto JSON que proporciona información específica del proveedor del bucket necesaria para acceder al bucket. Los valores específicos de este bucket varían según el proveedor.

metadatos

"type_astra_metadatos_update"

Verdadero

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

  • Se ajusta 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