KDDIクラウドプラットフォームサービス ナレッジサイト

  • HOME
  • 提供API一覧
  • listVolumes

listVolumes

処理概要

ボリュームの一覧取得
 

注意事項

・なし
 

リクエスト

・リクエストパラメータ

Parameter Name Description Required
id the ID of the disk volume false
keyword List by keyword false
name the name of the disk volume false
tags List resources by tags (key/value pairs) false
type the type of disk volume false
virtualmachineid the ID of the virtual machine false
zoneid the ID of the availability zone false

・リクエストサンプル

$ ./kick_api.sh command=listVolumes type=DATADISK keyword=DATA-352150

レスポンス

・レスポンスボディ

 

Response Name Description
id ID of the disk volume
account the account associated with the disk volume
attached the date the volume was attached to a VM instance
created the date the disk volume was created
destroyed the boolean state of whether the volume is destroyed or not
deviceid the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.
diskBytesReadRate bytes read rate of the disk volume
diskBytesWriteRate bytes write rate of the disk volume
diskIopsReadRate io requests read rate of the disk volume
diskIopsWriteRate io requests write rate of the disk volume
diskofferingdisplaytext the display text of the disk offering
diskofferingid ID of the disk offering
diskofferingname name of the disk offering
displayvolume an optional field whether to the display the volume to the end user or not.
domain the domain associated with the disk volume
domainid the ID of the domain associated with the disk volume
hypervisor Hypervisor the volume belongs to
isextractable true if the volume is extractable, false otherwise
maxiops max iops of the disk volume
miniops min iops of the disk volume
name name of the disk volume
path The path of the volume
project the project name of the vpn
projectid the project id of the vpn
quiescevm need quiesce vm or not when taking snapshot
serviceofferingdisplaytext the display text of the service offering for root disk
serviceofferingid ID of the service offering for root disk
serviceofferingname name of the service offering for root disk
size size of the disk volume
snapshotid ID of the snapshot from which this volume was created
state the state of the disk volume
status the status of the volume
storage name of the primary storage hosting the disk volume
storageid id of the primary storage hosting the disk volume; returned to admin user only
storagetype shared or local storage
type type of the disk volume (ROOT or DATADISK)
virtualmachineid id of the virtual machine
vmdisplayname display name of the virtual machine
vmname name of the virtual machine
vmstate state of the virtual machine
zoneid ID of the availability zone
zonename name of the availability zone
tags(*) the list of resource tags associated with volume
account the account associated with the tag
customer customer associated with the tag
domain the domain associated with the tag
domainid the ID of the domain associated with the tag
key tag key name
project the project name where tag belongs to
projectid the project id the tag belongs to
resourceid id of the resource
resourcetype resource type
value tag value
jobid the ID of the latest async job acting on this object
jobstatus the current status of the latest async job acting on this object

 

・レスポンスサンプル
【コマンド実行結果】
<?xml version=”1.0″ encoding=”UTF-8″?>
<listvolumesresponse cloud-stack-version=”4.3.0.2″>
<count>1</count>
<volume>
<id>0bf554b6-2e5a-4e29-b0fc-02c4e6e034cc</id>
<name>DATA-352150</name>
<zoneid>7d4b9647-356d-49a8-8e1a-28862b9c9082</zoneid>
<zonename>jp2-east03</zonename>
<type>DATADISK</type>
<size>10737418240</size>
<created>2016-08-23T14:00:54+0900</created>
<state>Ready</state>
<account>xxxx</account>
<domainid>57edb9da-0279-45f0-842a-d768c4ed0d47</domainid>
<domain>MXXXXXXXX</domain>
<storagetype>shared</storagetype>
<diskofferingid>e69f5da8-9da1-418c-886a-fdf25e2f2190</diskofferingid>
<diskofferingname>MIDDLE_STORAGE</diskofferingname>
<diskofferingdisplaytext>MIDDLE_STORAGE</diskofferingdisplaytext>
<destroyed>false</destroyed>
<isextractable>true</isextractable>
<displayvolume>true</displayvolume>
<quiescevm>false</quiescevm>
</volume>
</listvolumesresponse>

提供API一覧

2022/07/06 2022/07/06