DescribeDisks_块存储_API参考_云服务器 ECS_阿里云技术文档

调用DescribeDisks查询一块或多块您已经创建的块存储（包括云盘以及本地盘）。

接口说明

请求参数RegionId、ZoneId、DiskIds和InstanceId等都是过滤器的概念，参数间是逻辑与（AND）关系。
请求参数DiskIds是一个JSON格式的数组（Array），如果参数为空，则过滤器不起作用，但是DiskIds如果是一个空数组，则视为该过滤器有效，且返回空。

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
RegionId	String	是	cn-hangzhou	块存储所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
Action	String	否	DescribeDisks	系统规定参数。取值：DescribeDisks 当您自行通过HTTP/HTTPS URL发起API请求时，`Action`为必选参数。
AdditionalAttributes.N	RepeatList	否	null	其他属性值。说明该参数即将停止使用，为提高代码兼容性，建议您尽量不要使用该参数。
AutoSnapshotPolicyId	String	否	sp-m5e2w2jutw8bv31*****	根据自动快照策略ID查询云盘。
Category	String	否	all	云盘或本地盘种类。取值范围： all：所有云盘以及本地盘 cloud：普通云盘 cloud_efficiency：高效云盘 cloud_ssd：SSD盘 cloud_essd：ESSD云盘 local_ssd_pro：I/O密集型本地盘 local_hdd_pro：吞吐密集型本地盘 ephemeral：（已停售）本地盘 ephemeral_ssd：（已停售）本地SSD盘默认值：all。
DeleteAutoSnapshot	Boolean	否	false	释放云盘时，是否会同时释放自动快照。默认值：false。
DeleteWithInstance	Boolean	否	false	云盘是否设置了随实例释放。取值范围： true：云盘随实例一起释放 false：云盘保留不释放，转为按量付费数据盘而保留下来。默认值：false。
DiskChargeType	String	否	PostPaid	云盘或本地盘的计费方式。取值范围： PrePaid：包年包月 PostPaid：按量付费
DiskIds	String	否	["d-bp67acfmxazb4ph*", "d-bp67acfmxazb4pi", … "d-bp67acfmxazb4pj**"]	云盘或本地盘ID。一个带有格式的JSON数组，最多支持100个ID，用半角逗号（,）隔开。
DiskName	String	否	JoshuaFinance	云盘或本地盘名称。
DiskType	String	否	all	要查询的云盘或本地盘类型。取值范围： all：同时查询系统盘与数据盘 system：只查询系统盘 data：只查询数据盘默认值：all。
DryRun	Boolean	否	false	是否只预检此次请求。取值范围： true：发送检查请求，不会查询资源状况。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码`DryRunOperation`。 false：发送正常请求，通过检查后返回2XX HTTP状态码并直接查询资源状况。默认值：false。
EnableAutomatedSnapshotPolicy	Boolean	否	false	是否查询开启了自动快照策略的云盘。默认值：false。
EnableShared	Boolean	否	false	是否是共享块存储。
Encrypted	Boolean	否	false	是否只筛选出加密云盘。默认值：false。
Filter.1.Key	String	否	CreationStartTime	查询资源时的筛选键。取值必须为CreationStartTime。
Filter.1.Value	String	否	2017-12-05T22:40:00Z	查询资源时的筛选值。取值必须为资源创建的开始时间点（CreationStartTime）。
Filter.2.Key	String	否	CreationEndTime	查询资源时的筛选键。取值必须为CreationEndTime。
Filter.2.Value	String	否	2017-12-06T22:40:00Z	查询资源时的筛选值。取值必须为资源创建的结束时间点（CreationEndTime）。
InstanceId	String	否	i-bp67acfmxazb4ph***	云盘或本地盘挂载的实例ID。
KMSKeyId	String	否	0e478b7a-4262-4802-b8cb-00d3fb408***	云盘使用的KMS密钥ID。
LockReason	String	否	recycling	云盘或本地盘被锁定的原因。取值范围： financial：因欠费被锁定 security：因安全原因被锁定 recycling：抢占式实例的待释放锁定状态 dedicatedhostfinancial：因为专有宿主机欠费导致ECS实例被锁定
PageNumber	Integer	否	1	云盘或本地盘状态列表的页码。起始值：1。默认值：1。
PageSize	Integer	否	10	分页查询时设置的每页行数。最大值：100。默认值：10。
Portable	Boolean	否	false	云盘或本地盘是否支持卸载。取值范围： true：支持。可以独立存在，且可以在可用区内自由挂载和卸载。 false：不支持。不可以独立存在，且不可以在可用区内自由挂载和卸载。以下类型块存储的`Portable`属性都为`false`，生命周期与实例等同：本地盘本地SSD盘系统盘包年包月数据盘
ResourceGroupId	String	否	rg-bp67acfmxazb4ph***	云盘或本地盘所在的企业资源组ID。
SnapshotId	String	否	s-bp67acfmxazb4ph***	创建云盘时使用的快照ID。
Status	String	否	All	云盘状态，详情参见云盘状态。取值范围： In_use Available Attaching Detaching Creating ReIniting All 默认值：All。
Tag.N.Key	String	否	FinanceJoshua	云盘或本地盘的标签键。N的取值范围：1~20。
Tag.N.Value	String	否	FinanceDept	云盘或本地盘的标签值。N的取值范围：1~20。
Tag.N.key	String	否	null	云盘或本地盘的标签键。说明为提高代码兼容性，请尽量使用Tag.N.Key参数。
Tag.N.value	String	否	null	云盘或本地盘的标签值。说明为提高代码兼容性，请尽量使用Tag.N.Value参数。
ZoneId	String	否	cn-hangzhou-g	可用区ID。

返回数据


名称	类型	示例值	描述
Disks	Array		云盘或本地盘信息组成的集合。
Disk			云盘或本地盘信息组成的集合。
AttachedTime	String	2018-01-01T01:04:22Z	挂载时间。按照ISO8601标准表示，使用UTC+0时间。格式为：yyyy-MM-ddThh:mmZ。该参数值仅在`Status`参数值为`Available`时才有意义。
AutoSnapshotPolicyId	String	sp-bp67acfmxazb4ph***	云盘采用的自动快照策略ID。
Category	String	cloud_ssd	云盘或本地盘种类。可能值： cloud：普通云盘 cloud_efficiency：高效云盘 cloud_ssd：SSD盘 cloud_essd：ESSD云盘 local_ssd_pro：I/O密集型本地盘 local_hdd_pro：吞吐密集型本地盘 ephemeral：（已停售）本地盘 ephemeral_ssd：（已停售）本地SSD盘
CreationTime	String	2018-01-01T01:01:22Z	创建时间。
DeleteAutoSnapshot	Boolean	false	是否同时删除自动快照。可能值： true：删除云盘上的快照。 false：保留云盘上的快照。通过CreateSnapshot或者在控制台创建的快照，不受这个参数的影响，会始终保留。
DeleteWithInstance	Boolean	true	是否随实例释放。可能值： true：释放实例时，这块云盘随实例一起释放。 false：释放实例时，这块云盘保留不释放。
Description	String	FinanceDept	云盘或本地盘描述。
DetachedTime	String	2018-01-08T01:01:22Z	卸载时间。该参数值仅在`Status`参数值为`Available`时才有意义。
Device	String	/dev/xvdb	云盘或本地盘挂载的实例的设备名，例如/dev/xvdb。该参数仅在`Status`参数值为`In_use`时才有值，其他状态时为空。说明该参数即将停止使用，为提高代码兼容性，建议您尽量不要使用该参数。
DiskChargeType	String	PostPaid	云盘或本地盘的计费方式。可能值： PrePaid：包年包月。 PostPaid：按量付费。
DiskId	String	d-bp18um4r4f2fve242***	云盘或本地盘ID。
DiskName	String	FinanceDeptJoshua	云盘或本地盘名称。
EnableAutomatedSnapshotPolicy	Boolean	false	云盘是否执行自动快照策略。
Encrypted	Boolean	false	是否为加密云盘。
ExpiredTime	String	2018-01-10T01:01:22Z	包年包月云盘的过期时间。
IOPS	Integer	4000	每秒读写（I/O）操作的次数，单位：次/s。
IOPSRead	Integer	2000	每秒读操作的次数，单位：次/s。
IOPSWrite	Integer	2000	每秒写操作的次数，单位：次/s。
ImageId	String	m-bp13aqm171qynt3u***	创建ECS实例时使用的镜像ID，只有通过镜像创建的云盘才有值，否则为空。这个值在云盘的生命周期内始终不变。
InstanceId	String	i-bp1j4i2jdf3owlheb***	云盘或本地盘挂载的实例ID。该参数值仅在`Status`参数值为`In_use`时才有值，其他状态时为空。
KMSKeyId	String	0e478b7a-4262-4802-b8cb-00d3fb408***	云盘使用的KMS密钥ID。
MountInstanceNum	Integer	1	共享存储挂载的实例数量。
MountInstances	Array		挂载到实例上的信息集合。
MountInstance			挂载到实例上的信息集合。
AttachedTime	String	2017-12-05T2340:00Z	挂载时间。按照ISO8601标准表示，使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。
Device	String	/dev/xvda	云盘或本地盘的挂载点。
InstanceId	String	i-bp1j4i2jdf3owlheb***	云盘或本地盘挂载的实例ID。
OperationLocks	Array		云盘或本地盘锁定原因类型。
OperationLock			云盘或本地盘锁定原因类型。
LockReason	String	security	云盘或本地盘被安全锁定的原因。
PerformanceLevel	String	PL2	ESSD云盘的性能等级。可能值： PL1：单盘最高随机读写IOPS 5万。 PL2：单盘最高随机读写IOPS 10万。 PL3：单盘最高随机读写IOPS 100万。
Portable	Boolean	false	云盘是否可卸载。
ProductCode	String	jxsc000204	云市场的商品标识。
RegionId	String	cn-hangzhou	云盘或本地盘所属的地域ID。
ResourceGroupId	String	rg-bp67acfmxazb4ph***	云盘或本地盘所在的企业资源组ID。
Size	Integer	2000	云盘或本地盘大小，单位GiB。
SourceSnapshotId	String	s-bp67acfmxazb4ph***	创建云盘使用的快照ID。如果创建云盘时，没有指定快照，则该参数值为空。该参数值在云盘的生命周期内始终不变。
Status	String	Available	云盘状态。可能值： In_use Available Attaching Detaching Creating ReIniting
Tags	Array		云盘或本地盘的标签集合。
Tag			云盘或本地盘的标签集合。
TagKey	String	FinanceJoshua	标签键。
TagValue	String	FinanceDept	标签值。
Type	String	data	云盘或本地盘类型。可能值： system：系统盘。 data：数据盘。
ZoneId	String	cn-hangzhou-g	云盘或本地盘所属的可用区ID。
PageNumber	Integer	1	云盘或本地盘列表的页码。
PageSize	Integer	1	输入时设置的每页行数。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	请求ID。
TotalCount	Integer	76	查询结果总条数。

示例

请求示例

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

正常返回示例

XML 格式

<DescribeDisksResponse>
      <PageNumber>1</PageNumber>
      <TotalCount>76</TotalCount>
      <PageSize>1</PageSize>
      <RequestId>C74847CB-9B69-4360-9969-3595F2B6B9C1</RequestId>
      <Disks>
            <Disk>
                  <DiskChargeType>PostPaid</DiskChargeType>
                  <ImageId>centos_7_06_64_20G_alibase_20190711.vhd</ImageId>
                  <Device>/dev/xvda</Device>
                  <DetachedTime></DetachedTime>
                  <Type>system</Type>
                  <InstanceId>i-bp1j4i2jdf3owlheb***</InstanceId>
                  <Encrypted>false</Encrypted>
                  <ZoneId>cn-hangzhou-f</ZoneId>
                  <EnableAutoSnapshot>true</EnableAutoSnapshot>
                  <AttachedTime>2019-11-11T08:35:32Z</AttachedTime>
                  <PerformanceLevel></PerformanceLevel>
                  <SourceSnapshotId></SourceSnapshotId>
                  <DeleteAutoSnapshot>false</DeleteAutoSnapshot>
                  <KMSKeyId></KMSKeyId>
                  <Size>40</Size>
                  <Description></Description>
                  <BdfId></BdfId>
                  <ProductCode></ProductCode>
                  <Portable>false</Portable>
                  <EnableAutomatedSnapshotPolicy>false</EnableAutomatedSnapshotPolicy>
                  <ResourceGroupId></ResourceGroupId>
                  <DiskName></DiskName>
                  <StorageSetId></StorageSetId>
                  <AutoSnapshotPolicyId></AutoSnapshotPolicyId>
                  <CreationTime>2019-11-11T08:35:29Z</CreationTime>
                  <MountInstances>
            </MountInstances>
                  <Status>In_use</Status>
                  <Tags>
                        <Tag>
                              <TagValue>FinanceDept</TagValue>
                              <TagKey>FinanceJoshua</TagKey>
                        </Tag>
                  </Tags>
                  <Category>cloud_efficiency</Category>
                  <RegionId>cn-hangzhou</RegionId>
                  <DeleteWithInstance>true</DeleteWithInstance>
                  <OperationLocks>
            </OperationLocks>
                  <ExpiredTime>2999-09-08T16:00Z</ExpiredTime>
                  <DiskId>d-bp18um4r4f2fve242***</DiskId>
            </Disk>
      </Disks>
</DescribeDisksResponse>

JSON 格式

{
	"PageNumber":1,
	"TotalCount":76,
	"PageSize":1,
	"RequestId":"C74847CB-9B69-4360-9969-3595F2B6B9C1",
	"Disks":{
		"Disk":[
			{
				"DiskChargeType":"PostPaid",
				"ImageId":"centos_7_06_64_20G_alibase_20190711.vhd",
				"Device":"/dev/xvda",
				"DetachedTime":"",
				"Type":"system",
				"InstanceId":"i-bp1j4i2jdf3owlheb***",
				"Encrypted":false,
				"EnableAutoSnapshot":true,
				"ZoneId":"cn-hangzhou-f",
				"AttachedTime":"2019-11-11T08:35:32Z",
				"PerformanceLevel":"",
				"SourceSnapshotId":"",
				"DeleteAutoSnapshot":false,
				"KMSKeyId":"",
				"Size":40,
				"Description":"",
				"BdfId":"",
				"ProductCode":"",
				"Portable":false,
				"EnableAutomatedSnapshotPolicy":false,
				"ResourceGroupId":"",
				"DiskName":"",
				"StorageSetId":"",
				"AutoSnapshotPolicyId":"",
				"CreationTime":"2019-11-11T08:35:29Z",
				"Tags":{
					"Tag":[
						{
							"TagValue":"FinanceDept",
							"TagKey":"FinanceJoshua"
						}
					]
				},
				"Status":"In_use",
				"MountInstances":{
					"MountInstance":[]
				},
				"Category":"cloud_efficiency",
				"RegionId":"cn-hangzhou",
				"DeleteWithInstance":true,
				"OperationLocks":{
					"OperationLock":[]
				},
				"ExpiredTime":"2999-09-08T16:00Z",
				"DiskId":"d-bp18um4r4f2fve242***"
			}
		]
	}
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidDiskType.ValueNotSupported	The specified disk type is not supported.	指定的磁盘属性不支持。
400	InvalidCategory.ValueNotSupported	The specified disk category is not supported.	不支持指定的磁盘种类。
400	InvalidStatus.ValueNotSupported	The specified disk status is not supported.	指定的磁盘状态不支持此类操作。
403	InvalidDiskIds.Malformed	The amount of specified disk Ids exceeds the limit.	指定的磁盘ID格式不正确。
404	InvalidDiskChargeType.NotFound	The DiskChargeType does not exist in our records	指定的磁盘类型不存在。
404	InvalidLockReason.NotFound	The specified LockReason is not found	指定的锁定类型不存在。
404	InvalidFilterKey.NotFound		指定的起始时间或到期时间参数错误。
404	InvalidFilterValue		您输了的时间格式不合法。
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	指定的 Tag.n.Key 和 Tag.n.Value 不匹配。
400	InvalidTagCount	The specified tags are beyond the permitted range.	指定的标记超出取值范围。
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	RegionId参数不合法
500	InternalError	The request processing has failed due to some unknown error.	内部错误，请重试。如果多次尝试失败，请提交工单。
400	InvalidZoneId.NotFound	The zoneId provided does not exist in our records.	指定的可用区 ID 不存在。
400	MissingParamter.RegionId	The regionId should not be null.	参数 RegionId 不得为空。
400	InvalidParameter.DiskIds	The specified parameter diskIds is not valid.	指定的参数diskIds无效。
400	IncompleteParamter	Some fields can not be null in this request.	请求中缺失参数。
400	InvalidParamter	Some parameters are invalid in this request.	请求中包含非法参数。
400	InvalidSnapshot.NotFound	The specified parameter SnapshotId is not valid.	指定的 SnapshotId 不合法。
403	UserNotInTheWhiteList	The user is not in volume white list.	用户不在共享块存储白名单中，请您提交工单申请白名单。
404	InvalidDiskIds.ValueNotSupported	The specified parameter "DiskIds" is not supported.	指定的磁盘ID无效。

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

DescribeDisks_块存储_API参考_云服务器 ECS

DescribeDisks

接口说明

调试

请求参数

返回数据

示例

错误码

版权声明

评论