setServerInstanceHealth

Prev Next

概要

ユーザーが保有する Auto Scaling Group所属のサーバインスタンスのヘルス状態を設定

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
serverInstanceNo Yes String - - サーバインスタンスの識別番号
会員のオートスケーリンググループ所属のサーバインスタンスでなければ無効
healthStatusCode Yes String 最小: 1
最大: 5
- ヘルス状態コードの有効値
HLTHY(HEALTHY)UNHTH(UNHEALTHY)がある
サーバインスタンスが作成されてからサービスに投入された後にのみ可能
shouldRespectGracePeriod No Boolean - - healthCheckGracePeriod(ヘルスチェックの猶予期間)を遵守するかどうか true false
サーバインスタンスが作成されてからサービスに投入された時刻から healthCheckGracePeriod期間が経過しないと、unhealthy状態に変更しようとしても適用されない
default : true
responseFormatType No String - レスポンス結果の形式タイプ
オプション: xml | json
デフォルト: xml

レスポンス

レスポンスボディ

リクエスト例

{AUTOSCALILNG_API_URL}/setServerInstanceHealth
?healthStatusCode=UNHTH
&serverInstanceNo=68128

レスポンス例

<setServerInstanceHealthResponse>
   <requestId>2785401a-14e4-42b2-9e65-0f59b29424d4</requestId>
   <returnCode>0</returnCode>
   <returnMessage>success</returnMessage>
</setServerInstanceHealthResponse>