DescribeAppInstanceList - Enterprise Distributed Application Service: Central de Documentação do Alibaba Cloud

Consulta as instâncias de aplicativo do Kubernetes.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

edas:ReadApplication

get

*Application

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}

Nenhuma

Sintaxe da solicitação

GET /pop/v5/oam/app_instance_list HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID do aplicativo. Você pode chamar a operação ListApplication para consultar o ID do aplicativo. Para obter mais informações, consulte ListApplication.	93fdd228-*****-ed2ae98de18d
WithNodeInfo	boolean	Não	Especifica se devem ser retornadas as informações sobre o nó no qual o pod reside. `true`: retorna as informações sobre o nó no qual o pod reside. `false`: não retorna as informações sobre o nó no qual o pod reside.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	integer	O código de status HTTP retornado.	200
Message	string	A mensagem retornada.	success
RequestId	string	O ID da solicitação.	03FD1520-0FD6-436A-**-265318D7**
InstanceList	array<object>	As instâncias do aplicativo.
	object
NodeLabels	string	Os rótulos do nó. O valor é uma string JSON.	{"alibabacloud.com/nodepool-id":"np05b9377fa907","beta.kubernetes.io/arch":"amd64","beta.kubernetes.io/instance-type":"ecs.","beta.kubernetes.io/os":"linux","failure-domain.beta.kubernetes.io/region":"cn-hangzhou","failure-domain.beta.kubernetes.io/zone":"cn-hangzhou-b","kubernetes.io/arch":"amd64","kubernetes.io/hostname":"cn-hangzhou","kubernetes.io/os":"linux","node.kubernetes.io/instance-type":"ecs.","topology.diskplugin.csi.alibabacloud.com/zone":"cn-hangzhou-b","topology.kubernetes.io/region":"cn-hangzhou","topology.kubernetes.io/zone":"cn-hangzhou-b"}
GroupId	string	O ID do grupo de instâncias no qual o aplicativo é implantado.	93fdd228-*****-ed2ae98de18d
GroupName	string	O nome do grupo de instâncias no qual o aplicativo é implantado.	_DEFAULT_GROUP
Canary	boolean	Indica se o aplicativo foi lançado no modo de liberação canary. `true`: O aplicativo foi lançado no modo de liberação canary. `false`: O aplicativo não foi lançado no modo de liberação canary.	false
NodeName	string	O nome do nó.	cn-hangzhou.192.168.0.*
PodRaw	string	As informações sobre o pod. O valor é uma string JSON.	{"metadata":{"name":"oambuild-group-1-4xthz","generateName":"oambuild-group-96-","namespace":"default","selfLink":"/api/v1/namespaces/default/pods/oambuild-grou96-4xthz","uid":"7a23399c-fe7ff4018","resourceVersion":"969614830","creationTimestamp":"2021-04-06T11:38:46Z","labels":{"ARMSApmAppId":"","ARMSApmLicenseKey":""...
Version	string	A versão do pacote de implantação do nó.	2021-04-06 19:37:42
AppId	string	O ID do aplicativo.	93fdd228-*****-ed2ae98de18d

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 200,
  "Message": "success",
  "RequestId": "03FD1520-0FD6-436A-****-265318D7****",
  "InstanceList": [
    {
      "NodeLabels": "{\"alibabacloud.com/nodepool-id\":\"np0*5b9377fa907\",\"beta.kubernetes.io/arch\":\"amd64\",\"beta.kubernetes.io/instance-type\":\"ecs.*\",\"beta.kubernetes.io/os\":\"linux\",\"failure-domain.beta.kubernetes.io/region\":\"cn-hangzhou\",\"failure-domain.beta.kubernetes.io/zone\":\"cn-hangzhou-b\",\"kubernetes.io/arch\":\"amd64\",\"kubernetes.io/hostname\":\"cn-hangzhou*\",\"kubernetes.io/os\":\"linux\",\"node.kubernetes.io/instance-type\":\"ecs.*\",\"topology.diskplugin.csi.alibabacloud.com/zone\":\"cn-hangzhou-b\",\"topology.kubernetes.io/region\":\"cn-hangzhou\",\"topology.kubernetes.io/zone\":\"cn-hangzhou-b\"}",
      "GroupId": "93fdd228-*****-ed2ae98de18d",
      "GroupName": "_DEFAULT_GROUP",
      "Canary": false,
      "NodeName": "cn-hangzhou.192.168.0.*",
      "PodRaw": "{\"metadata\":{\"name\":\"oambuild-group-1-*4xthz\",\"generateName\":\"oambuild-group-*96-\",\"namespace\":\"default\",\"selfLink\":\"/api/v1/namespaces/default/pods/oambuild-grou*96-4xthz\",\"uid\":\"7a23399c-*fe7ff4018\",\"resourceVersion\":\"969614830\",\"creationTimestamp\":\"2021-04-06T11:38:46Z\",\"labels\":{\"ARMSApmAppId\":\"*\",\"ARMSApmLicenseKey\":\"*\"...",
      "Version": "2021-04-06 19:37:42",
      "AppId": "93fdd228-*****-ed2ae98de18d"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Edas.errorcode.PermissionDenied.message	No permissions
400	Edas.errorcode.ParameterMissing.AppId.message	Application ID is missing.

Consulte Códigos de ErroCódigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de VersãoNotas de Versão para uma lista completa.