TerminateInstances
処理概要
指定したサーバーを削除します。
サーバーを指定するためには、サーバー名が必要です。
サーバーの削除には、時間がかかることがあります。このAPIのレスポンス「currentState.name」を確認して「pending」が返ってきた場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。また、API「DescribeInstances」のレスポンスに該当情報がない場合は、削除処理は成功しています。
アップロード中またはインポート中のサーバーを、このAPIで削除することはできません。API「CancelUpload」を使用してください。
関連する付替IPアドレス設定もあわせて解除します。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
InstanceId.n | string |
サーバー名 |
○ |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
TerminateInstancesResponse | - |
TerminateInstancesレスポンス Ancestor: なし Children: requestId | instancesSet |
requestId | string |
リクエスト識別子 Ancestor: TerminateInstancesResponse Children: なし |
instancesSet | - |
対象サーバーの情報セット Ancestor: TerminateInstancesResponse Children: item |
item | - |
対象サーバーの情報 Ancestor: instancesSet Children: instanceId | instanceUniqueId | currentState | previousState |
instanceId | string |
サーバー名 Ancestor: item Children: なし |
instanceUniqueId | string |
サーバーユニークID Ancestor: item Children: なし |
currentState | - |
現在のサーバーのステータス Ancestor: item Children: code | name |
code | integer |
現在のステータスコード 値: 0 (pending) | 16 (running) | 80 (stopped) | 48(terminated) Ancestor: currentState Children: なし |
name | string |
現在のステータス名 値: pending(処理中) | running(起動済み) | stopped(停止済み) | terminated(削除済み) Ancestor: currentState Children: なし |
previousState | - |
直前のサーバーのステータス Ancestor: item Children: code | name |
code | integer |
直前のステータスコード 値: 0 (pending) | 16 (running) | 80 (stopped) Ancestor: previousState Children: なし |
name | string |
直前のステータス名 値: pending(処理中) | running(起動済み) | stopped(停止済み) Ancestor: previousState Children: なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=TerminateInstances
&InstanceId.1=server04
&CommonParams
応答サンプル
<TerminateInstancesResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<instancesSet>
<item>
<instanceId>server04</instanceId>
<instanceUniqueId>i-efjh1234</instanceUniqueId>
<currentState>
<code>0</code>
<name>pending</name>
</currentState>
<previousState>
<code>80</code>
<name>stopped</name>
</previousState>
</item>
</instancesSet>
</TerminateInstancesResponse>