Query health status of listeners, endpoint groups, and endpoints using GetHealthStatus - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries the health status of the endpoints and endpoint groups of a listener.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:GetHealthStatus

get

*Listener

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether only to precheck the request. Valid values: true: prechecks the request only. The health status of the listener is not queried. The system prechecks the required parameters, request syntax, and limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the `DryRunOperation` error code is returned. false (default): sends a normal request. If the request passes the precheck, a 2xx HTTP status code is returned and the health status of the listener is obtained.	true
AcceleratorId	string	Yes	The ID of the GA instance that you want to query.	ga-bp1odcab8tmno0hdq****
ListenerId	string	Yes	The ID of the listener.	lsr-bp1bpn0kn908w4nbw****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
ListenerId	string	The ID of the listener.	lsr-bp1bpn0kn908w4nbw****
HealthStatus	string	The health status of endpoints and endpoint groups. Valid values: normal abnormal partiallyAbnormal	normal
EndpointGroups	array<object>	The information about the endpoint groups.
	array<object>	The information about the endpoint group.
EndpointGroupId	string	The ID of the endpoint group.	epg-bp14sz7ftcwwjgrdm****
EndpointGroupType	string	The type of the endpoint group. Valid values: default: the default endpoint group. virtual: a virtual endpoint group.	default
HealthStatus	string	The health status of the endpoint group. Valid values: init: The endpoint group is being initialized. normal: The endpoint group is normal. abnormal: The endpoint group is abnormal. partiallyAbnormal: The endpoint group is partially abnormal.	normal
ForwardingRuleIds	array	The IDs of the forwarding rules.
	string	The ID of the forwarding rule.	frule-bp134k63nmtwmnwee****
Endpoints	array<object>	The information about the endpoints.
	object	The information about the endpoints.
EndpointId	string	The ID of the endpoint.	ep-hp33b2e43fays7s8****
Address	string	The IP address of the endpoint.	47.0.XX.XX
HealthStatus	string	The health status of the endpoint. Valid values: init: The endpoint is being initialized. normal: The endpoint is normal. abnormal: The endpoint is abnormal.	normal
HealthDetail	string	The health check details of the endpoint. Note This parameter is unavailable.	null
Port	integer	The port that is used to connect to the endpoint.	80
Type	string	The type of the endpoint. Valid values: Domain: a custom domain name. Ip: a custom IP address. PublicIp: a public IP address provided by Alibaba Cloud. ECS: an Elastic Compute Service (ECS) instance. SLB: a Classic Load Balancer (CLB) instance. ALB: an Application Load Balancer (ALB) instance. OSS: an Object Storage Service (OSS) bucket. ENI: an elastic network interface (ENI). NLB: a Network Load Balancer (NLB) instance.	Ip

Examples

Success response

JSON format

{
  "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": "None",
          "Port": 80,
          "Type": "Ip"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.