本文へジャンプします。

ニフクラ ユーザーガイド

DescribeVolumes

処理概要

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

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

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

指定するパラメーター

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

応答フィールド

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

リクエストサンプル

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

  

応答サンプル

    <DescribeVolumesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>5f781c9f-ad69-4a20-a0bc-d3ebbeff6c75</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>
        <description>Memo</description>
      </attachmentSet>
    </item>
  </volumeSet>
</DescribeVolumesResponse>

  

ニフクラ サイト内検索

APIメニュー

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

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