DescribeDisks - - Alibaba Cloud ドキュメントセンター

要求パラメーターを指定して、可能な応答結果を区切ることができます。RegionId、ZoneId、DiskIds、および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 などのディスク情報で構成される集合

例

リクエストの例

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

戻り値の例

XML 形式

<DescribeDisksResponse>
    <Disks>
        <Disk>
            <DeleteAutoSnapshot>true</DeleteAutoSnapshot>
            <DeleteWithInstance>false</DeleteWithInstance>
            <EnableAutoSnapshot>false</EnableAutoSnapshot>
            <Category>cloud</Category>
            <Description></Description>
            <DiskName></DiskName>
            <Size>5</Size>
            <Type>data</Type>
            <InstanceId></InstanceId>
            <CreationTime>2014-07-23T02:44:07Z</CreationTime>
            <ImageId></ImageId>
            <ZoneId>cn-qingdao-b</ZoneId>
            <AttachedTime>2014-07-23T07:47:35Z</AttachedTime>
            <DetachedTime>2014-07-23T08:28:48Z</DetachedTime>
            <Device></Device>
            <OperationLocks></OperationLocks>
            <Portable>true</Portable>
            <ProductCode></ProductCode>
            <RegionId>cn-qingdao</RegionId>
            <DiskId>d-28m5zbua0</DiskId>
            <SourceSnapshotId></SourceSnapshotId>
            <Status>Available</Status>
        </Disk>
        <Disk>
            <DeleteAutoSnapshot>true</DeleteAutoSnapshot>
            <DeleteWithInstance>false</DeleteWithInstance>
            <EnableAutoSnapshot>false</EnableAutoSnapshot>
            <Category>cloud</Category>
            <Description></Description>
            <DiskName></DiskName>
            <Size>5</Size>
            <Type>data</Type>
            <InstanceId></InstanceId>
            <CreationTime>2014-07-23T02:44:06Z</CreationTime>
            <ImageId></ImageId>
            <ZoneId>cn-qingdao-b</ZoneId>
            <AttachedTime></AttachedTime>
            <DetachedTime></DetachedTime>
            <Device></Device>
            <OperationLocks></OperationLocks>
            <Portable>true</Portable>
            <ProductCode></ProductCode>
            <RegionId>cn-qingdao</RegionId>
            <DiskId>d-28zfrmo13</DiskId>
            <SourceSnapshotId></SourceSnapshotId>
            <Status>Available</Status>
        </Disk>
    </Disks>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <TotalCount>9</TotalCount>
    <RequestId>ED5CF6DD-71CA-462C-9C94-A61A78A01479</RequestId>
</DescribeDisksResponse>

JSON 形式

{
  "Disks": {
    "Disk": [
      {
        "AttachedTime": "2014-07-23T07:47:35Z",
        "Category": "cloud",
        "CreationTime": "2014-07-23T02:44:07Z",
        "DeleteAutoSnapshot": true,
        "DeleteWithInstance": false,
        "EnableAutoSnapshot": false,
        "Description": "",
        "DetachedTime": "2014-07-23T08:28:48Z",
        "Device": "",
        "DiskId": "d-28m5zbua0",
        "DiskName": "",
        "ImageId": "",
        "InstanceId": "",
        "OperationLocks": {
            "OperationLock": []
        },
        "Portable": true,
        "ProductCode": "",
        "RegionId": "cn-qingdao",
        "Size": 5,
        "SourceSnapshotId": "",
        "Status": "Available",
        "Type": "data",
        "ZoneId": "cn-qingdao-b"
      },
      {
        "AttachedTime": "",
        "Category": "cloud",
        "CreationTime": "2014-07-23T02:44:06Z",
        "DeleteAutoSnapshot": true,
        "DeleteWithInstance": false,
        "EnableAutoSnapshot": false
        "Description": "",
        "DetachedTime": "",
        "Device": "",
        "DiskId": "d-28zfrmo13",
        "DiskName": "",
        "ImageId": "",
        "InstanceId": "",
        "OperationLocks": {
            "OperationLock": []
        },
        "Portable": true,
        "ProductCode": "",
        "RegionId": "cn-qingdao",
        "Size": 5,
        "SourceSnapshotId": "",
        "Status": "Available",
        "Type": "data",
        "ZoneId": "cn-qingdao-b"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 2,
  "RequestId": "ACD9BBB0-A9D1-46D7-9630-B7A69889E110",
  "TotalCount": 9
}

エラーコード

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

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.Key`と`Tag.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`は存在しません。