GetHealthStatus - Global Accelerator - Centro de documentación de Alibaba Cloud

Consulta el estado de salud de los endpoints y grupos de endpoints de un listener.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ga:GetHealthStatus

get

*Listener

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región donde se despliega la instancia de Global Accelerator (GA). Establezca el valor en cn-hangzhou.	cn-hangzhou
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el token, pero debe asegurarse de que el token sea único entre diferentes solicitudes. El token solo puede contener caracteres ASCII y no puede superar los 64 caracteres de longitud. Nota Si no especifica este parámetro, el sistema utiliza automáticamente el ID de solicitud como token de cliente. El ID de solicitud puede ser diferente para cada solicitud.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Especifica si solo se debe realizar una comprobación previa de la solicitud. Valores válidos: true: realiza solo la comprobación previa de la solicitud. No se consulta el estado de salud del listener. El sistema comprueba previamente los parámetros requeridos, la sintaxis de la solicitud y los límites. Si la solicitud no supera la comprobación previa, se devuelve un mensaje de error. Si la solicitud supera la comprobación previa, se devuelve el código de error `DryRunOperation`. false (valor predeterminado): envía una solicitud normal. Si la solicitud supera la comprobación previa, se devuelve un código de estado HTTP 2xx y se obtiene el estado de salud del listener.	true
AcceleratorId	string	Sí	El ID de la instancia de GA que desea consultar.	ga-bp1odcab8tmno0hdq****
ListenerId	string	Sí	El ID del listener.	lsr-bp1bpn0kn908w4nbw****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
ListenerId	string	El ID del listener.	lsr-bp1bpn0kn908w4nbw****
HealthStatus	string	El estado de salud de los endpoints y grupos de endpoints. Valores válidos: normal abnormal partiallyAbnormal	normal
EndpointGroups	array<object>	La información sobre los grupos de endpoints.
	array<object>	La información sobre el grupo de endpoints.
EndpointGroupId	string	El ID del grupo de endpoints.	epg-bp14sz7ftcwwjgrdm****
EndpointGroupType	string	El tipo de grupo de endpoints. Valores válidos: default: el grupo de endpoints predeterminado. virtual: un grupo de endpoints virtual.	default
HealthStatus	string	El estado de salud del grupo de endpoints. Valores válidos: init: El grupo de endpoints se está inicializando. normal: El grupo de endpoints es normal. abnormal: El grupo de endpoints es anómalo. partiallyAbnormal: El grupo de endpoints es parcialmente anómalo.	normal
ForwardingRuleIds	array	Los ID de las reglas de reenvío.
	string	El ID de la regla de reenvío.	frule-bp134k63nmtwmnwee****
Endpoints	array<object>	La información sobre los endpoints.
	object	La información sobre los endpoints.
EndpointId	string	El ID del endpoint.	ep-hp33b2e43fays7s8****
Address	string	La dirección IP del endpoint.	47.0.XX.XX
HealthStatus	string	El estado de salud del endpoint. Valores válidos: init: El endpoint se está inicializando. normal: El endpoint es normal. abnormal: El endpoint es anómalo.	normal
HealthDetail	string	Los detalles de la comprobación de salud del endpoint. Nota Este parámetro no está disponible.	null
Port	integer	El puerto que se utiliza para conectarse al endpoint.	80
Type	string	El tipo de endpoint. Valores válidos: Domain: un nombre de dominio personalizado. Ip: una dirección IP personalizada. PublicIp: una dirección IP pública proporcionada por Alibaba Cloud. ECS: una instancia de Elastic Compute Service (ECS). SLB: una instancia de Classic Load Balancer (CLB). ALB: una instancia de Application Load Balancer (ALB). OSS: un bucket de Object Storage Service (OSS). ENI: una interfaz de red elástica (ENI). NLB: una instancia de Network Load Balancer (NLB).	Ip

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.