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.

Recuperar um cluster para uma nuvem

PDFs

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

Retorna o recurso da API Cluster 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 do recurso de nuvem que o contém

cluster_id

string

caminho

Verdadeiro

ID da coleção de clusters a ser listada

Resposta

Status: 200, Returns the stored Cluster 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-cluster"

versão

string

Verdadeiro

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

  • "1,0"

  • "1,1"

  • "1,2"

  • "1,3"

  • "1,4"

  • "1,5"

  • "1,6"

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 um nome para o cluster. Se não for especificado, o nome do cluster no Kubernetes será usado. 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 do cluster. Os valores definidos são:

  • "Pendente" - O cluster está agendado para descoberta

  • "descobrindo" - O cluster está em processo de descoberta

  • "Provisionamento" - O cluster está em processo de provisionamento

  • "Em execução" - O cluster está em execução normalmente

  • "failed" - O cluster está em estado de falha permanente

  • "removido" - O cluster não está acessível no momento

  • "Desconhecido" - O estado do cluster não pode ser determinado

stateUnready

array[string]

Verdadeiro

Matriz JSON de strings JSON, cada uma indicando um motivo pelo qual o cluster não consegue transitar para o estado "em execução", quando há problemas enquanto está no estado "em execução" ou por que transitou para o estado "com falha" ou "removido". Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 127

managedState

string

Verdadeiro

String JSON contendo um valor que indica o estado de gerenciamento do cluster. Os valores definidos são:

  • "Pendente" - O cluster está agendado para ser descoberto ou adicionado

  • "inelegível" - O cluster está no estado "em execução", não está sob gerenciamento e não é elegível para gerenciamento. Os motivos dessa inelegibilidade são fornecidos no valor da chave unready

  • "Não gerenciado" - O cluster está no estado "em execução" ou "com falha", não está sob gerenciamento e é elegível para gerenciamento

  • "Gerenciando" - O cluster está em estado "em execução" e está em processo de gerenciamento

  • "Gerenciado" - O cluster está no estado "em execução", "com falha" ou "removido" e está sob gerenciamento

protectionState

string

Verdadeiro

String JSON contendo um valor que indica o estado de proteção do cluster. Os valores definidos são:

  • "full" - A classe de armazenamento padrão do cluster suporta snapshots

  • "Parcial" - O cluster possui apenas storageClasses que não suportam snapshots

  • "atRisk" - A classe de armazenamento padrão do cluster não suporta snapshots

protectionStateDetails

array["type_astra_stateDetail"]

Verdadeiro

Matriz JSON de objetos JSON que lista detalhes adicionais sobre o estado de proteção atual, incluindo o motivo pelo qual esse estado foi atingido. Se não houver detalhes disponíveis, essa matriz estará vazia. Os valores definidos são:

  • Quantidade mínima de itens: 0

restoreTargetSupported

string

Falso

String JSON contendo um valor que indica a capacidade do cluster de ser um alvo para operações de gerenciamento de dados de aplicativos. Os valores definidos são:

  • "verdadeiro" - O cluster é um alvo elegível para operações de gerenciamento de dados de aplicativos.

  • "falso" - O cluster não é um alvo elegível para operações de gerenciamento de dados de app.

snapshotSupported

string

Falso

String JSON contendo um valor que indica a capacidade do cluster de executar operações semelhantes a backup de gerenciamento de dados de aplicativos. Os valores definidos são:

  • "verdadeiro" - O cluster está qualificado para executar operações de gerenciamento de dados do aplicativo.

  • "false" - O cluster não está qualificado para executar operações de gerenciamento de dados do aplicativo.

managedStateUnready

array[string]

Verdadeiro

Matriz JSON de strings JSON, cada uma indicando um motivo pelo qual o cluster não é elegível para ser gerenciado ou que o cluster está sendo gerenciado, mas erros não fatais foram encontrados durante o gerenciamento do cluster. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 127

managedTimestamp

string

Falso

String JSON contendo o carimbo de data/hora que indica quando o cluster foi colocado sob gerenciamento. Os valores definidos são:

  • Em conformidade com o esquema de data e hora ISO-8601. Esta chave só é retornada quando um cluster tem um managedState de "managed".

tridentVersion

string

Falso

String JSON contendo a versão do Trident instalada no cluster. Os valores definidos são:

  • Em conformidade com o esquema de versão do software

acpVersion

string

Falso

String JSON contendo a versão do Astra Control Provisioner instalada no cluster. Os valores definidos são:

  • Em conformidade com o esquema de versão do software

tridentManagedState

string

Falso

String JSON contendo um de um conjunto de valores enumerados que indicam o estado de gerenciamento do Trident neste cluster. Os valores definidos são:

  • "Gerenciado" - a instância Trident no cluster é gerenciada pelo Astra

  • "Não gerenciado" - a instância Trident no cluster não é gerenciada pelo Astra

tridentManagedStateDesired

string

Falso

String JSON contendo um valor que indica o estado de gerenciamento desejado para Trident. Os valores definidos são:

  • "managed" - Gerencie Trident neste cluster

  • "Não gerenciado" - Não gerencie Trident neste cluster

tridentManagedStateDetails

array["type_astra_stateDetail"]

Falso

Matriz JSON de objetos JSON que lista detalhes adicionais sobre o motivo da transição de estado para "gerenciado" ou "não gerenciado". + Se não houver detalhes disponíveis, esta matriz estará vazia.

  • Itens mínimos: 0

tridentManagedStateAllowed

array[string]

Falso

Estados que podem ser solicitados em um determinado tridentManagedState. Os seguintes estados podem ser solicitados em cada estado definido:

  • "gerenciado": "gerenciado"

  • "não gerenciado": "não gerenciado"

inUse

string

Verdadeiro

String JSON contendo um valor que indica se o cluster possui algum aplicativo gerenciado e, portanto, não pode ser excluído. Os valores definidos são:

  • "falso" - O cluster não é gerenciado ou é gerenciado, mas não possui aplicativos gerenciados associados a ele

  • "verdadeiro" - O cluster é gerenciado e possui aplicativos gerenciados associados a ele

accHost

string

Falso

String JSON que indica que este cluster hospeda a instância do Astra Control Center que está sendo acessada no momento. Os valores definidos são:

  • "true" - Este cluster está hospedando a instância do Astra Control Center que está sendo acessada no momento.

clusterType

string

Verdadeiro

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

  • "gke" - Kubernetes hospedado no Google Kubernetes Engine

  • "aks" - Kubernetes hospedado no serviço de Kubernetes do Microsoft Azure

  • "eks" - Kubernetes hospedado no Amazon Elastic Kubernetes Service

  • "rke" - O cluster é do tipo Rancher

  • "tanzu" - O cluster é do tipo Tanzu Kubernetes Grid

  • "openshift" - O cluster é do tipo OpenShift

  • "anthos" - O cluster é do tipo GKE Anthos

  • "kubernetes" - O cluster é Kubernetes genérico

clusterVersion

string

Falso

String JSON contendo um valor que indica a representação de versionamento semântico do ambiente do cluster. Para clusters Kubernetes, esta é a versão do Kubernetes. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 31

clusterVersionString

string

Falso

String JSON contendo um valor que indica as informações de versionamento estendidas para o ambiente de cluster. Para clusters Kubernetes, esta é a versão completa do Kubernetes. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 31

clusterCreationTimestamp

string

Falso

String JSON contendo o carimbo de data/hora que indica quando o cluster foi criado originalmente. Os valores definidos são:

  • Em conformidade com o esquema de data e hora ISO-8601

espaços de nomes

array[string]

Falso

Matriz JSON de strings JSON, cada uma indicando um namespace dentro do cluster. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 253

defaultStorageClass

string

Falso

String JSON contendo um ID de classe de armazenamento que corresponde à classe de armazenamento padrão definida no Kubernetes. Os valores definidos são:

  • Conforme o esquema de identificador Astra

cloudID

string

Verdadeiro

String JSON contendo um valor que indica o ID da nuvem na qual o cluster está sendo executado. Os valores definidos são:

  • Conforme o esquema de identificador Astra

ID da credencial

string

Falso

String JSON contendo um valor que indica o ID da credencial que contém o arquivo kubeconfig do cluster. Os valores definidos são:

  • Conforme o esquema de identificadores Astra. Se privateRouteID e connectorCapabilities com pelo menos a opção relay forem fornecidos, credentialID é opcional. Se eles não forem fornecidos, credentialID é obrigatório, caso contrário, um erro será gerado. Se credentialID e um conector com capacidade de relay forem fornecidos, um erro será gerado.

localização

string

Falso

String JSON contendo um valor fornecido pela nuvem na qual o cluster está sendo executado, indicando a localização específica do cluster nessa nuvem. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

isMultizonal

string

Falso

String JSON contendo um valor fornecido pela nuvem na qual o cluster está sendo executado, indicando se o cluster abrange duas ou mais zonas de disponibilidade. Os valores definidos são:

  • "verdadeiro" - O cluster abrange duas ou mais zonas de disponibilidade

  • "falso" - O cluster está totalmente localizado dentro de uma única zona de disponibilidade

ID da rota privada

string

Falso

String JSON contendo o ID de localização para clusters privados.

  • Comprimento mínimo: 1

  • Comprimento máximo: 255

connectorCapabilities

array[string]

Falso

Funcionalidades do conector associado a este cluster. Opcional para compatibilidade com versões anteriores. Se não estiver presente, assume-se a funcionalidade de proxy.

ID do serviço de API

string

Falso

String JSON contendo o UUID do objeto de serviço de API do Kubernetes (k8s). Usada para identificar um cluster de forma única.

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.
Exemplo de resposta 
{
  "type": "application/astra-cluster",
  "version": "1.6",
  "id": "b8c3bce9-5f8f-5f5a-a456-2b2eb6cfd2b6",
  "name": "GKE-22",
  "state": "running",
  "stateUnready": [],
  "managedState": "unmanaged",
  "managedStateUnready": [],
  "protectionState": "full",
  "protectionStateDetails": [],
  "tridentVersion": "23.10.0",
  "acpVersion": "23.10.0",
  "tridentManagedState": "managed",
  "tridentManagedStateDetails": [],
  "inUse": "false",
  "clusterType": "kubernetes",
  "clusterVersion": "1.91.1",
  "clusterVersionString": "1.19.1",
  "clusterCreationTimestamp": "2020-08-06T12:24:52.256624Z",
  "namespaces": [
    "kube-system",
    "kube-public",
    "my-app-1"
  ],
  "defaultStorageClass": "31c95aba-99d9-4987-b1bb-000dfce5952c",
  "cloudID": "548bdc1f-f00e-4a23-a062-83265d224d46",
  "credentialID": "6fa2f917-f730-41b8-9c15-17f531843b31",
  "location": "europe-west4",
  "isMultizonal": "false",
  "apiServiceID": "6bf33af2-872a-4553-a891-26b510c3edbe",
  "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"
}

Resposta

Status: 500, Internal server error
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/65",
  "title": "Cluster GET not performed",
  "detail": "The cluster GET call didn't perform the lookup operation on the cluster.",
  "status": "500"
}

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

additionalDetails

type_astra_stateDetail

Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

additionalDetails

"additionalDetails"

Falso

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

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