概要
サーバインスタンスのヘルスステータス更新
説明
ユーザーが保有するAuto Scaling Group所属のサーバインスタンスのヘルスステータスを設定できます。
リクエストパラメータ
| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| serverInstanceNo | Yes | String | - | サーバインスタンスの識別番号であり、会員のAuto Scaling Group所属のサーバインスタンスでない場合は有効ではありません。 |
| healthStatusCode | Yes | String | Min : 1, Max : 5 | ヘルスステータスコードであり、有効値にHEALTHY(HLTHY)とNHEALTHY(UNHTH)があります。前に記載した括弧の中のコード値を使うこと、サーバインスタンスが作成されてからサービスに投入された以降のみ可能です。 |
| shouldRespectGracePeriod | No | Boolean | - | ヘルスチェック保留期間(healthCheckGracePeriod)遵守区分をtrue/falseで入力します。 サーバインスタンスが作成された以降にサービスに投入された時刻からhealthCheckGracePeriod期間が過ぎない場合、unhealthyステータスに変更しようとしても適用されません。デフォルトでその保留期間を遵守します。 その値がFalseである場合、その保留期間を遵守しません。 |
レスポンスデータタイプ
- CommonResponseタイプ
| CommonResponse extends BaseObject |
|---|
| private String requestId; |
| private String returnCode; |
| private String returnMessage; |
例示
呼び出し
ncloud autoscaling setServerInstanceHealth --serverInstanceNo 396463 --healthStatusCode HLTHY
レスポンス
{
"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>