DescribeDisks_云服务器 ECS_API文档-阿里云OpenAPI开发者门户

接口说明

请求参数RegionId、ZoneId、DiskIds和InstanceId等都是过滤器的概念，参数间是逻辑与（AND）关系。
请求参数DiskIds是一个 JSON 格式的数组（Array），如果参数为空，则过滤器不起作用，但是DiskIds如果是一个空数组，则视为该过滤器有效，且返回空。
支持 Token 分页查询：通过NextToken设置查询凭证（Token），其取值是上一次调用 DescribeDisks 返回的NextToken参数值，再通过MaxResults设置单页查询的最大条目数。
开启多重挂载特性的云盘可以挂载到多个实例上，您可以根据返回结果的Attachment列表查看云盘涉及的所有挂载信息。

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

流控信息

请求速率为1000/60(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ecs:DescribeDisks	List	Disk acs:ecs:{#regionId}:{#accountId}:disk/{#diskId} Disk acs:ecs:{#regionId}:{#accountId}:disk/*	无	无

请求参数

字段名称	字段详情
RegionIdstring	块存储所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。示例值:cn-hangzhou参考取值来源: DescribeRegions
ZoneIdstring	可用区 ID。示例值:cn-hangzhou-g参考取值来源: DescribeZones
DiskIdsstring	云盘、本地盘或弹性临时盘 ID。一个带有格式的 JSON 数组，最多支持 100 个 ID，用半角逗号（,）隔开。示例值:["d-bp67acfmxazb4p**", "d-bp67acfmxazb4g", … "d-bp67acfmxazb4d**"]参考取值来源: CreateDisk ReplaceSystemDisk
InstanceIdstring	云盘、本地盘或弹性临时盘挂载的实例 ID。示例值:i-bp67acfmxazb4q****参考取值来源: RunInstances StopInstances StartInstances CreateInstance RebootInstances DescribeInstances ModifyManagedInstance RenewReservedInstances DetachInstanceRamRole AttachInstanceRamRole DeregisterManagedInstance PurchaseReservedInstancesOffering
DiskTypestring	要查询的云盘、本地盘或弹性临时盘类型。取值范围：展开详情示例值:all
Categorystring	磁盘种类。取值范围：展开详情示例值:all
Statusstring	磁盘状态。更多信息，请参见云盘状态。取值范围：展开详情示例值:All
SnapshotIdstring	创建云盘时使用的快照 ID。示例值:s-bp67acfmxazb4p****参考取值来源: CopySnapshot CreateSnapshot DescribeSnapshots
Portableboolean	磁盘是否支持卸载。取值范围：展开详情示例值:false
DeleteWithInstanceboolean	磁盘是否设置了随实例释放。取值范围：展开详情示例值:false
DeleteAutoSnapshotboolean	释放云盘时，是否会同时释放自动快照。展开详情示例值:false
PageNumberinteger<int32>	说明该参数即将下线，推荐您使用参数 `NextToken` 与 `MaxResults` 完成分页查询操作。示例值:1取值 >= 1
PageSizeinteger<int32>	说明该参数即将下线，推荐您使用参数 `NextToken` 与 `MaxResults` 完成分页查询操作。示例值:10取值 <= 100
NextTokenstring	查询凭证（Token），取值为上一次调用 API 返回的`NextToken`参数值。展开详情示例值:AAAAAdDWBF2****
MaxResultsinteger<int32>	返回的最大数。取值范围：10~500。展开详情示例值:50取值 <= 500
DiskNamestring	磁盘的名称。长度为 2~128 个字符，支持 Unicode 中 letter 分类下的字符（其中包括英文、中文和数字等）。可以包含半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。示例值:testDiskName
AutoSnapshotPolicyIdstring	根据自动快照策略 ID 查询云盘。示例值:sp-m5e2w2jutw8bv31****参考取值来源: CreateAutoSnapshotPolicy DescribeAutoSnapshotPolicyEx
EnableAutoSnapshotboolean	云盘是否启用自动快照策略功能。展开详情示例值:true
EnableAutomatedSnapshotPolicyboolean	云盘是否设置了自动快照策略。展开详情示例值:false
DiskChargeTypestring	磁盘的计费方式。取值范围：展开详情示例值:PostPaid
LockReasonstring	磁盘被锁定的原因。取值范围：展开详情示例值:recycling
Filter.1.Keystring	查询资源时的筛选键，取值必须为`CreationStartTime`。同时设置`Filter.1.Key`和`Filter.1.Value`可以查询在指定时间点后创建的资源信息。示例值:CreationStartTime
Filter.2.Keystring	查询资源时的筛选键，取值必须为`CreationEndTime`。同时设置`Filter.2.Key`和`Filter.2.Value`可以查询在指定时间点前创建的资源信息。示例值:CreationEndTime
Filter.1.Valuestring	查询资源时的筛选值。指定该参数时必须同时指定`Filter.1.Key`参数，格式为：`yyyy-MM-ddTHH:mmZ`，采用 UTC +0 时区。示例值:2017-12-05T22:40Z
Filter.2.Valuestring	查询资源时的筛选值。指定该参数时必须同时指定`Filter.2.Key`参数，格式为：`yyyy-MM-ddTHH:mmZ`，采用 UTC +0 时区。示例值:2017-12-06T22:40Z
ResourceGroupIdstring	磁盘所在的企业资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。展开详情示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeSnapshotGroups
EnableSharedboolean	是否是共享块存储。示例值:false
Encryptedboolean	是否只筛选出加密云盘。展开详情示例值:false
DryRunboolean	是否只预检此次请求。取值范围：展开详情示例值:false
KMSKeyIdstring	云盘使用的 KMS 密钥 ID。示例值:0e478b7a-4262-4802-b8cb-00d3fb40****参考取值来源: DescribeDiskDefaultKMSKeyId
MultiAttachstring	是否开启了多重挂载特性。取值范围：展开详情示例值:Disabled
Tagarray<object>	磁盘标签列表。子级条数 <= 20
AdditionalAttributesarray<string>	其他属性值列表。目前仅支持传入值为`Placement`，表示查询当前磁盘的数据存放地。展开详情示例值:IOPS子级条数 <= 5

返回参数

字段名称	字段详情
NextTokenstring	本次调用返回的查询凭证值。示例值:AAAAAdDWBF2****
PageSizeinteger<int32>	说明该参数即将下线，推荐您使用参数 `NextToken` 与 `MaxResults` 完成分页查询操作。示例值:1
PageNumberinteger<int32>	说明该参数即将下线，推荐您使用参数 `NextToken` 与 `MaxResults` 完成分页查询操作。示例值:1
RequestIdstring	请求 ID。示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger<int32>	查询结果总条数。示例值:15
Disksobject

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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.	诊断
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	诊断
400	InvalidTagCount	The specified tags are beyond the permitted range.	诊断
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	诊断
400	InvalidZoneId.NotFound	The zoneId provided does not exist in our records.	诊断
400	MissingParamter.RegionId	The regionId should not be null.	诊断
400	InvalidParameter.DiskIds	The specified parameter diskIds is not valid.	诊断
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.	诊断
403	InvalidDiskIds.Malformed	The amount of specified disk Ids exceeds the limit.	诊断
403	InvalidCategory.ValueNotSupported	The specified disk category is not supported.	诊断
403	UserNotInTheWhiteList	The user is not in volume white list.	诊断
403	InvalidParameter.MultiAttachAndEnableSharedNotMatch	The parameter MultiAttach and EnableShared are not match.	诊断
403	InvalidParameter.MultiAttach	The specified param MultiAttach is not valid.	诊断
404	InvalidFilterKey.NotFound	The filter key is not found.	诊断
404	InvalidFilterValue	The filter value is not valid.	诊断
404	InvalidDiskIds.ValueNotSupported	The specified parameter "DiskIds" is not supported.	诊断
404	InvalidDiskChargeType.NotFound	The DiskChargeType does not exist in our records.	诊断
404	InvalidLockReason.NotFound	The specified LockReason is not found.	诊断
500	InternalError	The request processing has failed due to some unknown error.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-05-08	变更错误码404 变更返回参数
	2023-11-24	变更返回参数
	2022-01-21	变更返回参数
	2021-06-03	变更错误码403 新增请求参数MultiAttach 变更返回参数

1
2
10 条/页