Criar um novo bucket
POST /accounts/{account_id}/topology/v1/buckets
Indica os valores desejados para o recurso da API Bucket a ser criado.
Parâmetros
| Nome | Tipo | Em | Obrigatório | Descrição |
|---|---|---|---|---|
id_da_conta |
string |
caminho |
Verdadeiro |
ID do recurso de conta que o contém
|
Corpo da solicitação
Indica os valores desejados para o recurso da API Bucket a ser criado.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
Tipo de mídia do recurso. Os valores definidos são:
|
versão |
string |
Verdadeiro |
Versão do recurso. Os valores definidos são:
|
nome |
string |
Falso |
String JSON contendo um nome atribuído pelo usuário para o bucket. Os valores definidos são:
|
ID da credencial |
string |
Verdadeiro |
String JSON contendo o identificador das credenciais usadas para acessar o bucket. Os valores definidos são:
|
provedor |
string |
Verdadeiro |
String JSON que indica o protocolo do bucket que pode ser usado para acessar o bucket. Os valores definidos são:
|
bucketParameters |
Verdadeiro |
Objeto JSON que fornece informações específicas do provedor do bucket, necessárias para acessar o bucket. Os valores específicos neste bucket variam de acordo com o provedor. |
|
metadados |
Falso |
Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:
|
Exemplo de solicitação
{
"type": "application/astra-bucket",
"version": "1.2",
"name": "Test Bucket",
"credentialID": "d5b3854c-38de-42c6-9269-b5c052aba76f",
"provider": "gcp",
"bucketParameters": {
"gcp": {
"bucketName": "bucketName"
}
}
}
Resposta
Status: 201, Returns the newly created bucket resource in the JSON response body.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
Tipo de mídia do recurso. Os valores definidos são:
|
versão |
string |
Verdadeiro |
Versão do recurso. Os valores definidos são:
|
id |
string |
Verdadeiro |
Identificador globalmente único do recurso. Os valores definidos são:
|
nome |
string |
Verdadeiro |
String JSON contendo um nome atribuído pelo usuário para o bucket. Os valores definidos são:
|
ID da credencial |
string |
Verdadeiro |
String JSON contendo o identificador das credenciais usadas para acessar o bucket. Os valores definidos são:
|
estado |
string |
Verdadeiro |
String JSON contendo um valor que indica o estado operacional do bucket. Os valores definidos são:
|
stateDetails |
array["type_astra_stateDetail"] |
Verdadeiro |
Matriz JSON de objetos JSON que lista detalhes adicionais sobre o motivo da transição do "state" para "removed" ou "failed". Se não houver detalhes disponíveis, essa matriz estará vazia.
|
provedor |
string |
Verdadeiro |
String JSON que indica o protocolo do bucket que pode ser usado para acessar o bucket. Os valores definidos são:
|
bucketParameters |
Verdadeiro |
Objeto JSON que fornece informações específicas do provedor do bucket, necessárias para acessar o bucket. Os valores específicos neste bucket variam de acordo com o provedor. |
|
metadados |
Verdadeiro |
Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:
|
Exemplo de resposta
{
"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"
}
}
Resposta
Status: 401, Unauthorized
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
|
status |
string |
Verdadeiro |
|
ID de correlação |
string |
Falso |
Exemplo de resposta
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Resposta
Status: 400, Bad request
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
|
status |
string |
Verdadeiro |
|
ID de correlação |
string |
Falso |
|
invalidFields |
array["invalidFields"] |
Falso |
Lista de campos inválidos no corpo da requisição |
Exemplo de resposta
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Resposta
Status: 409, Conflict
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
|
status |
string |
Verdadeiro |
|
ID de correlação |
string |
Falso |
|
invalidFields |
array["invalidFields"] |
Falso |
Lista de campos inválidos no corpo da requisição |
Exemplo de resposta
{
"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"
}
Resposta
Status: 403, Forbidden
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
|
status |
string |
Verdadeiro |
|
ID de correlação |
string |
Falso |
Exemplo de resposta
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Erro
Status: 404, Not found
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
|
status |
string |
Verdadeiro |
|
ID de correlação |
string |
Falso |
Exemplo de resposta de erro
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definições
Ver definições
s3
Objeto JSON que fornece parâmetros do protocolo Simple Storage Service (S3). (Use este objeto para todos os provedores do tipo S3).
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
URL do servidor |
string |
Verdadeiro |
String JSON contendo um URL para o caminho base do bucket. Os valores definidos são:
|
bucketName |
string |
Verdadeiro |
String JSON contendo o nome do bucket S3. Os valores definidos são:
|
gcp
Objeto JSON que fornece parâmetros do protocolo Google Cloud.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
bucketName |
string |
Verdadeiro |
String JSON contendo o nome do bucket do Google Cloud que está sendo usado como base. Os valores definidos são:
|
azure
Objeto JSON que fornece parâmetros do protocolo Azure.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
storageAccount |
string |
Verdadeiro |
String JSON contendo o nome da conta de armazenamento do Azure. Os valores definidos são:
|
bucketName |
string |
Verdadeiro |
String JSON contendo o nome do blob do Azure subjacente. Os valores definidos são:
|
bucketParameters
Objeto JSON que fornece informações específicas do provedor do bucket, necessárias para acessar o bucket. Os valores específicos neste bucket variam de acordo com o provedor.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
s3 |
Falso |
Objeto JSON que fornece parâmetros do protocolo Simple Storage Service (S3). (Use este objeto para todos os provedores do tipo S3). |
|
gcp |
Falso |
Objeto JSON que fornece parâmetros do protocolo Google Cloud. |
|
azure |
Falso |
Objeto JSON que fornece parâmetros do protocolo Azure. |
tipo_astra_label
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nome |
string |
Verdadeiro |
|
valor |
string |
Verdadeiro |
type_astra_metadados_update
Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:
-
Está em conformidade com o esquema de metadados Astra. Se não for especificado na criação, um objeto de metadados será criado sem rótulos. Se não for especificado na atualização, os rótulos do objeto de metadados, creationTimestamp e createdBy, serão preservados sem modificação.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
etiquetas |
array["tipo_astra_label"] |
Falso |
|
CriaçãoTimestamp |
string |
Falso |
|
Alteração do Timestamp |
string |
Falso |
|
CreatedBy |
string |
Falso |
|
modifiedBy |
string |
Falso |
type_astra_stateDetail
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
invalidParams
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nome |
string |
Verdadeiro |
Nome do parâmetro de consulta inválido |
razão |
string |
Verdadeiro |
Motivo pelo qual o parâmetro de consulta é inválido |
invalidFields
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nome |
string |
Verdadeiro |
Nome do campo inválido no corpo da requisição |
razão |
string |
Verdadeiro |
Motivo pelo qual o campo do corpo da solicitação é inválido |