接口说明

• 请求参数RegionId、ZoneId、DiskIds和InstanceId等都是过滤器的概念，参数间是逻辑与（AND）关系。
• 请求参数DiskIds是一个JSON格式的数组（Array），如果参数为空，则过滤器不起作用，但是DiskIds如果是一个空数组，则视为该过滤器有效，且返回空。
• 支持以下两种方式查看返回数据：
  • 方式一：通过NextToken设置查询凭证（Token），其取值是上一次调用DescribeDisks返回的NextToken参数值，再通过MaxResults设置单页查询的最大条目数。

  • 方式二：通过PageSize设置单页返回的条目数，再通过PageNumber设置页码。

    以上两种方式只能任选其中之一。当返回的条目数较多时，推荐使用方式一。如果设置了NextToken，则请求参数PageSize和PageNumber将失效，且返回数据中的TotalCount无效。

• 开启多重挂载特性的云盘可以挂载到多个实例上，您可以根据返回结果的Attachment列表查看云盘涉及的所有挂载信息。

通过阿里云CLI调用API时，不同数据类型的请求参数取值必须遵循格式要求。更多信息，请参见CLI参数格式说明。

请求参数

返回数据

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeDisks
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&<公共请求参数>

正常返回示例

XML格式

<DescribeDisksResponse>
      <TotalCount>15</TotalCount>
      <NextToken>AAAAAdDWBF2****</NextToken>
      <PageSize>1</PageSize>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <PageNumber>1</PageNumber>
      <Disks>
            <Disk>
                  <DetachedTime></DetachedTime>
                  <Category>cloud_ssd</Category>
                  <Description>testDescription</Description>
                  <KMSKeyId></KMSKeyId>
                  <ResourceGroupId></ResourceGroupId>
                  <DedicatedBlockStorageClusterId></DedicatedBlockStorageClusterId>
                  <Encrypted>false</Encrypted>
                  <Size>40</Size>
                  <DeleteAutoSnapshot>false</DeleteAutoSnapshot>
                  <DiskChargeType>PrePaid</DiskChargeType>
                  <MultiAttach>Disabled</MultiAttach>
                  <Attachments>
                        <Attachment>
                              <AttachedTime>2021-06-07T06:08:56Z</AttachedTime>
                              <InstanceId>i-bp67acfmxazb4q****</InstanceId>
                              <Device>/dev/xvda</Device>
                        </Attachment>
                  </Attachments>
                  <ExpiredTime>2021-07-07T16:00Z</ExpiredTime>
                  <ImageId>m-bp13aqm171qynt3u***</ImageId>
                  <StorageSetId></StorageSetId>
                  <Tags>
            </Tags>
                  <Status>In_use</Status>
                  <AttachedTime>2021-06-07T06:08:56Z</AttachedTime>
                  <StorageClusterId>dbsc-j5e1sf2vaf5he8m2****</StorageClusterId>
                  <ZoneId>cn-hangzhou-i</ZoneId>
                  <InstanceId>i-bp67acfmxazb4q****</InstanceId>
                  <SourceSnapshotId></SourceSnapshotId>
                  <ProductCode></ProductCode>
                  <PerformanceLevel>PL0</PerformanceLevel>
                  <Device>/dev/xvda</Device>
                  <DeleteWithInstance>true</DeleteWithInstance>
                  <EnableAutomatedSnapshotPolicy>false</EnableAutomatedSnapshotPolicy>
                  <EnableAutoSnapshot>false</EnableAutoSnapshot>
                  <AutoSnapshotPolicyId>sp-bp67acfmxazb4p****</AutoSnapshotPolicyId>
                  <DiskName>testDiskName</DiskName>
                  <OperationLocks>
            </OperationLocks>
                  <BdfId></BdfId>
                  <Portable>false</Portable>
                  <Type>system</Type>
                  <SerialNumber>bp18um4r4f2fve2****</SerialNumber>
                  <CreationTime>2021-06-07T06:08:54Z</CreationTime>
                  <RegionId>cn-hangzhou</RegionId>
                  <DiskId>d-bp18um4r4f2fve24****</DiskId>
            </Disk>
      </Disks>
</DescribeDisksResponse>

JSON格式

{
	"TotalCount": 15,
	"NextToken": "AAAAAdDWBF2****",
	"PageSize": 1,
	"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
	"PageNumber": 1,
	"Disks": {
		"Disk": [
			{
				"DetachedTime": "",
				"Category": "cloud_ssd",
				"Description": "testDescription",
				"KMSKeyId": "",
				"ResourceGroupId": "",
				"DedicatedBlockStorageClusterId": "",
				"Encrypted": false,
				"Size": 40,
				"DeleteAutoSnapshot": false,
				"DiskChargeType": "PrePaid",
				"MultiAttach": "Disabled",
				"Attachments": {
					"Attachment": [
						{
							"AttachedTime": "2021-06-07T06:08:56Z",
							"InstanceId": "i-bp67acfmxazb4q****",
							"Device": "/dev/xvda"
						}
					]
				},
				"ExpiredTime": "2021-07-07T16:00Z",
				"ImageId": "m-bp13aqm171qynt3u***",
				"StorageSetId": "",
				"Tags": {
					"Tag": []
				},
				"Status": "In_use",
				"AttachedTime": "2021-06-07T06:08:56Z",
                "StorageClusterId": "dbsc-j5e1sf2vaf5he8m2****",
				"ZoneId": "cn-hangzhou-i",
				"InstanceId": "i-bp67acfmxazb4q****",
				"SourceSnapshotId": "",
				"ProductCode": "",
				"PerformanceLevel": "PL0",
				"Device": "/dev/xvda",
				"DeleteWithInstance": true,
				"EnableAutomatedSnapshotPolicy": false,
				"EnableAutoSnapshot": false,
				"AutoSnapshotPolicyId": "sp-bp67acfmxazb4p****",
				"DiskName": "testDiskName",
				"OperationLocks": {
					"OperationLock": []
				},
				"BdfId": "",
				"Portable": false,
				"Type": "system",
				"SerialNumber": "bp18um4r4f2fve2****",
				"CreationTime": "2021-06-07T06:08:54Z",
				"RegionId": "cn-hangzhou",
				"DiskId": "d-bp18um4r4f2fve24****"
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。