Crear un nuevo bucket
POST /accounts/{account_id}/topology/v1/buckets
Indica los valores deseados para el recurso Bucket API que se va a crear.
Parámetros
| Nombre | Tipo | En | Obligatorio | Descripción |
|---|---|---|---|---|
account_id |
cadena |
ruta |
Verdadero |
ID del recurso de cuenta que lo contiene
|
Cuerpo de la solicitud
Indica los valores deseados para el recurso Bucket API que se va a crear.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
nombre |
cadena |
Falso |
Cadena JSON que contiene un nombre asignado por el usuario para el bucket. Los valores definidos son:
|
credentialID |
cadena |
Verdadero |
Cadena JSON que contiene el identificador de las credenciales utilizadas para acceder al bucket. Los valores definidos son:
|
proveedor |
cadena |
Verdadero |
Cadena JSON que indica el protocolo del bucket que puede utilizarse para acceder al bucket. Los valores definidos son:
|
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 |
Falso |
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
|
Ejemplo de solicitud
{
"type": "application/astra-bucket",
"version": "1.2",
"name": "Test Bucket",
"credentialID": "d5b3854c-38de-42c6-9269-b5c052aba76f",
"provider": "gcp",
"bucketParameters": {
"gcp": {
"bucketName": "bucketName"
}
}
}
Respuesta
Status: 201, Returns the newly created bucket resource in the JSON response body.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
id |
cadena |
Verdadero |
Identificador único global del recurso. Los valores definidos son:
|
nombre |
cadena |
Verdadero |
Cadena JSON que contiene un nombre asignado por el usuario para el bucket. Los valores definidos son:
|
credentialID |
cadena |
Verdadero |
Cadena JSON que contiene el identificador de las credenciales utilizadas para acceder al bucket. Los valores definidos son:
|
estado |
cadena |
Verdadero |
Cadena JSON que contiene un valor que indica el estado operativo del bucket. Los valores definidos son:
|
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.
|
retentionTime |
número |
Falso |
Número de segundos que representa el tiempo que se conservará un archivo en este bucket. Los valores definidos son:
|
proveedor |
cadena |
Verdadero |
Cadena JSON que indica el protocolo del bucket que puede utilizarse para acceder al bucket. Los valores definidos son:
|
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 |
Verdadero |
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
|
Ejemplo de respuesta
{
"type": "application/astra-bucket",
"version": "1.2",
"id": "9b296ce0-c545-5022-acfa-1980c5aaea97",
"name": "Test Bucket",
"credentialID": "8f039324-7795-40bf-a5ca-4442580f7ab0",
"state": "available",
"stateDetails": [],
"provider": "gcp",
"bucketParameters": {
"gcp": {
"bucketName": "bucketName"
}
},
"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 |
|
invalidFields |
array["invalidFields"] |
Falso |
Lista de campos no válidos en el cuerpo de la solicitud |
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: 409, Conflict
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
|
invalidFields |
array["invalidFields"] |
Falso |
Lista de campos no válidos en el cuerpo de la solicitud |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
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
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:
|
bucketName |
cadena |
Verdadero |
Cadena JSON que contiene el nombre del bucket S3. Los valores definidos son:
|
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:
|
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:
|
bucketName |
cadena |
Verdadero |
Cadena JSON que contiene el nombre del blob Azure de respaldo. Los valores definidos son:
|
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 |
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 |
Falso |
Objeto JSON que proporciona los parámetros del protocolo de Google Cloud. |
|
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:
-
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 |
additionalDetails
type_astra_stateDetail
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
additionalDetails |
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 |
invalidFields
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
Nombre del campo no válido del cuerpo de la solicitud |
motivo |
cadena |
Verdadero |
Motivo por el que el campo del cuerpo de la solicitud no es válido |