ニフクラAPI (コンピューティング: DescribeVolumes)

DescribeVolumes

処理概要

指定したディスクの情報を取得します。

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

ディスクを指定しない場合、取得できるすべてのディスク情報を取得します。

指定するパラメーター

パラメーター	型	説明	必須
VolumeId.n	string	ディスク名

応答フィールド

フィールド (項目)	型	説明
DescribeVolumesResponse	-	DescribeVolumesレスポンス
␣requestId	string	リクエスト識別子
␣volumeSet	-	取得したディスクの情報セット
␣␣item	-	取得したディスクの情報
␣␣␣volumeId	string	ディスク名
␣␣␣size	string	ディスクサイズ 単位: GB
␣␣␣diskType	string	ディスクタイプ 値: Standard Storage (標準ディスク) High-Speed Storage A (高速ディスクA) High-Speed Storage B (高速ディスクB) Flash Storage (フラッシュドライブ) Standard Flash Storage A (標準フラッシュドライブA) Standard Flash Storage B (標準フラッシュドライブB) High-Speed Flash Storage A (高速フラッシュドライブA) High-Speed Flash Storage B (高速フラッシュドライブB)
␣␣␣snapshotId	string	※返却値なし
␣␣␣availabilityZone	string	ゾーン名
␣␣␣status	string	作成ステータス 値: in-use (接続済み) creating (作成中) available (利用可能) wait_configure (設定待ち) configuring (設定中)
␣␣␣createTime	timestamp	ディスク作成日時 表示形式:yyyy-mm-ddThh:mi:ss.sss+09:00
␣␣␣accountingType	string	利用料金タイプ 値: 1 (月額課金) 2 (従量課金)
␣␣␣nextMonthAccountingType	string	次月からの利用料金タイプ 値: 1 (月額課金) 2 (従量課金)
␣␣␣attachmentSet	-	接続しているサーバーの情報セット
␣␣␣␣item	-	接続しているサーバーの情報
␣␣␣␣␣volumeId	string	ディスク名
␣␣␣␣␣instanceId	string	サーバー名
␣␣␣␣␣instanceUniqueId	string	サーバーユニークID
␣␣␣␣␣device	string	※空を返却 ディスクの接続デバイス
␣␣␣␣␣status	string	接続ステータス 値: attached (接続済み) attaching (接続中)
␣␣␣␣␣attachTime	string	ディスク接続日時 表示形式:yyyy-mm-ddThh:mi:ss.sss+09:00
␣␣␣␣␣deleteOnTermination	string	サーバー削除時のディスク削除 値: false (削除しない)
␣␣␣description	string	メモ

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DescribeVolumes
  &CommonParams

  

応答サンプル

    <DescribeVolumesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <volumeSet>
    <item>
      <volumeId>disk01</volumeId>
      <size>200</size>
      <diskType>High-Speed Storage A</diskType>
      <snapshotId/>
      <availabilityZone>east-11</availabilityZone>
      <accountingType>1</accountingType>
      <nextMonthAccountingType>1</nextMonthAccountingType>
      <status>in-use</status>
      <createTime>2020-07-27T11:22:33.456+09:00</createTime>
      <attachmentSet>
        <item>
          <volumeId>disk01</volumeId>
          <instanceId>server01</instanceId>
          <instanceUniqueId>i-efgj1234</instanceUniqueId>
          <device/>
          <status>attached</status>
          <attachTime>2020-07-27T11:22:33.456+09:00</attachTime>
          <deleteOnTermination>false</deleteOnTermination>
        </item>
      </attachmentSet>
      <description>Memo</description>
    </item>
  </volumeSet>
</DescribeVolumesResponse>