setServerInstanceHealth
- Print
- PDF
setServerInstanceHealth
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Sets the health status of a server instance in your Auto Scaling group.
Request
Request parameters
| Parameter | Required | Type | Limitations | Description |
|---|---|---|---|---|
| serverInstanceNo | Y | String | - | Server instance number, which is not valid if the server instance does not belong to your Auto Scaling group. |
| healthStatusCode | Y | String | Min: 1 Max: 5 | Health status code. The available values are HLTHY (HEALTHY) and UNHTH (UNHEALTHY). This parameter is available only after a server instance is created and then starts to run for your service. |
| shouldRespectGracePeriod | N | Boolean | - | Indicates whether to respect the healthCheckGracePeriod. The available values are true and false. If the healthCheckGracePeriod does not end after a server instance is created and starts to run for your service, you cannot change the health status to unhealthy. Default: true |
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>
Was this article helpful?