ListApplications - Serverless App Engine: 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

sae:ListApplications

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
CurrentPage	integer	Não	O número da página atual.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valores válidos: [0,10000].	20
AppName	string	Não	O nome da aplicação.	demo-app
NamespaceId	string	Não	O ID do namespace.	cn-beijing:demo
Tags	string	Não	Os pares chave-valor das tags. Valores válidos: key: a chave da tag. O comprimento deve estar no intervalo de [1,128]. value: o valor da tag. O comprimento deve estar no intervalo de [1,128]. As tags diferenciam maiúsculas de minúsculas. Se você especificar várias tags, todas as tags especificadas serão criadas e anexadas ao recurso. Cada chave de tag no mesmo recurso pode ter apenas um valor de tag. Se você adicionar uma chave de tag que já existe, o valor da tag correspondente será atualizado para o novo valor. As tags não podem começar com `aliyun` ou `acs:` e não podem conter `http://` ou `https://`.	[{"key":"key","value":"value"}]
OrderBy	string	Não	O campo pelo qual ordenar as aplicações. Valores válidos: runnings: ordena pelo número atual de instâncias alvo. instances: ordena pelo número alvo de instâncias alvo.	runnings
Reverse	boolean	Não	Especifica se as instâncias da aplicação devem ser ordenadas por status de execução. Se as instâncias tiverem o mesmo status, elas serão ordenadas por ID da instância. Valores válidos: true: ordena em ordem crescente. As instâncias são organizadas com base na sequência de inicialização. Por exemplo, para atingir o estado de execução, uma instância deve passar por etapas como iniciar o contêiner, baixar a imagem e inicializar a instância. false: ordena em ordem decrescente. A ordem crescente das instâncias é a seguinte: Error: ocorreu um erro durante a inicialização da instância. CrashLoopBackOff: o contêiner falhou ao iniciar, encontrou um erro durante a inicialização e encontrou um erro novamente após a reinicialização. ErrImagePull: ocorreu um erro ao baixar a imagem do contêiner para a instância. ImagePullBackOff: a imagem do contêiner não pode ser obtida. Pending: a instância está aguardando agendamento. Unknown: ocorreu uma exceção desconhecida. Terminating: a instância está sendo encerrada. NotFound: a instância não foi encontrada. PodInitializing: a instância está sendo inicializada. Init:0/1: a instância está inicializando. Running: a instância está em execução.	true
FieldType	string	Não	A dimensão pela qual filtrar as aplicações. Valores válidos: appName: nome da aplicação. appIds: ID da aplicação. slbIps: endereço IP do SLB. instanceIps: endereço IP da instância.	appName
FieldValue	string	Não	O nome da aplicação, o ID da aplicação, o endereço IP do SLB ou o endereço IP da instância da aplicação alvo.	demo-app
AppSource	string	Não	O tipo de aplicação do Serverless App Engine (SAE). micro_service. web. job.	micro_service
IsStateful	string	Não	Especifica se a aplicação é stateful.
NewSaeVersion	string	Não	A versão da aplicação. Valores válidos: lite: Edição Lite std: Edição Standard pro: Edição Professional

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
Message	string	As informações adicionais sobre o resultado da chamada.	success
RequestId	string	O ID da solicitação.	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	A lista de aplicações.
CurrentPage	integer	O número da página atual.	1
TotalSize	integer	O número total de aplicações.	2
PageSize	integer	O tamanho da página.	20
Applications	array<object>	A lista de aplicações.
	array<object>	As informações da lista de aplicações.
AppName	string	O nome da aplicação.	demo-app
NamespaceId	string	O ID do namespace.	cn-beijing:demo
AppDeletingStatus	boolean	Indica se a aplicação está sendo excluída. Valores válidos: true: A aplicação está sendo excluída. false: A aplicação não está sendo excluída.	false
AppId	string	O ID da aplicação.	f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tags	array<object>	Uma matriz de tags atribuídas à aplicação.
	object	Os detalhes de uma tag.
Key	string	A chave da tag.	key
Value	string	O valor da tag.	value
RunningInstances	integer	O número de instâncias em execução.	2
Instances	integer	O número configurado de instâncias da aplicação.	2
RegionId	string	O ID da região onde a aplicação está implantada.	cn-beijing
AppDescription	string	A descrição da aplicação.	description
Cpu	integer	A CPU alocada para cada instância, medida em milicores. Este valor não pode ser 0. Valores válidos: 500 1000 2000 4000 8000 16000 32000	1000
Mem	integer	A memória alocada para cada instância, medida em megabytes (MB). Este valor não pode ser 0 e deve ser compatível com a alocação de CPU. As seguintes opções estão disponíveis: 1024: Para uma alocação de CPU de 500 ou 1.000 milicores. 2048: Para uma alocação de CPU de 500, 1.000 ou 2.000 milicores. 4096: Para uma alocação de CPU de 1.000, 2.000 ou 4.000 milicores. 8192: Para uma alocação de CPU de 2.000, 4.000 ou 8.000 milicores. 12288: Para uma alocação de CPU de 12.000 milicores. 16384: Para uma alocação de CPU de 4.000, 8.000 ou 16.000 milicores. 24576: Para uma alocação de CPU de 12.000 milicores. 32768: Para uma alocação de CPU de 16.000 milicores. 65536: Para uma alocação de CPU de 8.000, 16.000 ou 32.000 milicores. 131072: Para uma alocação de CPU de 32.000 milicores.	1024
MseEnabled	boolean	Indica se o Microservices Engine (MSE) está ativado para a aplicação.	true
MseNamespaceId	string	O ID do namespace do MSE. Este valor determina a edição do serviço. default: Edição gratuita sae-pro: Edição profissional sae-ent: Edição empresarial	sae-ent
BaseAppId	string	O ID da aplicação base. Este parâmetro é retornado apenas para aplicações de liberação canário.	xxx-xxx-xx-xxx
ProgrammingLanguage	string	A linguagem de programação da aplicação.	java
Children	array<object>	Uma matriz de aplicações de liberação canário associadas a esta aplicação.
	array<object>	Os detalhes de uma aplicação de liberação canário.
AppName	string	O nome da aplicação de liberação canário.	app1
NamespaceId	string	O ID do namespace.	cn-beijing:demo
AppDeletingStatus	boolean	Indica se a aplicação de liberação canário está sendo excluída.	false
AppId	string	O ID da aplicação de liberação canário.	xxx-xxx-xxx-xxx
ScaleRuleEnabled	boolean	Indica se uma política de dimensionamento automático está ativada.	false
ScaleRuleType	string	O tipo da política de dimensionamento automático.	timing
Tags	array<object>	Uma matriz de tags atribuídas à aplicação de liberação canário.
	object	Os detalhes de um objeto de tag.
Key	string	A chave da tag.	key
Value	string	O valor da tag.	value
RunningInstances	integer	O número de instâncias em execução.	2
Instances	integer	O número configurado de instâncias para a aplicação de liberação canário.	2
RegionId	string	O ID da região.	cn-beijing
AppDescription	string	A descrição da aplicação.	Test application
Cpu	integer	A especificação da CPU.	2000
Mem	integer	A especificação da memória.	2048
MseEnabled	boolean	Indica se o Microservices Engine (MSE) está ativado para a aplicação.	true
BaseAppId	string	O ID da aplicação base.	ee99cce6-1c8e-4bfa-96c3-3e2fa9******
ProgrammingLanguage	string	A linguagem de programação da aplicação.	java
AppType	string	O método de implantação da aplicação.	Image
NamespaceName	string	O nome do namespace.	demo
IsStateful	boolean	Indica se a aplicação de liberação canário é stateful.
NewSaeVersion	string	A edição da aplicação: lite: Lite std: Standard pro: Pro	pro
ResourceType	string	O tipo de recurso.
EnableIdle	string	Indica se a aplicação está configurada para parar automaticamente quando ociosa.
ImageUrl	string	A URL da imagem do contêiner.	registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
PackageUrl	string	A URL do pacote de implantação da aplicação.	https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar
AppType	string	O método de implantação da aplicação.	Image
NamespaceName	string	O nome do namespace.	demo
IsStateful	boolean	Indica se a aplicação é stateful.
NewSaeVersion	string	A edição da aplicação: lite: Lite std: Standard pro: Pro	pro
EnableIdle	string	Indica se a aplicação está configurada para parar automaticamente quando ociosa.	false
DiskSize	integer	O tamanho do disco em GB.	20
VpcId	string	O ID da VPC.
ResourceType	string	O tipo de recurso.
Labels	object	Os rótulos da aplicação.
	string
RaspEnabled	boolean
ErrorCode	string	O código de erro. Valores válidos: Se a solicitação for bem-sucedida, o campo ErrorCode não será retornado. Se a solicitação falhar, o campo ErrorCode será retornado. Para mais informações, consulte a seção Códigos de erro neste tópico.
Code	string	O status da API ou o código de erro POP. Valores válidos: 2xx: Sucesso. 3xx: Redirecionamento. 4xx: Erro de solicitação. 5xx: Erro de servidor.	200
Success	boolean	Indica se a lista de aplicações foi obtida. Valores válidos: true: Obtida. false: Não obtida.	true
CurrentPage	integer	O número da página atual.	1
TotalSize	integer	O número total de aplicações.	2
PageSize	integer	O tamanho da página.	20

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "success",
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 2,
    "PageSize": 20,
    "Applications": [
      {
        "AppName": "demo-app",
        "NamespaceId": "cn-beijing:demo",
        "AppDeletingStatus": false,
        "AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "RunningInstances": 2,
        "Instances": 2,
        "RegionId": "cn-beijing",
        "AppDescription": "description",
        "Cpu": 1000,
        "Mem": 1024,
        "MseEnabled": true,
        "MseNamespaceId": "sae-ent",
        "BaseAppId": "xxx-xxx-xx-xxx",
        "ProgrammingLanguage": "java",
        "Children": [
          {
            "AppName": "app1",
            "NamespaceId": "cn-beijing:demo",
            "AppDeletingStatus": false,
            "AppId": "xxx-xxx-xxx-xxx",
            "ScaleRuleEnabled": false,
            "ScaleRuleType": "timing",
            "Tags": [
              {
                "Key": "key",
                "Value": "value"
              }
            ],
            "RunningInstances": 2,
            "Instances": 2,
            "RegionId": "cn-beijing",
            "AppDescription": "Test application",
            "Cpu": 2000,
            "Mem": 2048,
            "MseEnabled": true,
            "BaseAppId": " ee99cce6-1c8e-4bfa-96c3-3e2fa9******",
            "ProgrammingLanguage": "java",
            "AppType": "Image",
            "NamespaceName": "demo",
            "IsStateful": false,
            "NewSaeVersion": "pro",
            "ResourceType": "",
            "EnableIdle": ""
          }
        ],
        "ImageUrl": "registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0",
        "PackageUrl": "https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar",
        "AppType": "Image",
        "NamespaceName": "demo",
        "IsStateful": false,
        "NewSaeVersion": "pro",
        "EnableIdle": "false",
        "DiskSize": 20,
        "VpcId": "",
        "ResourceType": "",
        "Labels": {
          "key": ""
        },
        "RaspEnabled": false
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Illegal.argument	Illegal argument

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.