edit-icon download-icon

DescribeDisks

最終更新日: Aug 01, 2018

説明

利用可能なクラウドディスクを照会します。このインターフェイスを呼び出すときは、次の点を考慮してください。

  • 要求パラメーターを指定して、可能な応答結果を区切ることができます。RegionIdZoneIdDiskIds、およびInstanceIdなどの要求パラメータはフィルタとして機能し、パラメータは論理的関係AND(&&)で渡されます。

  • パラメータ “DisksIds”の値は、[“DiskId1”、 “DiskId2”、 “DiskId3”、…]の形式の Json 配列で、毎回最大 100 個の DiskId を指定できます。DiskIdsが渡されないと、ディスクは指定されません。DiskIds = []を指定すると、すべてのクラウドディスクが照会されます。

リクエストパラメーター

名前 必須かどうか 説明
Action String はい 値: DescribeDisks
Encrypted Boolean いいえ 暗号化されたディスクをフィルタリングします。 値の範囲:
  • true: 暗号化されたディスクのみを照会します。
  • false: 暗号化の属性を参照しません。
デフォルト値はfalseです。
RegionId String はい ディスクのリージョンID。詳細は「DescribeRegions」をご覧ください。
ZoneId String いいえ デフォルト値は空白で、すべてのゾーンのディスクのクエリを示します。
DiskIds String いいえ ディスクの ID
書式設定された JSON 配列: [“d-xxxxxxxxx”, “d-yyyyyyyyy”, … “d-zzzzzzzzz”]。シングルバイトのコンマで区切られた最大 10 個の ID。
InstanceId String いいえ インスタンスの ID
DiskType String いいえ ディスクのタイプ。 値の範囲:
  • all
  • system
  • data
デフォルト値はallです。
Category String いいえ ディスクカテゴリ。 オプション値:
  • all
  • cloud: Basic cloud disk
  • cloud_efficiency: Ultra cloud disk
  • cloud_ssd: Cloud SSD
  • ephemeral: Ephemeral disk
  • ephemeral_ssd: Ephemeral SSD
  • local_ssd_pro: Local NVMe SSD
  • local_hdd_pro: Local SATA HDD
デフォルト値は All です。
Status String いいえ ディスクスのテータス、詳細は 汎用クラウドディスクのステータス表 を参照してください。値の範囲:
  • In_use
  • Available
  • Attaching
  • Detaching
  • Creating
  • ReIniting
  • All
デフォルト値は All です。
SnapshotId String いいえ ディスクの作成に使用されるスナップショット
DiskName String いいえ 照会されたディスクの名前
Portable String いいえ ディスクをデタッチできるかどうか。値の範囲:
  • True は、独立して存在し、ゾーン内で自由にアタッチおよびデタッチできる、独立した汎用クラウドディスクを示します。
  • False は、独立した汎用クラウドディスクではないことを示します。このようなディスクは、インスタンスと共に作成および削除されます。
ユーザーがディスクの取り付けや取り外しを行う必要がある場合は、プロパティー値がtrueのディスクを照会する必要があります。
エフェメラルディスク、一般的なクラウドシステムディスク、およびサブスクリプションを持つ一般的なクラウドディスクの場合、このプロパティの値はfalseです。
ユーザーはこのプロパティを変更できません。
DeleteWithInstance String いいえ ディスクがインスタンスとともにリリースされるかどうか。
  • True は、インスタンスがリリースされると、このディスクもリリースされることを示します。
  • False は、インスタンスがリリースされても、このディスクは保持されることを示します。
デフォルト値は False です。
DeleteAutoSnapshot String いいえ ディスクの削除時に自動スナップショットが削除されるかどうか。 値の範囲:
  • True は、ディスクと共に自動スナップショットが削除されることを示します。
  • False は、自動スナップショットが保持されることを示します。
デフォルト値は False です。
PageNumber Integer いいえ ディスクステータスリストの現在のページ。開始値は 1、デフォルト値は 1 です。
PageSize Integer いいえ ページングクエリに対して設定されている 1 ページの行数。最大値は 100、デフォルト値は 10 です。

リターンパラメーター

名前 説明
RegionId String イメージのリージョン ID
TotalCount Integer インスタンスの総数
PageNumber Integer インスタンスリストのページ番号
PageSize Integer 入力の間に設定された 1 ページの行数
Disks DiskItemType DiskItemType などのディスク情報で構成される集合

リクエストの例

  1. https://ecs.aliyuncs.com/?action=DescribeDisks
  2. &RegionId=cn-qingdao
  3. &PageNumber=1
  4. &ZoneId=cn-qingdao-b
  5. &<Public Request Parameters>

戻り値の例

XML 形式

  1. <DescribeDisksResponse>
  2. <Disks>
  3. <Disk>
  4. <DeleteAutoSnapshot>true</DeleteAutoSnapshot>
  5. <DeleteWithInstance>false</DeleteWithInstance>
  6. <EnableAutoSnapshot>false</EnableAutoSnapshot>
  7. <Category>cloud</Category>
  8. <Description></Description>
  9. <DiskName></DiskName>
  10. <Size>5</Size>
  11. <Type>data</Type>
  12. <InstanceId></InstanceId>
  13. <CreationTime>2014-07-23T02:44:07Z</CreationTime>
  14. <ImageId></ImageId>
  15. <ZoneId>cn-qingdao-b</ZoneId>
  16. <AttachedTime>2014-07-23T07:47:35Z</AttachedTime>
  17. <DetachedTime>2014-07-23T08:28:48Z</DetachedTime>
  18. <Device></Device>
  19. <OperationLocks></OperationLocks>
  20. <Portable>true</Portable>
  21. <ProductCode></ProductCode>
  22. <RegionId>cn-qingdao</RegionId>
  23. <DiskId>d-28m5zbua0</DiskId>
  24. <SourceSnapshotId></SourceSnapshotId>
  25. <Status>Available</Status>
  26. </Disk>
  27. <Disk>
  28. <DeleteAutoSnapshot>true</DeleteAutoSnapshot>
  29. <DeleteWithInstance>false</DeleteWithInstance>
  30. <EnableAutoSnapshot>false</EnableAutoSnapshot>
  31. <Category>cloud</Category>
  32. <Description></Description>
  33. <DiskName></DiskName>
  34. <Size>5</Size>
  35. <Type>data</Type>
  36. <InstanceId></InstanceId>
  37. <CreationTime>2014-07-23T02:44:06Z</CreationTime>
  38. <ImageId></ImageId>
  39. <ZoneId>cn-qingdao-b</ZoneId>
  40. <AttachedTime></AttachedTime>
  41. <DetachedTime></DetachedTime>
  42. <Device></Device>
  43. <OperationLocks></OperationLocks>
  44. <Portable>true</Portable>
  45. <ProductCode></ProductCode>
  46. <RegionId>cn-qingdao</RegionId>
  47. <DiskId>d-28zfrmo13</DiskId>
  48. <SourceSnapshotId></SourceSnapshotId>
  49. <Status>Available</Status>
  50. </Disk>
  51. </Disks>
  52. <PageNumber>1</PageNumber>
  53. <PageSize>2</PageSize>
  54. <TotalCount>9</TotalCount>
  55. <RequestId>ED5CF6DD-71CA-462C-9C94-A61A78A01479</RequestId>
  56. </DescribeDisksResponse>

JSON 形式

  1. {
  2. "Disks": {
  3. "Disk": [
  4. {
  5. "AttachedTime": "2014-07-23T07:47:35Z",
  6. "Category": "cloud",
  7. "CreationTime": "2014-07-23T02:44:07Z",
  8. "DeleteAutoSnapshot": true,
  9. "DeleteWithInstance": false,
  10. "EnableAutoSnapshot": false,
  11. "Description": "",
  12. "DetachedTime": "2014-07-23T08:28:48Z",
  13. "Device": "",
  14. "DiskId": "d-28m5zbua0",
  15. "DiskName": "",
  16. "ImageId": "",
  17. "InstanceId": "",
  18. "OperationLocks": {
  19. "OperationLock": []
  20. },
  21. "Portable": true,
  22. "ProductCode": "",
  23. "RegionId": "cn-qingdao",
  24. "Size": 5,
  25. "SourceSnapshotId": "",
  26. "Status": "Available",
  27. "Type": "data",
  28. "ZoneId": "cn-qingdao-b"
  29. },
  30. {
  31. "AttachedTime": "",
  32. "Category": "cloud",
  33. "CreationTime": "2014-07-23T02:44:06Z",
  34. "DeleteAutoSnapshot": true,
  35. "DeleteWithInstance": false,
  36. "EnableAutoSnapshot": false
  37. "Description": "",
  38. "DetachedTime": "",
  39. "Device": "",
  40. "DiskId": "d-28zfrmo13",
  41. "DiskName": "",
  42. "ImageId": "",
  43. "InstanceId": "",
  44. "OperationLocks": {
  45. "OperationLock": []
  46. },
  47. "Portable": true,
  48. "ProductCode": "",
  49. "RegionId": "cn-qingdao",
  50. "Size": 5,
  51. "SourceSnapshotId": "",
  52. "Status": "Available",
  53. "Type": "data",
  54. "ZoneId": "cn-qingdao-b"
  55. }
  56. ]
  57. },
  58. "PageNumber": 1,
  59. "PageSize": 2,
  60. "RequestId": "ACD9BBB0-A9D1-46D7-9630-B7A69889E110",
  61. "TotalCount": 9
  62. }

エラーコード

このインタフェースに固有のエラーコードは次のとおりです。詳細については、APIのエラー・センターを参照してください。

エラーコード エラーメッセージ HTTP ステータスコード 意味
InvalidCategory.ValueNotSupported The specified disk category is not supported. 400 指定されたカテゴリはサポートされていません。それ以外の場合は、指定された DiskTypeを使用する権限がありません。
InvalidDiskType.ValueNotSupported The specified disk type is not supported. 400 指定された DiskTypeはサポートされていません。
InvalidRegion.NotFound The specified parameter RegionId is not valid. 400 指定された RegionIdは存在しません。
InvalidStatus.ValueNotSupported The specified disk status is not supported. 400 指定された Statusはサポートされていません。
InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. 400 指定された Tag.n.KeyTag.n.Valueは一致しなければなりません。
InvalidTagCount The specified tags are beyond the permitted range. 400 最大 5 個のTag.n.Keyを指定することができます。
InvalidZoneId.NotFound The ZoneId provided does not exist. 400 指定された ZoneIdは存在しません。
InvalidDiskIds.Malformed The amount of specified disk Ids exceeds the limit. 403 DiskIdの最大数を超えています。
InvalidDiskChargeType.NotFound The DiskChargeType does not exist. 404 指定された DiskChargeTypeは存在しません。