setServerInstanceHealth
- Print
- PDF
setServerInstanceHealth
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Adjust health status of server instances
Description
Adjust health status of server instances under Auto Scaling Group of a user.
Request Parameters
| Parameter | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| serverInstanceNo | Yes | String | - | Identification number of a server instance to adjust health status. The number is invalid if the server instance does not belong to Auto Scaling Group. |
| healthStatusCode | Yes | String | Min : 1, Max : 5 | HEALTHY(HLTHY) and UNHEALTHY(UNHTH) are available values of the health status code. Use the code values in parenthesis above. It can only be used once a server instance has been created and added to a service. |
| shouldRespectGracePeriod | No | Boolean | - | Whether to honor healthCheckGracePeriod If the healthCheckGracePeriod is not exceeded from the time when a server instance was created and added to a service, the status cannot be changed into unhealthy. The grace period will be followed as the default value. If the value is false, the grace period will not be complied with. |
Response Data type
- CommonResponse Type
| CommonResponse extends BaseObject |
|---|
| private String requestId; |
| private String returnCode; |
| private String returnMessage; |
Examples
Request
ncloud autoscaling setServerInstanceHealth --serverInstanceNo 396463 --healthStatusCode HLTHY
Response
{
"setServerInstanceHealthResponse": {
"requestId": "e6715629-bf2c-4991-b2ea-a7606f2fe488",
"returnCode": "0",
"returnMessage": "success"
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<setServerInstanceHealthResponse>
<requestId>e6715629-bf2c-4991-b2ea-a7606f2fe488</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
</setServerInstanceHealthResponse>
Was this article helpful?