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