调用DescribeDisks查询一块或多块已经创建的块存储(包括云盘以及本地盘)。
接口说明
- 请求参数
RegionId
、ZoneId
、DiskIds
和InstanceId
等都是过滤器的概念,参数间是逻辑与(AND)关系。 - 请求参数
DiskIds
是一个JSON格式的数组(Array),如果参数为空,则过滤器不起作用,但是DiskIds
如果是一个空数组,则视为该过滤器有效,且返回空。 - 支持以下两种方式查看返回数据:
- 方式一:通过
NextToken
设置查询凭证(Token),其取值是上一次调用DescribeDisks返回的NextToken
参数值,再通过MaxResults
设置单页查询的最大条目数。 -
方式二:通过
PageSize
设置单页返回的条目数,再通过PageNumber
设置页码。以上两种方式只能任选其中之一。当返回的条目数较多时,推荐使用方式一。如果设置了
NextToken
,则请求参数PageSize
和PageNumber
将失效,且返回数据中的TotalCount
无效。
- 方式一:通过
- 开启多重挂载特性的云盘可以挂载到多个实例上,您可以根据返回结果的
Attachment
列表查看云盘涉及的所有挂载信息。
通过阿里云CLI调用API时,不同数据类型的请求参数取值必须遵循格式要求。更多信息,请参见CLI参数格式说明。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | DescribeDisks |
系统规定参数。取值:DescribeDisks。 |
RegionId | String | 是 | cn-hangzhou |
块存储所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
ZoneId | String | 否 | cn-hangzhou-g |
可用区ID。 |
DiskIds | String | 否 | [“d-bp67acfmxazb4p****”, “d-bp67acfmxazb4g****”, … “d-bp67acfmxazb4d****”] |
云盘或本地盘ID。一个带有格式的JSON数组,最多支持100个ID,用半角逗号(,)隔开。 |
InstanceId | String | 否 | i-bp67acfmxazb4q**** |
云盘或本地盘挂载的实例ID。 |
DiskType | String | 否 | all |
要查询的云盘或本地盘类型。取值范围:
默认值:all。 |
Category | String | 否 | all |
云盘或本地盘种类。取值范围:
默认值:all。 ESSD AutoPL云盘正在邀测中,邀测地域支持华东6(乌兰察布)和华南2(河源)。如需使用,请前往邀测页面申请。 |
Status | String | 否 | All |
云盘状态。更多信息,请参见云盘状态。取值范围:
默认值:All。 |
SnapshotId | String | 否 | s-bp67acfmxazb4p**** |
创建云盘时使用的快照ID。 |
Portable | Boolean | 否 | false |
云盘或本地盘是否支持卸载。取值范围:
以下类型块存储的
|
DeleteWithInstance | Boolean | 否 | false |
云盘是否设置了随实例释放。取值范围:
默认值:false。 |
DeleteAutoSnapshot | Boolean | 否 | false |
释放云盘时,是否会同时释放自动快照。
默认值:false。 |
PageNumber | Integer | 否 | 1 |
云盘或本地盘状态列表的页码。 起始值:1。 默认值:1。 |
PageSize | Integer | 否 | 10 |
分页查询时设置的每页行数。 最大值:100。 默认值:10。 |
NextToken | String | 否 | AAAAAdDWBF2**** |
查询凭证(Token),取值为上一次API调用返回的 有关本接口查看返回数据的设置方式,请参见上文接口说明。 |
MaxResults | Integer | 否 | 50 |
返回的最大数。取值范围:10~500。 默认值:
|
DiskName | String | 否 | testDiskName |
云盘或本地盘名称。 |
AutoSnapshotPolicyId | String | 否 | sp-m5e2w2jutw8bv31**** |
根据自动快照策略ID查询云盘。 |
EnableAutoSnapshot | Boolean | 否 | true |
云盘是否启用自动快照策略功能。
说明 创建后的云盘默认启用自动快照策略功能,您只需要为云盘绑定自动快照策略即可正常使用。 |
EnableAutomatedSnapshotPolicy | Boolean | 否 | false | 云盘是否设置了自动快照策略。
默认值:false。 |
DiskChargeType | String | 否 | PostPaid |
云盘或本地盘的计费方式。取值范围:
|
LockReason | String | 否 | recycling |
云盘或本地盘被锁定的原因。取值范围:
|
Filter.1.Key | String | 否 | CreationStartTime |
查询资源时的筛选键,取值必须为 |
Filter.2.Key | String | 否 | CreationEndTime |
查询资源时的筛选键,取值必须为 |
Filter.1.Value | String | 否 | 2017-12-05T22:40Z |
查询资源时的筛选值。指定该参数时必须同时指定 |
Filter.2.Value | String | 否 | 2017-12-06T22:40Z |
查询资源时的筛选值。指定该参数时必须同时指定 |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4p**** |
云盘或本地盘所在的企业资源组ID。使用该参数过滤资源时,资源数量不能超过1000个。 说明 不支持默认资源组过滤。 |
EnableShared | Boolean | 否 | false | 是否是共享块存储。 |
Encrypted | Boolean | 否 | false |
是否只筛选出加密云盘。
默认值:false。 |
DryRun | Boolean | 否 | false |
是否只预检此次请求。取值范围:
默认值:false。 |
KMSKeyId | String | 否 | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
云盘使用的KMS密钥ID。 |
MultiAttach | String | 否 | Disabled |
是否开启了多重挂载特性。取值范围:
多重挂载功能正在邀测中,如需使用,请提交工单。 |
Tag.N.key | String | 否 | null |
云盘或本地盘的标签键。 说明 为提高代码兼容性,请尽量使用Tag.N.Key参数。 |
Tag.N.Key | String | 否 | TestKey | 云盘或本地盘的标签键。N的取值范围:1~20。 使用一个标签过滤资源,查询到该标签下的资源数量不能超过1000个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个,请使用ListTagResources接口进行查询。 |
Tag.N.Value | String | 否 | TestValue |
云盘或本地盘的标签值。N的取值范围:1~20。 |
Tag.N.value | String | 否 | null |
云盘或本地盘的标签值。 说明 为提高代码兼容性,请尽量使用Tag.N.Value参数。 |
AdditionalAttributes.N | String | 否 | IOPS | 其他属性值。目前仅支持传入值为IOPS,表示查询当前磁盘的IOPS上限。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
NextToken | String | AAAAAdDWBF2**** |
本次调用返回的查询凭证值。 |
PageSize | Integer | 1 |
输入时设置的每页行数。 |
PageNumber | Integer | 1 |
云盘或本地盘列表的页码。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID。 |
TotalCount | Integer | 15 |
查询结果总条数。 |
Disks | Array of Disk |
云盘或本地盘信息组成的集合。 |
|
Disk | |||
SerialNumber | String | bp18um4r4f2fve2**** |
云盘或本地盘的序列号。 |
CreationTime | String | 2021-06-07T06:08:54Z |
创建时间。 |
Status | String | In_use |
云盘状态。可能值:
|
Type | String | system |
云盘或本地盘类型。可能值:
|
PerformanceLevel | String | PL0 |
ESSD云盘的性能等级。可能值:
|
BdfId | String | null |
该参数正在邀测中,暂未开放使用。 |
EnableAutoSnapshot | Boolean | false |
云盘是否启用自动快照策略功能。 |
StorageSetId | String | ss-i-bp1j4i2jdf3owlhe**** |
存储集ID。 |
StorageSetPartitionNumber | Integer | 11 |
存储集中的最大分区数量。 |
DiskId | String | d-bp18um4r4f2fve24**** |
云盘或本地盘ID。 |
DeleteAutoSnapshot | Boolean | false |
是否同时删除自动快照。可能值:
通过CreateSnapshot或者在控制台创建的快照,不受这个参数的影响,会始终保留。 |
StorageClusterId | String | dbsc-j5e1sf2vaf5he8m2**** |
云盘所属的专属块存储集群ID。如果您的云盘在公共云块存储集群中,则该返回值为空。 |
Encrypted | Boolean | false |
是否为加密云盘。 |
IOPSRead | Integer | 2000 |
每秒读操作的次数上限,单位:次/s。 |
MountInstanceNum | Integer | 1 |
共享存储挂载的实例数量。 |
Description | String | testDescription |
云盘或本地盘描述。 |
Device | String | /dev/xvdb |
云盘或本地盘挂载的实例的设备名,例如/dev/xvdb。您需要注意:
说明 该参数即将停止使用,为提高代码兼容性,建议您尽量不要使用该参数。 |
DiskName | String | testDiskName | 云盘或本地盘名称。 |
Portable | Boolean | false |
云盘或本地盘是否可卸载。 |
ImageId | String | m-bp13aqm171qynt3u*** |
创建ECS实例时使用的镜像ID,只有通过镜像创建的云盘才有值,否则为空。这个值在云盘的生命周期内始终不变。 |
KMSKeyId | String | 0e478b7a-4262-4802-b8cb-00d3fb408*** |
云盘使用的KMS密钥ID。 |
DeleteWithInstance | Boolean | true |
是否随实例释放。可能值:
|
DetachedTime | String | 2021-06-07T21:01:22Z |
该云盘最后一次卸载时间。 |
SourceSnapshotId | String | s-bp67acfmxazb4p**** |
创建云盘使用的快照ID。 如果创建云盘时,没有指定快照,则该参数值为空。该参数值在云盘的生命周期内始终不变。 |
AutoSnapshotPolicyId | String | sp-bp67acfmxazb4p**** |
云盘采用的自动快照策略ID。 |
EnableAutomatedSnapshotPolicy | Boolean | false |
云盘是否设置了自动快照策略。 |
IOPSWrite | Integer | 2000 |
每秒写操作的次数上限,单位:次/s。 |
InstanceId | String | i-bp67acfmxazb4q**** |
云盘或本地盘挂载的实例ID。您需要注意:
|
IOPS | Integer | 4000 |
每秒读写(I/O)操作的次数上限,单位:次/s。 |
RegionId | String | cn-hangzhou |
云盘或本地盘所属的地域ID。 |
ExpiredTime | String | 2021-07-07T16:00Z |
包年包月云盘的过期时间。 |
Size | Integer | 60 |
云盘或本地盘大小,单位GiB。 |
ResourceGroupId | String | rg-bp67acfmxazb4p**** |
云盘或本地盘所在的企业资源组ID。 |
DiskChargeType | String | PrePaid |
云盘或本地盘的计费方式。可能值:
|
ZoneId | String | cn-hangzhou-i |
云盘或本地盘所属的可用区ID。 |
AttachedTime | String | 2021-06-07T06:08:56Z |
该云盘最后一次挂载的时间。按照ISO8601标准表示,使用UTC+0时间。格式为:yyyy-MM-ddThh:mmZ。 |
Category | String | cloud_ssd |
云盘或本地盘种类。可能值:
|
ProductCode | String | jxsc000204 |
云市场的商品标识。 |
MultiAttach | String | Disabled |
云盘是否开启了多重挂载特性。 |
OperationLocks | Array of OperationLock |
云盘或本地盘锁定原因类型。 |
|
OperationLock | |||
LockReason | String | security |
云盘或本地盘被安全锁定的原因。 |
MountInstances | Array of MountInstance |
共享存储挂载到实例上的信息集合。 |
|
MountInstance | |||
AttachedTime | String | 2017-12-05T2340:00Z |
挂载时间。按照ISO 8601标准表示,使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
InstanceId | String | i-bp1j4i2jdf3owlhe**** |
云盘或本地盘挂载的实例ID。 |
Device | String | /dev/xvda |
云盘或本地盘的挂载点。 |
Tags | Array of Tag |
云盘或本地盘的标签集合。 |
|
Tag | |||
TagValue | String | TestValue |
标签值。 |
TagKey | String | TestKey |
标签键。 |
Attachments | Array of Attachment |
云盘所涉及的挂载信息。由 |
|
Attachment | |||
InstanceId | String | i-bp67acfmxazb4q**** |
所挂载的实例ID。 |
Device | String | /dev/xvda |
设备名称。 |
AttachedTime | String | 2021-06-07T06:08:56Z |
挂载的时间,以UTC +0时间为准。 |
ProvisionedIops | Long | 40000 |
ESSD AutoPL云盘预配置的读写IOPS。可能值:0~min{50000, 1000*容量-基准性能}。 基准性能=min{1,800+50*容量, 50,000}。 当 |
BurstingEnabled | Boolean | false |
是否开启Burst(性能突发)。可能值:
当 |
Throughput | Integer | 100 |
单位时间内可以成功传输的数据数量,单位:MB/s。 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeDisks
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
15
AAAAAdDWBF2****
1
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
1
cloud_ssd
testDescription
false
40
false
PrePaid
Disabled
2021-06-07T06:08:56Z
i-bp67acfmxazb4q****
/dev/xvda
2021-07-07T16:00Z
m-bp13aqm171qynt3u***
In_use
2021-06-07T06:08:56Z
dbsc-j5e1sf2vaf5he8m2****
cn-hangzhou-i
i-bp67acfmxazb4q****
PL0
/dev/xvdb
true
false
false
sp-bp67acfmxazb4p****
testDiskName
false
system
bp18um4r4f2fve2****
2021-06-07T06:08:54Z
cn-hangzhou
d-bp18um4r4f2fve24****
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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/xvdb",
"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****"
} ]
}
}
错误码
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. | 指定的磁盘状态不支持此类操作。 |
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 参数不合法。 |
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 | InvalidDiskIds.Malformed | The amount of specified disk Ids exceeds the limit. | 指定的磁盘 ID 格式不正确。 |
403 | UserNotInTheWhiteList | The user is not in volume white list. | 用户不在共享块存储白名单中,请您提交工单申请白名单。 |
403 | InvalidParameter.MultiAttachAndEnableSharedNotMatch | The parameter MultiAttach and EnableShared are not match. | 设置的 MultiAttach 参数和 EnableShared 参数的值不兼容。 |
403 | InvalidParameter.MultiAttach | The specified param MultiAttach is not valid. | MultiAttach 参数的取值有误。 |
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. | 内部错误,请重试。 |
访问错误中心查看更多错误码。
腾讯云1折,限时活动,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/151527.html