Overview
Set the health status of a server instance under an Auto Scaling Group owned by the user.
Request
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| serverInstanceNo | Yes | String | - | - Identification number of the server instance Invalid if the server instance is not part of the member's auto scaling group |
| healthStatusCode | Yes | String | Min: 1 Max: 5 |
- Valid values for health status codeHLTHY(HEALTHY) and UNHTH(UNHEALTHY)It is only possible after a server instance is created and put into service. |
| shouldRespectGracePeriod | No | Boolean | - | - Compliance with healthCheckGracePeriod (health check grace period) true falseIf the healthCheckGracePeriod period has not passed since the server instance was created and put into service, the attempt to change the status to unhealthy will not be applied. default : true |
| responseFormatType | No | String | - Format type of the response result Options: xml | json Default: xml |
Response
Response body
Examples
Request example
{AUTOSCALILNG_API_URL}/setServerInstanceHealth
?healthStatusCode=UNHTH
&serverInstanceNo=68128
Response example
<setServerInstanceHealthResponse>
<requestId>2785401a-14e4-42b2-9e65-0f59b29424d4</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
</setServerInstanceHealthResponse>