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

Consulta o status da verificação de integridade de um listener e suas regras de encaminhamento.

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

alb:GetListenerHealthStatus

get

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ListenerId	string	Sim	O ID do listener da instância.	lsn-o4u54y73wq7b******
IncludeRule	boolean	Não	Especifica se os resultados da verificação de integridade das regras de encaminhamento devem ser incluídos. Valores válidos: true: Inclui os resultados. false (padrão): Não inclui os resultados.	true
NextToken	string	Não	Especifica se há um token para a próxima consulta. Valores válidos: Para a primeira consulta ou quando não houver próxima consulta, deixe este parâmetro vazio. Se houver uma próxima consulta, defina este parâmetro com o valor NextToken retornado pela chamada de API anterior.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	Não	O número máximo de entradas a serem retornadas por página em uma consulta paginada. Valores válidos: 1 a 30. Valor padrão: 20.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Consulta o status de verificação de integridade de um listener e as regras de encaminhamento em suas configurações correspondentes.
ListenerHealthStatus	array<object>	A lista de status de verificação de integridade dos grupos de servidores associados ao listener.
	array<object>	A estrutura de status de verificação de integridade dos grupos de servidores associados ao listener.
ListenerId	string	O ID do listener da instância.	lsn-o4u54y73wq7b******
ListenerPort	integer	A porta do listener.	80
ListenerProtocol	string	O protocolo do listener.	http
ServerGroupInfos	array<object>	As informações do grupo de servidores.
	array<object>	As informações do grupo de servidores.
HealthCheckEnabled	string	O status da verificação de integridade. Valores válidos: on: A verificação de integridade está ativada.	on
NonNormalServers	array<object>	A lista de servidores de backend em estado anormal.
	array<object>	A lista de servidores de backend em estado anormal.
Port	integer	A porta do servidor de backend.	90
Reason	object	O motivo do estado anormal.
ActualResponse	string	O código de resposta real retornado pelo servidor de backend, como 302. Nota Este valor é retornado apenas quando ReasonCode é RESPONSE_MISMATCH.	302
ExpectedResponse	string	O código de resposta esperado do servidor de backend. Valores válidos: HTTP_2xx, HTTP_3xx, HTTP_4xx e HTTP_5xx. Vários códigos de resposta são separados por vírgulas (,). Nota Este valor é retornado apenas quando ReasonCode é RESPONSE_MISMATCH.	HTTP_2xx
ReasonCode	string	O motivo detalhado quando o Status é anormal. Atualmente, apenas listeners e regras de encaminhamento HTTP e HTTPS suportam a visualização dos motivos de status anormal: CONNECT_TIMEOUT: A verificação de integridade do Server Load Balancer (SLB) expirou ao estabelecer uma conexão com o servidor de backend. CONNECT_FAILED: A verificação de integridade do SLB falhou ao estabelecer uma conexão com o servidor de backend. RECV_RESPONSE_FAILED: A verificação de integridade do SLB falhou ao receber uma resposta do servidor de backend. RECV_RESPONSE_TIMEOUT: A verificação de integridade do SLB expirou ao receber uma resposta do servidor de backend. SEND_REQUEST_FAILED: A verificação de integridade do SLB falhou ao enviar uma solicitação para o servidor de backend. SEND_REQUEST_TIMEOUT: A verificação de integridade do SLB expirou ao enviar uma solicitação para o servidor de backend. RESPONSE_FORMAT_ERROR: A verificação de integridade do SLB recebeu uma resposta em um formato incorreto do servidor de backend. RESPONSE_MISMATCH: O código de resposta recebido do servidor de backend durante a verificação de integridade do SLB não correspondeu ao código de resposta esperado.	RESPONSE_MISMATCH
ServerId	string	O ID do servidor de backend.	i-uf62h8v******
ServerIp	string	O endereço IP do servidor de backend.	192.168.8.10
Status	string	O status da verificação de integridade. Valores válidos: Initial: Inicializando. A instância do SLB tem a verificação de integridade configurada, mas não há dados disponíveis. Unhealthy: Não íntegro. O servidor de backend relatou continuamente um estado não íntegro. Unused: Não está em uso. O peso do servidor de backend é 0, ou o balanceamento de carga entre zonas está desativado e o servidor de backend não está na mesma zona que a instância do Application Load Balancer (ALB). Unavailable: Não ativado. A verificação de integridade não está ativada.	Initial
ServerGroupId	string	O ID do grupo de servidores associado.	sgp-8ilqs4axp6******
ActionType	string	O tipo de uso do grupo de servidores. Valores válidos: ForwardGroup: Encaminhar para o grupo de servidores. TrafficMirror: Espelhar tráfego para o grupo de servidores.	TrafficMirror
ServerCount	integer	O número de servidores no grupo de servidores.	1
RequestId	string	O ID da solicitação.	CEF72CEB-54B6-4AE8-B225-F876F******
RuleHealthStatus	array<object>	A lista de status de integridade das regras de encaminhamento.
	array<object>	A estrutura de status de integridade de uma regra de encaminhamento.
RuleId	string	O ID da regra de encaminhamento.	rule-hp34s2h0xx1ht4nwo****
ServerGroupInfos	array<object>	A lista de grupos de servidores.
	array<object>	A estrutura do grupo de servidores.
HealthCheckEnabled	string	O status da verificação de integridade. Valores válidos: on: A verificação de integridade está ativada.	on
NonNormalServers	array<object>	A lista de servidores de backend em estado anormal.
	array<object>	A lista de servidores de backend em estado anormal.
Port	integer	A porta do servidor de backend.	90
Reason	object	O motivo do estado anormal.
ActualResponse	string	O código de resposta real retornado pelo servidor de backend, como 302. Nota Este valor é retornado apenas quando ReasonCode é RESPONSE_MISMATCH.	302
ExpectedResponse	string	O código de resposta esperado do servidor de backend. Valores válidos: HTTP_2xx, HTTP_3xx, HTTP_4xx e HTTP_5xx. Vários códigos de resposta são separados por vírgulas (,). Nota Este valor é retornado apenas quando ReasonCode é RESPONSE_MISMATCH.	HTTP_2xx
ReasonCode	string	O motivo detalhado quando o Status é anormal. Atualmente, apenas listeners e regras de encaminhamento HTTP e HTTPS suportam a visualização dos motivos de status anormal: CONNECT_TIMEOUT: A verificação de integridade do Server Load Balancer (SLB) expirou ao estabelecer uma conexão com o servidor de backend. CONNECT_FAILED: A verificação de integridade do SLB falhou ao estabelecer uma conexão com o servidor de backend. RECV_RESPONSE_FAILED: A verificação de integridade do SLB falhou ao receber uma resposta do servidor de backend. RECV_RESPONSE_TIMEOUT: A verificação de integridade do SLB expirou ao receber uma resposta do servidor de backend. SEND_REQUEST_FAILED: A verificação de integridade do SLB falhou ao enviar uma solicitação para o servidor de backend. SEND_REQUEST_TIMEOUT: A verificação de integridade do SLB expirou ao enviar uma solicitação para o servidor de backend. RESPONSE_FORMAT_ERROR: A verificação de integridade do SLB recebeu uma resposta em um formato incorreto do servidor de backend. RESPONSE_MISMATCH: O código de resposta recebido do servidor de backend durante a verificação de integridade do SLB não correspondeu ao código de resposta esperado.	RESPONSE_MISMATCH
ServerId	string	O ID do servidor de backend.	i-uf62h8v******
ServerIp	string	O endereço IP do grupo de servidores de backend.	192.168.2.11
Status	string	O status da verificação de integridade. Valores válidos: Initial: Inicializando. A instância do SLB tem a verificação de integridade configurada, mas não há dados disponíveis. Unhealthy: Não íntegro. O servidor de backend relatou continuamente um estado não íntegro. Unused: Não está em uso. O peso do servidor de backend é 0, ou o balanceamento de carga entre zonas está desativado e o servidor de backend não está na mesma zona que a instância do ALB. Unavailable: Não ativado. A verificação de integridade não está ativada.	Initial
ServerGroupId	string	O ID do grupo de servidores associado.	sgp-8ilqs4axp6******
ActionType	string	O tipo de uso do grupo de servidores.	TrafficMirror
ServerCount	integer	O número de servidores no grupo de servidores.	1
NextToken	string	Indica se existe um token de próxima consulta. Valores válidos: Se NextToken estiver vazio, não existe próxima consulta. Se NextToken for retornado, o valor indica o token para a próxima consulta.	FFmyTO70tTpLG6I3FmYAXGKPd****

Exemplos

Resposta de sucesso

JSON formato

{
  "ListenerHealthStatus": [
    {
      "ListenerId": "lsn-o4u54y73wq7b******",
      "ListenerPort": 80,
      "ListenerProtocol": "http",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": "on",
          "NonNormalServers": [
            {
              "Port": 90,
              "Reason": {
                "ActualResponse": "302",
                "ExpectedResponse": "HTTP_2xx",
                "ReasonCode": "RESPONSE_MISMATCH"
              },
              "ServerId": "i-uf62h8v******",
              "ServerIp": "192.168.8.10",
              "Status": "Initial"
            }
          ],
          "ServerGroupId": "sgp-8ilqs4axp6******",
          "ActionType": "TrafficMirror",
          "ServerCount": 1
        }
      ]
    }
  ],
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876F******",
  "RuleHealthStatus": [
    {
      "RuleId": "rule-hp34s2h0xx1ht4nwo****",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": "on",
          "NonNormalServers": [
            {
              "Port": 90,
              "Reason": {
                "ActualResponse": "302",
                "ExpectedResponse": "HTTP_2xx",
                "ReasonCode": "RESPONSE_MISMATCH"
              },
              "ServerId": "i-uf62h8v******",
              "ServerIp": "192.168.2.11",
              "Status": "Initial"
            }
          ],
          "ServerGroupId": "sgp-8ilqs4axp6******",
          "ActionType": "TrafficMirror",
          "ServerCount": 1
        }
      ]
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	Forbidden.LoadBalancer	Authentication is failed for %s.	Falha na autenticação da operação de balanceamento de carga.
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.	O recurso %s não existe.
404	ResourceNotFound.Listener	The specified resource %s is not found.	O listener não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.