Skip to main content
Astra Automation
O português é fornecido por meio de tradução automática para sua conveniência. O inglês precede o português em caso de inconsistências.

Recuperar uma nuvem

GET /accounts/{account_id}/topology/v1/clouds/{cloud_id}

Retorna o recurso da Cloud API armazenado no corpo da resposta JSON.

Parâmetros

Nome Tipo Em Obrigatório Descrição

id_da_conta

string

caminho

Verdadeiro

ID do recurso de conta que o contém

  • exemplo: {{.Account}}

id_da_nuvem

string

caminho

Verdadeiro

ID da coleção de nuvens a ser listada

Resposta

Status: 200, Returns the stored Cloud API 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:

  • "application/astra-cloud"

versão

string

Verdadeiro

Versão do recurso. Os valores definidos são:

  • "1,0"

  • "1,1"

id

string

Verdadeiro

Identificador globalmente único do recurso. Os valores definidos são:

  • Em conformidade com o esquema UUIDv4

nome

string

Verdadeiro

String JSON contendo o nome da nuvem. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

  • Essa string é validada internamente para evitar ataques de XSS, Unicode, travessia de diretório e injeção de SQL

estado

string

Verdadeiro

Cadeia JSON contendo um valor que indica o estado operacional da nuvem. Os valores definidos são:

  • "Pendente" - A nuvem está programada para descoberta

  • "Descobrindo" - A nuvem está em processo de descoberta

  • "Provisionamento" - A nuvem está em processo de provisionamento

  • "Em execução" - A nuvem está funcionando normalmente

  • "Falhou" - A nuvem está em estado de falha permanente

  • "Removido" - A nuvem não está acessível no momento

  • "Desconhecido" - O estado da nuvem não pode ser determinado

stateUnready

array[string]

Verdadeiro

Matriz JSON de strings JSON, cada uma indicando um motivo pelo qual uma nuvem não consegue fazer a transição para "em execução" ou por que fez a transição para "falhou". Valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 127

cloudType

string

Verdadeiro

String JSON contendo um valor que indica o tipo de nuvem. Os valores definidos são:

  • "gcp" - A nuvem é fornecida pelo Google

  • "azure" - A nuvem é fornecida pela Microsoft

  • "aws" - A nuvem é fornecida pela Amazon

  • "Privado" - A nuvem é gerenciada pelo cliente

ID da credencial

string

Falso

String JSON contendo um valor que indica o ID da credencial que contém a conta de serviço para a nuvem. Isso é necessário para cloudType "gcp", "azure" e "aws". Os valores definidos são:

  • Conforme o esquema de identificador Astra

ID do bucket padrão

string

Falso

String JSON contendo o ID de um bucket que será usado por padrão ao criar backups de aplicativos na nuvem. Isso é necessário ao clonar aplicativos entre clusters e é usado como padrão caso nenhum bucket seja especificado ao criar backups e agendamentos. Os valores definidos são:

  • Conforme o esquema de identificador Astra

metadados

"type_astra_metadados_update"

Verdadeiro

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme 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.

Exemplo de resposta
{
  "type": "application/astra-cloud",
  "version": "1.1",
  "id": "1c9512c3-ec62-5ed8-8013-02fc090b9d03",
  "name": "GKE",
  "state": "discovering",
  "stateUnready": [
    "Cloud discovery in progress"
  ],
  "cloudType": "gcp",
  "credentialID": "6fa2f917-f730-41b8-9c15-17f531843b31",
  "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

invalidParams

array["invalidParams"]

Falso

Lista de parâmetros de consulta inválidos

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: 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

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:

  • Conforme 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

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