Override ECS Health Checks via SetInstanceHealth API - Auto Scaling - Alibaba Cloud - Auto Scaling

Manually sets the health status of an Elastic Compute Service (ECS) instance or elastic container instance in a scaling group. When automatic health checks cannot accurately detect instance health, call this operation to quickly identify and handle faulty instances based on your actual business and O\\\&M requirements.

Operation description

伸缩组会检测并移出处于不健康状态的 ECS 实例或 ECI 实例，如果您需要保留指定的 ECS 实例或 ECI 实例，请将 ECS 实例或 ECI 实例转入备用或者保护状态，更多信息，请参见 EnterStandby 和 SetInstancesProtection 。

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

ess:SetInstanceHealth

update

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	i-bp1ap6bro51a7fsa****
HealthStatus	string	Yes	The health status of the instance. Valid values: Healthy: sets the instance as healthy. Unhealthy: sets the instance as unhealthy.	Healthy

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	B755AE57-6093-43E4-938E-DEA422A9****

Examples

Success response

JSON format

{
  "RequestId": "B755AE57-6093-43E4-938E-DEA422A9****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.