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

Retrieves the health status information of endpoint groups and endpoints under a specified 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 region ID of the Alibaba Cloud Global Accelerator (GA) instance. 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 value, but you must ensure that it 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 RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: sends a dry run request and does not retrieve the health status of the listener. The system checks whether required parameters are specified, the request format, and service limits. If the request fails the check, an error is returned. If the request passes the check, the `DryRunOperation` error code is returned. false (default): sends a normal request. If the request passes the check, an HTTP 2xx status code is returned and the health status of the listener is retrieved.	true
AcceleratorId	string	Yes	The instance ID of the Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
ListenerId	string	Yes	The instance ID of the listener.	lsr-bp1bpn0kn908w4nbw****

Response elements

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

Examples

Success response

JSON format

{
  "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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.