本文へジャンプします。

ニフティクラウド APIリファレンス

StopInstances

処理概要

指定したサーバーを停止します。

サーバーを指定するためには、サーバー名が必要です。削除済みのサーバーを指定した、管理外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。

サーバーの停止には、時間がかかることがあります。このAPIのレスポンス「currentState.name」を確認して「pending」が返ってきた場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。

なお、強制オプションに「true」を指定して実行した際に、サーバーが停止できない状態などのエラーが返されることがあります。強制オプションに「true」を指定して実行した場合には、システムチェックや修復を行うことをおすすめします。

指定するパラメーター

パラメーター 説明 必須 サンプル値
InstanceId.n サーバー名
Type : String
server04
Force 強制オプション
※「true」を指定すると、停止できない状態にあるサーバーで停止処理を強制実行する。
Type : Boolean
値 : true (強制実行) | false (強制実行しない) | 空 (強制実行しない)
Default : false
   
Tenancy.n テナント属性
Type : String
値 : dafault (通常) | dedicated (専有) | all (全て)
Default : default
   

応答フィールド

フィールド(項目) 説明 サンプル値
StopInstancesResponse StopInstancesレスポンス
Type : StopInstancesResponseType
Ancestor : なし
Children : requestId, instancesSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : StopInstancesResponse
Children : なし
b7ed3f0c-8603-4463-bd9c-8765d5efbaed
instancesSet 対象サーバーの情報セット
Type : InstanceStateChangeSetType
Ancestor : StopInstancesResponse
Children : item
 
item 対象サーバーの情報
Type : InstanceStateChangeType
Ancestor : instancesSet
Children : instanceId, instanceUniqueId, currentState, previousState
 
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
server04
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : item
Children : なし
i-efjh1234
currentState 現在のサーバーのステータス
Type : InstanceStateType
Ancestor : item
Children : code, name
 
code 現在のステータスコード
Type : xsd: integer
値 : 0 (pending) | 16 (running) | 80 (stopped)
Ancestor : currentState
Children : なし
0
name 現在のステータス名
Type : xsd:string
値 : pending(処理中) | running(起動済み) | stopped(停止済み)
Ancestor : currentState
Children : なし
pending
previousState 直前のサーバーのステータス
Type : InstanceStateType
Ancestor : item
Children : code, name
 
code 直前のステータスコード
Type : xsd: integer
値 : 0 (pending) | 16 (running) | 80 (stopped)
Ancestor : previousState
Children : なし
16
name 直前のステータス名
Type : xsd:string
値 : pending(処理中) | running(起動済み) | stopped(停止済み)
Ancestor : previousState
Children : なし
Running
tenancy テナント属性
Type : xsd:string
値 : default (通常) | dedicated (専有)
Ancestor : item
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=StopInstances&InstanceId.1=server04&CommonParams

応答サンプル

<StopInstancesResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>b7ed3f0c-8603-4463-bd9c-8765d5efbaed</requestId>
  <instancesSet>
    <item>
      <instanceId>server04</instanceId>
      <instanceUniqueId>i-efjh1234</instanceUniqueId>
      <currentState>
        <code>0</code>
        <name>pending</name>
      </currentState>
      <previousState>
        <code>16</code>
        <name>running</name>
      </previousState>
    </item>
  </instancesSet>
</StopInstancesResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

推奨画面サイズ 1024×768 以上