DescribeApplicationInstances - Serverless App Engine: Central de Documentação do Alibaba Cloud

Obtém uma lista de instâncias de aplicação.

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

sae:DescribeApplicationInstances

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /pop/v1/sam/app/describeApplicationInstances HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID da aplicação.	d700e680-aa4d-4ec1-afc2-6566b5ff****
GroupId	string	Sim	O ID do grupo de aplicações. Chame a operação DescribeApplicationGroups para obter o ID.	b2a8a925-477a-4ed7-b825-d5e22500****
CurrentPage	integer	Não	O número da página a ser retornada.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valor padrão: 10. O valor deve estar no intervalo (0, 1000000000).	10
Reverse	boolean	Não	Especifica a ordem de classificação das instâncias de aplicação. As instâncias são classificadas primeiro pelo status de execução e, em seguida, pelo ID da instância. Valores válidos: true: As instâncias são classificadas em ordem decrescente. false: As instâncias são classificadas em ordem crescente. Status das instâncias em ordem crescente: Error: Ocorreu um erro durante a inicialização da instância. CrashLoopBackOff: O contêiner falha ao iniciar e entra em um loop de reinicialização por falha. ErrImagePull: Ocorreu um erro ao fazer o pull da imagem do contêiner para a instância. ImagePullBackOff: O sistema está tentando repetidamente e falhando ao fazer o pull da imagem do contêiner. Pending: A instância está aguardando para ser agendada. Unknown: Ocorreu uma exceção desconhecida. Terminating: A instância está sendo encerrada. NotFound: A instância não pode ser encontrada. PodInitializing: A instância está sendo inicializada. Init:0/1: A instância está sendo inicializada. Running: A instância está em execução.	true
InstanceId	string	Não	O ID da instância de aplicação.	demo-faaca66c-5959-45cc-b3bf-d26093b2e9c0******
PipelineId	string	Não	O ID do lote. Chame a operação DescribeChangeOrder para obter o ID.	85750d48-6cfc-4dbf-8ea0-840397******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	A mensagem retornada para a solicitação.	success
TraceId	string	O ID de rastreamento usado para consultar os detalhes da solicitação.	0a98a02315955564772843261e****
Data	object	As informações sobre as instâncias de aplicação.
CurrentPage	integer	O número da página atual.	1
TotalSize	integer	O número total de instâncias.	10
PageSize	integer	O número de entradas retornadas por página.	10
Instances	array<object>	A lista de instâncias de aplicação.
	array<object>	Os detalhes de uma instância de aplicação.
CreateTimeStamp	integer	The time when instance creation began. Unit: milliseconds.	1558442609000
VSwitchId	string	The ID of the vSwitch where the instance is deployed.	vsw-***
InstanceContainerStatus	string	The status of the instance container. Valid values: Error: An error occurred during instance startup. CrashLoopBackOff: The container failed to start, encountered an error during startup, and then failed again after a restart. ErrImagePull: Failed to pull the instance's container image. ImagePullBackOff: The container image could not be pulled. Pending: The instance is waiting to be scheduled. Unknown: An unknown exception occurred. Terminating: The instance is being stopped. NotFound: The instance cannot be found. PodInitializing: The instance is being initialized. Init:0/1: The instance is being initialized. Running: The instance is running.	Running
InstanceHealthStatus	string	The health check status of the instance. Valid values: WithoutHealthCheckConfig: liveness and readiness health checks are not configured. WithoutLivenessConfig: The liveness health check is not configured. WithoutReadinessConfig: The readiness health check is not configured. NotCheckedYet: The instance is undergoing or waiting for a health check. LivenessUnhealthy: The liveness health check failed. The instance is unhealthy. ReadinessUnhealthy: The readiness health check failed. The instance is unhealthy. Unhealthy: Both the liveness and readiness health checks failed. The instance is unhealthy. Healthy: The health check passed. The instance is healthy.	WithoutHealthCheckConfig
InstanceContainerRestarts	integer	The number of times the instance's container has restarted.	0
GroupId	string	The ID of the group to which the instance belongs.	b2a8a925-477a-4ed7-b825-d5e22500****
InstanceContainerIp	string	The internal IP address of the instance.	192.168.X.X
InstanceId	string	The instance ID.	b2a8a925-477a-4ed7-b825-d5e22500****
ImageUrl	string	The URL of the container image. Nota If you deploy an application using a JAR or WAR package, the container image generated by SAE is not available for download.	registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0
PackageVersion	string	The version of the deployment package.	1609939496200
Timestamp	integer	The timestamp.	1750061980000
Eip	string	The elastic IP address (EIP).	8.129.XX.XXX
FinishTimeStamp	integer	The time when instance creation was completed. Unit: milliseconds.	1642757283000
DebugStatus	boolean	Whether the instance is being debugged. Valid values: true: The instance is being debugged. false: The instance is not being debugged.	False
SidecarContainersStatus	array<object>	The status of the sidecar containers.
	object	The status of a sidecar container.
ContainerId	string	The ID of the sidecar container.	sidecar-test-01
ContainerStatus	string	The status of the container.	Running
ImageUrl	string	The URL of the container image.	registry.cn-beijing.aliyuncs.com/sae-dev-test/******
MainContainerStatus	string	The status of the main container.	Running
UnhealthyMessage	string	The error message for a failed health check on the application instance. This field is empty if the check is successful.
TrafficStatus	string	The traffic status of the instance.
Tags	array<object>	The tags attached to the instance.
	object
Key	string	The tag key.
Value	string	The tag value.
ErrorCode	string	O código de erro. Valores válidos: Este parâmetro não é retornado para solicitações bem-sucedidas. Este parâmetro é retornado para solicitações com falha. Para obter mais informações, consulte a seção Códigos de erro neste tópico.
Code	string	O código de status HTTP ou código de erro POP. Valores válidos: 2xx: A solicitação foi bem-sucedida. 3xx: A solicitação foi redirecionada. 4xx: Ocorreu um erro de cliente. 5xx: Ocorreu um erro de servidor.	200
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 10,
    "PageSize": 10,
    "Instances": [
      {
        "CreateTimeStamp": 1558442609000,
        "VSwitchId": "vsw-***",
        "InstanceContainerStatus": "Running",
        "InstanceHealthStatus": "WithoutHealthCheckConfig",
        "InstanceContainerRestarts": 0,
        "GroupId": "b2a8a925-477a-4ed7-b825-d5e22500****",
        "InstanceContainerIp": "192.168.X.X",
        "InstanceId": "b2a8a925-477a-4ed7-b825-d5e22500****",
        "ImageUrl": "registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0",
        "PackageVersion": "1609939496200",
        "Timestamp": 1750061980000,
        "Eip": "8.129.XX.XXX",
        "FinishTimeStamp": 1642757283000,
        "DebugStatus": true,
        "SidecarContainersStatus": [
          {
            "ContainerId": "sidecar-test-01",
            "ContainerStatus": "Running",
            "ImageUrl": "registry.cn-beijing.aliyuncs.com/sae-dev-test/******"
          }
        ],
        "MainContainerStatus": "Running",
        "UnhealthyMessage": "",
        "TrafficStatus": "",
        "Tags": [
          {
            "Key": "",
            "Value": ""
          }
        ]
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

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.