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

Consulta a configuração do NLB da 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:DescribeApplicationNlbs

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Não	O ID da aplicação.	7171a6ca-d1cd-4928-8642-7d5cfe69****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
RequestId	string	O ID da solicitação.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	A mensagem retornada. O valor success indica uma solicitação bem-sucedida; caso contrário, um código de erro é retornado.	success
TraceId	string	O ID de rastreamento usado para consultar os detalhes da solicitação.	ac1a0b2215622246421415014e****
ErrorCode	string	O código de erro. Este parâmetro é retornado apenas se a solicitação falhar. Para mais informações, consulte a seção Códigos de erro deste tópico.
Code	string	O código de status HTTP. 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	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Data	object	Os dados retornados na resposta.
Instances	object	Uma coleção de detalhes das instâncias.
	object	Os detalhes de uma instância.
DnsName	string	The DNS name.	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
Listeners	object	A collection of listener details.
	object	The details of a listener.
Protocol	string	The listener protocol.	TCPSSL
Port	integer	The listener port.	80
Status	string	The state of the NLB listener. Valid values: Creating: The listener is being created. Configuring: The listener is being configured. Bounded: The listener is running as expected. Unbinding: The listener is being deleted. Failed: The listener is unavailable.	Bounded
TargetPort	integer	The target port.	8080
CertIds	string	The server certificate ID.	123157******
CreatedBySae	boolean	Indicates whether SAE created the instance. Valid values: true: SAE created the instance. false: SAE reused an existing instance.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "ErrorCode": "",
  "Code": "200",
  "Success": "true",
  "Data": {
    "Instances": {
      "key": {
        "DnsName": "nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com",
        "Listeners": {
          "key": {
            "Protocol": "TCPSSL",
            "Port": 80,
            "Status": "Bounded",
            "TargetPort": 8080,
            "CertIds": "123157******"
          }
        },
        "CreatedBySae": true
      }
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidApplication.NotFound	The current application does not exist.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.