GetHealthStatus - Global Accelerator: Central de Documentação do Alibaba Cloud

Obtém as informações de status de integridade dos grupos de endpoints e endpoints sob um listener especificado.

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

ga:GetHealthStatus

get

*Listener.

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância do Alibaba Cloud Global Accelerator (GA). Defina o valor como cn-hangzhou.	cn-hangzhou
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o valor, mas deve garantir que ele seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação de API como o ClientToken. O RequestId de cada solicitação de API é exclusivo.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: envia uma solicitação de dry run e não obtém o status de integridade do listener. O sistema verifica se os parâmetros obrigatórios foram especificados, o formato da solicitação e os limites do serviço. Se a solicitação falhar na verificação, um erro será retornado. Se a solicitação passar na verificação, o código de erro `DryRunOperation` será retornado. false (padrão): envia uma solicitação normal. Se a solicitação passar na verificação, um código de status HTTP 2xx será retornado e o status de integridade do listener será obtido.	true
AcceleratorId	string	Sim	O ID da instância do Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
ListenerId	string	Sim	O ID da instância do listener.	lsr-bp1bpn0kn908w4nbw****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A lista de informações retornadas.
EndpointGroups	array<object>	As informações do grupo de endpoints.
	array<object>	As informações do grupo de endpoints.
EndpointGroupId	string	O ID do grupo de endpoints.	epg-bp14sz7ftcwwjgrdm****
EndpointGroupType	string	O tipo do grupo de endpoints. Valores válidos: default: grupo de endpoints padrão. virtual: grupo de endpoints virtual.	default
Endpoints	array<object>	As informações do endpoint.
	object	As informações do endpoint.
Address	string	O endereço do endpoint.	47.0.XX.XX
EndpointId	string	O ID do endpoint.	ep-hp33b2e43fays7s8****
HealthDetail	string	Os detalhes da verificação de integridade do endpoint. Nota Este parâmetro não é suportado.	None
HealthStatus	string	O status de integridade do endpoint. Valores válidos: init: inicialização. normal: normal. abnormal: anormal.	normal
Port	integer	A porta do endpoint.	80
Type	string	O tipo de endpoint. Valores válidos: Domain: nome de domínio personalizado. Ip: endereço IP personalizado. PublicIp: endereço IP público do Alibaba Cloud. ECS: instância do Alibaba Cloud ECS. SLB: instância do Classic Load Balancer (CLB). ALB: instância do Application Load Balancer (ALB). OSS: instância do Object Storage Service (OSS). ENI: interface de rede elástica (ENI) do Alibaba Cloud. NLB: instância do Network Load Balancer (NLB).	Ip
ForwardingRuleIds	array	A lista de IDs de regras de encaminhamento.
	string	A lista de IDs de regras de encaminhamento.	frule-bp134k63nmtwmnwee****
HealthStatus	string	O status de integridade do grupo de endpoints. Valores válidos: init: inicialização. normal: normal. abnormal: anormal. partiallyAbnormal: parcialmente anormal.	normal
HealthStatus	string	O status de integridade dos grupos de endpoints e endpoints sob o listener. Valores válidos: normal: normal. abnormal: anormal. partiallyAbnormal: parcialmente anormal.	normal
ListenerId	string	O ID da instância do listener.	lsr-bp1bpn0kn908w4nbw****
RequestId	string	O ID da solicitação.	64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF

Exemplos

Resposta de sucesso

JSON formato

{
  "EndpointGroups": [
    {
      "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
      "EndpointGroupType": "default",
      "Endpoints": [
        {
          "Address": "47.0.XX.XX",
          "EndpointId": "ep-hp33b2e43fays7s8****",
          "HealthDetail": "无",
          "HealthStatus": "normal",
          "Port": 80,
          "Type": "Ip"
        }
      ],
      "ForwardingRuleIds": [
        "frule-bp134k63nmtwmnwee****"
      ],
      "HealthStatus": "normal"
    }
  ],
  "HealthStatus": "normal",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "RequestId": "64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF"
}

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.