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

Obtém uma lista de aplicações.

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.

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

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

POST /pop/v5/app/app_list HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClusterId	string	Não	Filtra aplicações por cluster.	c37aec2a-bcca-4ec1-**-**********
LogicalRegionId	string	Não	Filtra aplicações por namespace de microsserviços.	cn-beijing:test
AppName	string	Não	Filtra aplicações por nome da aplicação.	testapp
ResourceGroupId	string	Não	Filtra aplicações por grupo de recursos.	rg-aek24j4s4b*****
LogicalRegionIdFilter	string	Não	Filtra aplicações por correspondência exata do namespace de microsserviços.	cn-beijing:test
AppIds	string	Não	A lista de IDs das aplicações.	[ "5657d271-**-4f03-9bb2-431f942886bb", "5657d271-**-4f03-9bb2-431f942bbddd" ]
CurrentPage	integer	Não	O número da página atual para a consulta paginada. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas por página na consulta paginada.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta da API.
Code	integer	O código de status.	200
Message	string	As informações adicionais.	success
RequestId	string	O ID da solicitação.	5d6fa0bc-cc3**********
ApplicationList	object
Application	array<object>	A lista de aplicações.
	object	Os detalhes da aplicação.
AppId	string	O ID da aplicação.	00ee517d-dd7d-4d4e-**-**********
RegionId	string	O ID da região.	cn-beijing:docTes
Name	string	O nome da aplicação.	doc-test-consumer
Instances	integer	O número de instâncias da aplicação.	5
Port	integer	A porta de serviço da aplicação.	8080
State	string	O estado da aplicação. Valores válidos: RUNNING: A aplicação está em execução. STOPPED: A aplicação está parada. DEPLOYING: A aplicação está sendo implantada. DELETING: A aplicação está sendo excluída.	RUNNING
CreateTime	integer	O timestamp de quando a aplicação foi criada.	1664208000000
SlbIp	string	O endereço IP privado da instância SLB.	192.168.0.***
SlbPort	integer	A porta privada da instância SLB.	80
SlbListenerPort	integer	A porta de listener privada da instância SLB.	8088
ExtSlbListenerPort	integer	A porta de listener da instância SLB voltada para a Internet.	8080
BuildPackageId	integer	O ID da versão do contêiner.	58
ExtSlbIp	string	O endereço IP da instância SLB voltada para a Internet.	100.100.70.***
ApplicationType	string	O tipo de implantação da aplicação. Valores válidos: War: Implantação de pacote WAR. FatJar: Implantação de pacote JAR. Image: Implantação de imagem. Empty: Não implantada.	FatJar
ClusterType	integer	O tipo de ambiente de cluster da aplicação. Valores válidos: 2: Cluster ECS. 3: Cluster Kubernetes integrado do EDAS. 5: Cluster Kubernetes do serviço de contêiner.	2
RunningInstanceCount	integer	O número de instâncias da aplicação em execução.	0
ClusterId	string	O ID do cluster.	c37aec2a-bcca-4ec1-**-**********
ResourceGroupId	string	O ID do grupo de recursos.	rg-aek24j4s4b*****
K8sNamespace	string	O namespace do Kubernetes.	default
NamespaceId	string	O ID do namespace de microsserviços.	cn-hangzhou:test

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 200,
  "Message": "success",
  "RequestId": "5d6fa0bc-cc3**********",
  "ApplicationList": {
    "Application": [
      {
        "AppId": "00ee517d-dd7d-4d4e-****-************",
        "RegionId": "cn-beijing:docTes",
        "Name": "doc-test-consumer",
        "Instances": 5,
        "Port": 8080,
        "State": "RUNNING",
        "CreateTime": 1664208000000,
        "SlbIp": "192.168.0.***",
        "SlbPort": 80,
        "SlbListenerPort": 8088,
        "ExtSlbListenerPort": 8080,
        "BuildPackageId": 58,
        "ExtSlbIp": "100.100.70.***",
        "ApplicationType": "FatJar",
        "ClusterType": 2,
        "RunningInstanceCount": 0,
        "ClusterId": "c37aec2a-bcca-4ec1-****-************",
        "ResourceGroupId": "rg-aek24j4s4b*****",
        "K8sNamespace": "default",
        "NamespaceId": "cn-hangzhou:test"
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.