Skip to main content
Astra Automation
Uma versão mais recente deste produto está disponível.
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.

Liste todas as nuvens

PDFs

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

Retorna uma matriz JSON com todos os recursos correspondentes na coleção. Se campos individuais forem especificados na solicitação, a matriz JSON de itens conterá os campos solicitados para cada recurso correspondente na ordem especificada.

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

incluir

string

consulta

Falso

Indica quais campos devem ser retornados ao listar uma coleção.

Exemplos de URL: "include=id", "include=id,name"

Exemplos OpenAPI: "id"

  • exemplo: id, nome, estado

limite

string

consulta

Falso

Indica o número máximo de recursos a serem retornados ao listar uma coleção.

Exemplos de URL: "limit=2"

Exemplos OpenAPI: "2"

filtro

string

consulta

Falso

Indica quais campos devem ser correspondidos para retornar um recurso ao listar uma coleção.

Os operadores suportados são:

  • eq - Igualdade

  • lt/gt - Menor que/Maior que

  • lte/gte - Menor ou igual a/Maior ou igual a

Exemplo de URL: "filter=field%20eq%20%27value%27"

Exemplos OpenAPI: "campo eq 'valor'"

Resposta

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.
Nome Tipo Obrigatório Descrição

itens

array[Qualquer um de: "cloud_1.1_get_response_body", array[]]

Verdadeiro

metadados

"type_astra_metadata_list"

Verdadeiro
Exemplo de resposta 
{
  "type": "application/astra-clouds",
  "version": "1.1",
  "items": [
    [
      "2f9e63fa-8ba8-414a-a57c-0f3042b80682",
      "gcp",
      "discovering"
    ],
    [
      "f723febe-b167-44dd-b07d-c075a8bbe4f3",
      "aws",
      "failed"
    ]
  ],
  "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:

  • 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

cloud_1.1_get_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". Os 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:

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

type_astra_metadata_list

Nome Tipo Obrigatório Descrição

continuar

string

Falso

contar

número

Falso

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