Monitor Load Balancer Origin Health via API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Operation description

Queries the health status of origins in the origin pools of one or more load balancers. You can specify multiple load balancer IDs separated by commas. This operation applies only to load balancers with monitors configured. The monitor probes each origin in the associated origin pools and records its current status.

Healthy (healthy): The origin is reachable.
Unhealthy (unhealthy): The origin is unreachable.
Unknown (unknown): The monitor has not yet probed the origin.
Undetected (undetected): The load balancer that the origin belongs to is not bound to a monitor.

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

esa:ListLoadBalancerOriginStatus

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID.	1159101787****
LoadBalancerIds	string	Yes	The load balancer IDs. To query multiple load balancers, separate the IDs with commas. You can specify up to 100 load balancer IDs at a time. You can obtain load balancer IDs by calling the ListLoadBalancers operation.	99874066052**,100892832360**
PoolType	string	No	The origin pool type. A load balancer can have multiple origin pools configured, including default pools, fallback pools, and primary region pools. Only the status of origins in the default pool affects the overall load balancer status. Set this parameter to `default_pool` to query only the status of origins in the default origin pool.	default_pool

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
OriginStatus	array<object>	The origin status list for the load balancer.
	object	The origin status details.
LoadBalancerId	integer	The load balancer ID.	99874066052****
OriginId	integer	The origin ID.	99750209487****
PoolId	integer	The origin pool ID.	99750209487****
Status	string	The origin status. Valid values: Healthy (healthy): The origin is reachable. Unhealthy (unhealthy): The origin is unreachable. Unknown (unknown): The monitor has not yet probed the origin. Undetected (undetected): The load balancer that the origin belongs to is not bound to a monitor.	healthy
Reason	string	The reason for the probe failure.	TCP connection error
PoolType	string	The type of origin pool to which the origin belongs under this load balancer. Only `default_pool` (default origin pool) is returned; other types return an empty string.	default_pool

Examples

Success response

JSON format

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "OriginStatus": [
    {
      "LoadBalancerId": 0,
      "OriginId": 0,
      "PoolId": 0,
      "Status": "healthy",
      "Reason": "TCP connection error",
      "PoolType": "default_pool"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	LoadBalancerNotExist	The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.	The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.