2.6. StopInstances

サーバー(インスタンス)を停止します。

2.6.1. リクエストパラメータ

InstanceId.N
 サーバー(インスタンス)のIDです。Nは指定する数だけ1から連番になります。複数指定する場合は InstanceId.1=a******1&InstanceId.2=b******2のように指定します。
IDはコントロールパネルのサーバー詳細画面から確認ください。

  • 必須パラメータ: Yes

Force
 サーバーを強制停止するかどうかを判定します。True or Falseで指定してください。 指定しない場合はFalseとして扱います。

  • 必須パラメータ: No

2.6.2. サンプルリクエスト

curl -X GET \
-H 'X-KAGOYA-Auth: 768*******************50f' \
https://kcs-api.kagoya.com/ec2?Action=StopInstances \
&InstanceId.1=a*****1 \
&InstanceId.2=b*****2 \
&Force=False

2.6.3. サンプルレスポンス

エラーの場合は共通エラーレスポンスに従いエラー内容がレスポンスされます。
State名の意味は以下の通り

  • stopped : 停止中

  • running : 稼働中

  • pending : 削除済み

<?xml version="1.0" encoding="utf-8"?>
<instancesSet>
  <item>
    <instanceId>c*****3</instanceId>
    <currentState>
      <code>80</code>
      <name>stopped</name>
    </currentState>
    <previousState>
      <code>16</code>
      <name>running</name>
    </previousState>
  </item>
</instancesSet>