本文へジャンプします。

ニフクラ ユーザーガイド

本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/cp/api/TerminateInstances.htmへ移行しました。 今後は新ページをご参照ください。

TerminateInstances

処理概要

指定したサーバーを削除します。

サーバーを指定するためには、サーバー名が必要です。

サーバーの削除には、時間がかかることがあります。このAPIのレスポンス「currentState.name」を確認して「pending」が返ってきた場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。また、API「DescribeInstances」のレスポンスに該当情報がない場合は、削除処理は成功しています。
アップロード中またはインポート中のサーバーを、このAPIで削除することはできません。API「CancelUpload」を使用してください。

関連する付替IPアドレス設定もあわせて解除します。

指定するパラメーター

パラメーター 説明 必須
InstanceId.n string サーバー名

応答フィールド

フィールド (項目) 説明
TerminateInstancesResponse - TerminateInstancesレスポンス
requestId string リクエスト識別子
instancesSet - 対象サーバーの情報セット
item - 対象サーバーの情報
instanceId string サーバー名
instanceUniqueId string サーバーユニークID
currentState - 現在のサーバーのステータス
code integer 現在のステータスコード
備考: 返却値 0 (pending),16 (running),80 (stopped),48 (terminated)
name string 現在のステータス名
値:
  • pending (処理中)
  • running (起動済み)
  • stopped (停止済み)
  • terminated (削除済み)
previousState - 直前のサーバーのステータス
code integer 直前のステータスコード
備考: 返却値 0 (pending),16 (running),80 (stopped)
name string 直前のステータス名
値:
  • pending (処理中)
  • running (起動済み)
  • stopped (停止済み)

リクエストサンプル

    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>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

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