本文へジャンプします。

ニフティクラウド APIリファレンス

DescribeVolumes

処理概要

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

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

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
VolumeId.n ディスク名
Type : String
Default : 取得可能なすべてのディスク
   

応答フィールド

フィールド(項目) 説明 サンプル値
DescribeVolumesResponse DescribeVolumesレスポンス
Type : DescribeVolumesResponseType
Ancestor : なし
Children : requestId, volumeSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeVolumesResponse
Children : なし
5f781c9f-ad69-4a20-a0bc-d3ebbeff6c75
volumeSet 取得したディスクの情報セット
Type : DescribeVolumesSetResponseType
Ancestor : DescribeVolumesResponse
Children : item
 
item 取得したディスクの情報
Type : DescribeVolumesSetItemResponseType
Ancestor : volumeSet
Children : volumeId, size, diskType, snapshotId, availabilityZone, status, createTime, accountingType , nextMonthAccountingType, attachmentSet
 
volumeId ディスク名
Type : xsd:string
Ancestor : item
Children : なし
disk01
size ディスクサイズ
単位 : GB
Type : xsd:string
Ancestor : item
Children : なし
200
diskType ディスクタイプ
Type : xsd:string
値 : Standard Storage | High-Speed Storage A | High-Speed Storage B | Flash Storage
Ancestor : item
Children : なし
High-Speed Storage A
snapshotId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
availabilityZone ゾーン名
Type : xsd:string
Ancestor : item
Children : なし
east-11
status 作成ステータス
Type : xsd:string
値 : creating (作成中) | available (利用可能) | in-use (接続済み) | configuring(設定中)
Ancestor : item
Children : なし
in-use
createTime ディスク作成日時(表示形式:yyyy-mm-ddThh:mi:ss.sssZ)
Type : xsd:dateTime
Ancestor : item
Children : なし
2010-05-17T11:22:33.456Z
accountingType 利用料金タイプ
Type : xsd:string
値 : 1(月額課金) | 2(従量課金)
Ancestor : item
Children : なし
 
nextMonthAccountingType 次月からの利用料金タイプ
Type : xsd:string
値 : 1(月額課金) | 2(従量課金)
Ancestor : item
Children : なし
 
attachmentSet 接続しているサーバーの情報セット
Type : AttachmentSetResponseType
Ancestor : item
Children : item
 
item 接続しているサーバーの情報
Type : AttachmentSetItemResponseType
Ancestor : attachmentSet
Children : volumeId, instanceId, instanceUniqueId, device, status, attachTime, deleteOnTermination
 
volumeId ディスク名
Type : xsd:string
Ancestor : item
Children : なし
disk01
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
server01
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : item
Children : なし
i-efgj1234
device ディスクの接続デバイス
Type : xsd:string
値 : SCSI(xx:xx)
Ancestor : item
Children : なし
SCSI(0:1)
status 接続ステータス
Type : xsd:string
値 : attaching (接続中) | attached (接続済み) | detaching (接続解除中) | detached (未接続)
Ancestor : item
Children : なし
attached
attachTime ディスク接続日時(表示形式:yyyy-mm-ddThh:mi:ss.sssZ)
Type : xsd:dateTime
Ancestor : item
Children : なし
2010-05-17T11:22:33.456Z
deleteOnTermination サーバー削除時のディスク消去
Type : xsd:boolean
値 : true (消去) | false (消去しない)
Ancestor : item
Children : なし
false
description メモ
Type : xsd:string
Ancestor : item
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeVolumes&CommonParams

応答サンプル

<DescribeVolumesResponse xmlns="https://cp.cloud.nifty.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>2010-05-17T11:22:33.456Z</createTime>
      <attachmentSet>
        <item>
          <volumeId>disk01</volumeId>
          <instanceId>server01</instanceId>
          <instanceUniqueId>i-efgj1234</instanceUniqueId>
          <device>SCSI(0:1)</device>
          <status>attached</status>
          <attachTime>2010-05-17T11:22:33.456Z</attachTime>
        </item>
        <description>Memo</description>
      </attachmentSet>
    </item>
  </volumeSet>
</DescribeVolumesResponse>

ニフティクラウド サイト内検索

APIメニュー

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

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