ListListeners - Server Load Balancer: Central de Documentação do Alibaba Cloud

Consulta os listeners de Gateway Load Balancers.

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

gwlb:ListListeners

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ListenerIds	array	Não	Os IDs dos listeners. Você pode especificar até 20 IDs de listeners.
	string	Não	O ID do listener.	lsn-w3t3vpgjj12b2i****
LoadBalancerIds	array	Não	Os IDs das instâncias do Gateway Load Balancer (GWLB). Você pode especificar até 20 IDs de instâncias.
	string	Não	O ID da instância do Gateway Load Balancer (GWLB).	gwlb-rbtjolkkbudmrr****
NextToken	string	Não	O token usado para a próxima consulta. Valores válidos: Se NextToken estiver vazio, nenhuma consulta subsequente será realizada. Se um valor for retornado para NextToken, o valor será o token usado para a próxima consulta.	d209f4e63ec942c967c50c888a13****
MaxResults	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 1000. Valor padrão: 20.	20
Tag	array<object>	Não	As tags. Você pode especificar até 20 tags em cada chamada.
	object	Não	A tag.
Key	string	Não	A chave da tag. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. A chave da tag não pode conter `http://` ou `https://`.	tagKey
Value	string	Não	O valor da tag. O valor da tag pode ter até 256 caracteres e não pode conter `http://` ou `https://`.	tagValue
Skip	integer	Não	O número de entradas a serem ignoradas para uma consulta paginada.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
Listeners	array<object>	Uma lista de listeners da instância do Gateway Load Balancer (GWLB).
	array<object>	As informações sobre o listener.
ListenerDescription	string	A descrição do listener.	listener-description
ListenerId	string	O ID do listener.	lsn-vu7folhh5ntm8u****
ListenerStatus	string	O status do listener. Valores válidos: Provisioning: O listener está sendo criado. Running: O listener está em execução. Configuring: O listener está sendo configurado. Deleting: O listener está sendo excluído.	Running
LoadBalancerId	string	O ID da instância do Gateway Load Balancer (GWLB).	gwlb-uf6hbeh795xlqln7g****
ServerGroupId	string	O ID do grupo de servidores.	sgp-5yapcb422i51ru****
TcpIdleTimeout	integer	O período de tempo limite de uma conexão TCP ociosa.	350
Tags	array<object>	As tags.
	object	As tags.
Key	string	The tag key.	testKey
Value	string	The tag value.	testValue
MaxResults	integer	O número de entradas retornadas em cada página. Valores válidos: 1 a 1000. Valor padrão: 20.	20
NextToken	string	O token usado para a próxima consulta. Valores válidos: Se NextToken estiver vazio, nenhuma consulta subsequente será realizada. Se um valor for retornado para NextToken, o valor será o token usado para a próxima consulta.	5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****
RequestId	string	O ID da solicitação.	7DBFC67C-A272-5952-8287-6C3EBE4E04D9
TotalCount	integer	O número total de entradas.	8

Exemplos

Resposta de sucesso

JSON formato

{
  "Listeners": [
    {
      "ListenerDescription": "listener-description",
      "ListenerId": "lsn-vu7folhh5ntm8u****",
      "ListenerStatus": "Running",
      "LoadBalancerId": "gwlb-uf6hbeh795xlqln7g****",
      "ServerGroupId": "sgp-5yapcb422i51ru****",
      "TcpIdleTimeout": 350,
      "Tags": [
        {
          "Key": "testKey",
          "Value": "testValue"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****",
  "RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9",
  "TotalCount": 8
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParam.TagKey	The param of TagKey is missing.	The parameter of tag key is missing.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.