仮想サーバ停止
API情報
| API種別 | メソッド | URI | 対象 | 名称 | 実行 |
|---|---|---|---|---|---|
| 設定 | PUT | /:GisServiceCode/virtual-servers/:IvmServiceCode/action.json /:GisServiceCode/virtual-servers/:IvdServiceCode/action.json | 仮想サーバ | 仮想サーバ停止 | 非同期 |
- 指定した仮想サーバIvmServiceCodeまたはIvdServiceCodeを停止します
- APIのレスポンスは仮想サーバの停止を待つことなく戻ります
- IvmServiceCodeおよびIvdServiceCodeはGisServiceCodeに所属する契約を指定する必要があります
リクエストパラメータ
| パラメータ | 必須 | 意味 | 値 | |
|---|---|---|---|---|
| URL | GisServiceCode | ○ | P2契約のサービスコード | gis######## |
| IvmServiceCode or IvdServiceCode | ○ | 停止する仮想サーバのサービスコード | ivm########, ivd######## | |
| ボディ | Power | ○ | 電源状態を設定 | "Off" |
| Force | 強制停止するならばYes, 通常のシャットダウンするならばNo。省略時には通常のシャットダウンを行う | "Yes", "No" |
レスポンス
| フィールド | タイプ | 意味 | 値 |
|---|---|---|---|
| Current.ResourceStatus | String | 設定した仮想サーバステータス | |
| Previous.ResourceStatus | String | 設定前の仮想サーバステータス |
制限
- 特になし
サンプル
リクエストボディ
{
"Power": "Off",
"Force": "No"
}
レスポンス (JSON)
{
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"Current": {
"ResourceStatus": "Stopping"
},
"Previous": {
"ResourceStatus": "Running"
}
}