StopVirtualMachine

API情報

API種別 Action 対象 名称 実行
設定 StopVirtualMachine VM 仮想サーバ停止 非同期

リクエストパラメータ

パラメータ 必須 意味
GpServiceCode 対象仮想サーバを含むgpサービスコード
GcServiceCode 対象仮想サーバのgcサービスコード
Force  

強制的に仮想サーバを停止します

値: Yes, No

デフォルト値: No

レスポンス

フィールド タイプ 意味
StartVirtualMachineResponse.GcServiceCode String 対象仮想サーバのgcサービスコード
StartVirtualMachineResponse.Current.Status String

対象仮想サーバの現在の状態 (仮想サーバの状態遷移)

StartVirtualMachineResponse.Previous.Status String 対象仮想サーバのAPIリクエスト前の状態 (仮想サーバの状態遷移)

エラーコード

制限

サンプル

リクエスト

※実際には一行で現します
https://gp.api.iij.jp/json
    ?APIVersion=20130901
    &AccessKeyId=XXXXXXXXXXXXXXXXXXXX
    &Action=StopVirtualMachine
    &Expire=2013-09-01T10%3A10%3A30Z
    &GcServiceCode=gc########
    &GpServiceCode=gp########
    &SignatureMethod=HmacSHA256
    &SignatureVersion=2
    &Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

レスポンス (JSON)

Json
{
    "StopVirtualMachineResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GcServiceCode": "gc########",
        "Current": {
            "Status": "Stopping"
        },
        "Previous": {
            "Status": "Running"
        }
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<StopVirtualMachineResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GcServiceCode>gc########</GcServiceCode>
  <Current>
    <Status>Stopping</Status>
  </Current>
  <Previous>
    <Status>Running</Status>
  </Previous>
</StopVirtualMachineResponse>