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.

Listar todos os aplicativos

PDFs

GET /accounts/{account_id}/k8s/v2/apps

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: "app_2.2_get_response_body", array[]]

Verdadeiro

metadados

"type_astra_metadata_list"

Verdadeiro
Exemplo de resposta 
{
  "type": "application/astra-apps",
  "version": "2.2",
  "items": [
    [
      "2ff50f4b-fe40-4980-913f-8a4469184822",
      "mysql",
      "ready"
    ],
    [
      "ae1e6561-9e22-406c-8a5a-762f4604da00",
      "jenkins",
      "ready"
    ]
  ],
  "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

targetSchema

aceitar-post

aceitar-put

dicas

Nome Tipo Obrigatório Descrição

status

string

Falso

permitir

array[string]

Falso

aceitar-post

"aceitar-post"

Falso

permissões

array[string]

Falso

aceitar-put

"aceitar-put"

Falso

tipo_astra_link

Nome Tipo Obrigatório Descrição

rel

string

Verdadeiro

href

string

Verdadeiro

tipo

string

Falso

targetSchema

"targetSchema"

Falso

título

string

Falso

dicas

"dicas"

Falso

GVK

Objeto JSON contendo um grupo/versão/tipo do Kubernetes.

  • Este objeto é validado internamente em relação ao Astra/apiResources.

Nome Tipo Obrigatório Descrição

grupo

string

Verdadeiro

String JSON contendo um identificador de grupo atribuído pelo Kubernetes.

  • Esta string é validada internamente em relação ao Astra/apiResources

tipo

string

Verdadeiro

String JSON contendo um identificador de tipo atribuído pelo Kubernetes.

  • Esta string é validada internamente em relação ao Astra/apiResources

versão

string

Verdadeiro

String JSON contendo um identificador de versão atribuído pelo Kubernetes.

  • Esta string é validada internamente em relação ao Astra/apiResources

clusterScopedResources

Nome Tipo Obrigatório Descrição

GVK

"GVK"

Verdadeiro

Objeto JSON contendo um grupo/versão/tipo do Kubernetes.

  • Este objeto é validado internamente em relação ao Astra/apiResources.

labelSelectors

array[string]

Falso

Array JSON de strings JSON representando um seletor de rótulo para os GroupVersionKinds (GVKs) com escopo de cluster dentro do cluster. Se estiver vazio, todas as instâncias de GVK no cluster serão incluídas. Cada elemento neste array é uma string de seletor de rótulo do Kubernetes e segue a mesma gramática para esses valores. Exemplos:

namespaceScopedResources

Nome Tipo Obrigatório Descrição

namespace

string

Verdadeiro

String JSON contendo o nome de um namespace no qual o aplicativo está definido. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 253

  • Em conformidade com o esquema de rótulos DNS 1123

labelSelectors

array[string]

Verdadeiro

Array JSON de strings JSON representando um seletor de rótulo dentro do namespace. Se estiver vazio, todos os recursos no namespace serão incluídos. Cada elemento neste array é uma string de seletor de rótulo do Kubernetes e segue a gramática para esses valores. Exemplos:

  • [ "app=mysql" ] — Seleciona todos os recursos que possuem um rótulo cujo nome é app e cujo valor é mysql

  • [ "app != mysql" ] — Seleciona todos os recursos que possuem um rótulo cujo nome é app e cujo valor não é mysql

  • [ "app in (mysql, mariadb)" ] — Seleciona todos os recursos que possuem um rótulo cujo nome é app e valor é mysql ou mariadb

  • [ "app notin (nginx, wordpress)" ] — Seleciona todos os recursos que não possuem um rótulo cujo nome seja app e cujos valores sejam nginx ou wordpress

  • [ "app" ] — Seleciona todos os recursos que possuem um rótulo chamado app

  • [ "!app" ] — Seleciona todos os recursos que não possuem um rótulo chamado app. Observe que vários operadores de seleção podem ser incluídos em um único seletor, separados por vírgulas. Nesse caso, os resultados dos operadores de seleção individuais são combinados com o operador AND:

  • [ "app=mysql,version=2" ] — Seleciona todos os recursos que possuem um rótulo cujo nome é app e cujo valor é mysql e um rótulo cujo nome é version e cujo valor é 2

type_astra_stateTransition

Nome Tipo Obrigatório Descrição

de

string

Verdadeiro

para

array[string]

Verdadeiro

type_astra_stateDetail

Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

namespaceMapping

Nome Tipo Obrigatório Descrição

fonte

string

Verdadeiro

String JSON contendo o nome do namespace no cluster de origem. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 253

  • Em conformidade com o esquema de rótulos DNS 1123

destino

string

Verdadeiro

String JSON contendo o nome do namespace no cluster de destino. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 253

  • Em conformidade com o esquema de rótulos DNS 1123

storageClassMapping

Nome Tipo Obrigatório Descrição

fonte

string

Verdadeiro

String JSON contendo o nome da classe de armazenamento de origem. Também pode ser '*' para especificar todas as classes de armazenamento de origem. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

  • Está em conformidade com o esquema de rótulos DNS 1123 se o nome da Storage Class for usado

  • '*' para especificar todas as classes de armazenamento

destino

string

Verdadeiro

String JSON contendo o nome da classe de armazenamento de destino. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

  • Em conformidade com o esquema de rótulos DNS 1123

GVKN

Nome Tipo Obrigatório Descrição

grupo

string

Falso

String JSON contendo um identificador de grupo atribuído pelo Kubernetes.

  • Esta string é validada internamente em relação ao Astra/apiResources

versão

string

Falso

String JSON contendo um identificador de versão atribuído pelo Kubernetes.

  • Esta string é validada internamente em relação ao Astra/apiResources

tipo

string

Falso

String JSON contendo um identificador de tipo atribuído pelo Kubernetes.

  • Esta string é validada internamente em relação ao Astra/apiResources

espaços de nomes

array[string]

Falso

Matriz JSON de strings JSON que descrevem os namespaces dos quais os recursos devem ser incluídos ou excluídos. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

  • Em conformidade com o esquema de rótulos DNS 1123

nomes

array[string]

Falso

Matriz JSON de strings JSON descrevendo nomes de recursos do Kubernetes a serem incluídos ou excluídos da restauração seletiva. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 253

  • Em conformidade com o esquema de rótulos DNS 1123

labelSelectors

array[string]

Falso

Array JSON de strings JSON que descrevem os seletores de rótulos do Kubernetes usados para incluir ou excluir recursos da restauração seletiva. Cada elemento neste array é uma string de seletor de rótulo do Kubernetes e segue a mesma gramática para esses valores. Exemplos:

restoreFilter

Objeto JSON contendo uma lista de filtros que descrevem quais recursos são incluídos ou excluídos de uma operação de restauração seletiva. Incluir e excluir são mutuamente exclusivos, e uma restauração seletiva só pode usar um tipo de filtro.

Nome Tipo Obrigatório Descrição

resourceSelectionCriteria

string

Falso

String JSON contendo um valor que indica como os filtros de recursos selecionam recursos. Os valores válidos são include ou exclude.

GVKN

array["GVKN"]

Falso

Matriz JSON de objetos JSON que descrevem os recursos a serem filtrados durante uma restauração seletiva. Um recurso corresponde a um único elemento de filtro GVKN se todos os campos de filtro especificados corresponderem ao campo de recurso correspondente. Campos de filtro que são matrizes (por exemplo, namespaces e nomes) correspondem se qualquer um de seus elementos corresponder ao campo de recurso correspondente. O campo labelSelectors exige que todos os seletores correspondam. Um recurso que corresponde a qualquer filtro na matriz de objetos de filtro GVKN é incluído ou excluído da restauração com base no valor resourceSelectionCriteria. Especificar objetos GVKN vazios resulta em um erro de validação.

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

app_2.2_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-app"

versão

string

Verdadeiro

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

  • "2,0"

  • "2,1"

  • "2,2"

id

string

Verdadeiro

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

  • Em conformidade com o esquema UUIDv4

links

array["tipo_astra_link"]

Verdadeiro

Links que descrevem as operações suportadas no recurso.

nome

string

Verdadeiro

String JSON contendo um nome para a aplicação. 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.

  • Em conformidade com o esquema de rótulos DNS 1123

clusterScopedResources

array["clusterScopedResources"]

Falso

Matriz JSON de objetos JSON que descrevem os recursos com escopo de cluster que fazem parte deste app

namespaceScopedResources

array["namespaceScopedResources"]

Verdadeiro

Matriz JSON de objetos JSON que descrevem os recursos que fazem parte deste aplicativo

lastResourceCollectionTimestamp

string

Falso

String JSON contendo o registro de data e hora da última coleta de recursos. Este campo fica vazio se nenhuma coleta de recursos tiver sido realizada para esta aplicação ainda. Os valores definidos são:

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

estado

string

Verdadeiro

String JSON contendo um valor que indica o estado operacional da aplicação. Os valores definidos são:

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

  • "Descobrindo" - O aplicativo está em processo de descoberta

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

  • "ready" - O aplicativo está funcionando normalmente

  • "Falha" - O aplicativo está em estado de falha permanente

  • "Restaurando" - O aplicativo está sendo restaurado a partir de backup ou snapshot

  • "Indisponível" - O aplicativo não está acessível no momento

  • "Desconhecido" - Não é possível determinar o estado da aplicação

  • "Excluindo" - O aplicativo está em processo de exclusão

stateTransitions

array["type_astra_stateTransition"]

Falso

Matriz JSON de objetos JSON, cada um representando o conjunto de transições de estado permitidas a partir de um determinado estado definido. Cada objeto JSON contém os campos "from" e "to", onde o valor de "from" é o nome de um estado e o valor de "to" é uma matriz de estados de destino permitidos.

stateDetails

array["type_astra_stateDetail"]

Verdadeiro

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

  • Quantidade mínima de itens: 0

protectionState

string

Verdadeiro

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

  • "protected" - O aplicativo possui uma política de proteção definida e está em conformidade com essa política

  • "partial" - O aplicativo possui uma política de proteção definida, mas não está em conformidade com essa política

  • "nenhum" - O aplicativo não possui uma política de proteção definida

  • "atRisk" - A classe de armazenamento padrão no cluster não suporta snapshots, o aplicativo corre o risco de obter um volume não suportado

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

appDetectedType

string

Falso

String JSON que representa exclusivamente o tipo específico de aplicação detectada. Os valores definidos são:

  • "sistema" - O aplicativo contém um recurso que o identifica como parte do ambiente Kubernetes

  • "acc" - O aplicativo contém recursos que o identificam como uma instância do Astra Control Center

espaços de nomes

array[string]

Verdadeiro

Array JSON de strings JSON contendo os nomes dos namespaces nos quais o aplicativo está sendo executado. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 253

  • Em conformidade com o esquema de rótulos DNS 1123

namespaceMapping

array["namespaceMapping"]

Falso

Matriz JSON de objetos JSON, cada um mapeando um namespace de origem para um namespace de destino em uma operação de clonagem. Os valores definidos são:

  • Quantidade mínima de itens: 0

storageClassMapping

array["storageClassMapping"]

Falso

Matriz JSON de objetos JSON, cada um mapeando uma classe de armazenamento de origem para uma classe de armazenamento de destino para uma operação de restauração. Se nenhum elemento ou se não estiver presente, os nomes originais das classes de armazenamento de origem serão usados. Os valores definidos são:

  • Quantidade mínima de itens: 0

clusterName

string

Falso

String JSON contendo o nome do cluster no qual o aplicativo está sendo executado. Não é retornado se o aplicativo não estiver em execução.

ID do cluster

string

Falso

String JSON contendo o ID do cluster no qual o aplicativo está sendo executado. Não é retornado se o aplicativo não estiver em execução. Quando especificado na criação, clusterID indica em qual cluster o aplicativo deve ser clonado. Se o cluster especificado não existir ou se o cluster especificado não corresponder ao clusterID especificado no URI da solicitação, a clonagem falhará. Os valores definidos são:

  • Conforme o esquema de identificador Astra

clusterType

string

Falso

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

  • "gke" - Kubernetes hospedado no Google Kubernetes Engine (GKE)

  • "aks" - Kubernetes hospedado no Microsoft Azure Kubernetes Service (AKS)

  • "eks" - Kubernetes hospedado no Amazon Elastic Kubernetes Service (Amazon EKS)

  • "openshift" - O cluster é do tipo OpenShift

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

ID do aplicativo de origem

string

Falso

String JSON contendo o ID de um aplicativo de origem. Retornado somente se o aplicativo foi clonado de outro aplicativo ou restaurado a partir de um backup ou snapshot. Quando especificado na criação, o sourceAppID é usado em conjunto com o sourceClusterID e indica qual aplicativo em execução será clonado. Se o aplicativo especificado não existir no cluster de origem, a clonagem falhará. Apenas um de sourceAppID, backupID ou snapshotID pode ser especificado ao criar um aplicativo. Os valores definidos são:

  • Conforme o esquema de identificador Astra

sourceClusterName

string

Falso

String JSON contendo o nome do cluster no qual o aplicativo estava sendo executado anteriormente. Retornada somente se o aplicativo foi clonado de outro cluster.

ID do cluster de origem

string

Falso

String JSON contendo o ID do cluster no qual o aplicativo estava sendo executado anteriormente. Retornada somente se o aplicativo foi clonado de outro cluster. Quando especificado na criação, o sourceClusterID é usado em conjunto com o sourceAppID e indica o cluster de origem do aplicativo a ser clonado. Se o cluster de origem especificado não existir, a clonagem falhará. Os valores definidos são:

  • Conforme o esquema de identificador Astra

backupID

string

Falso

String JSON contendo o ID do backup a partir do qual o aplicativo foi restaurado. Retornado somente se o aplicativo foi restaurado a partir de um backup. Quando especificado na criação, backupID indica que um aplicativo será clonado a partir de um backup existente. Se o backup especificado não existir, a clonagem falhará. Apenas um de sourceAppID, backupID ou snapshotID pode ser especificado ao criar um aplicativo. Quando especificado em uma substituição, backupID indica o backup do aplicativo a partir do qual o aplicativo será restaurado no local. Se o backup especificado não existir, a restauração falhará. Apenas um de backupID ou snapshotID pode ser especificado ao atualizar um aplicativo. Os valores definidos são:

  • Conforme o esquema de identificador Astra

ID do Snapshot

string

Falso

String JSON contendo o ID do snapshot a partir do qual o aplicativo foi restaurado. Retornado somente se o aplicativo foi restaurado a partir de um snapshot. Quando especificado na criação, snapshotID indica que um aplicativo será clonado a partir de um snapshot existente. Se o snapshot especificado não existir, a clonagem falhará. Apenas um de sourceAppID, backupID ou snapshotID pode ser especificado ao criar um aplicativo. Quando especificado em uma substituição, snapshotID indica o snapshot do aplicativo a partir do qual o aplicativo será restaurado no local. Se o snapshot especificado não existir, a restauração falhará. Apenas um de backupID ou snapshotID pode ser especificado ao atualizar um aplicativo. Os valores definidos são:

  • Conforme o esquema de identificador Astra

ID do aplicativo de origem de replicação

string

Falso

String JSON contendo o ID do aplicativo que está sendo replicado para este aplicativo. Retornado somente se o aplicativo for atualmente o destino em um relacionamento AppMirror e o relacionamento não estiver no estado failedOver. Quando o relacionamento está no estado failedOver, este campo não é retornado. Os valores definidos são:

  • Conforme o esquema de identificador Astra

restoreFilter

"restoreFilter"

Falso

Objeto JSON contendo uma lista de filtros que descrevem quais recursos são incluídos ou excluídos de uma operação de restauração seletiva. Incluir e excluir são mutuamente exclusivos, e uma restauração seletiva só pode usar um tipo de filtro.

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