305
微信
查询磁盘__磁盘相关接口_API 参考_云服务器 ECS-阿里云
描述
下面的参数中,RegionId
,ZoneId
,DiskIds
,InstanceId
,… 等参数都是过滤器的概念,参数间是逻辑与关系。其中 DiskIds
是一个 Json 格式的 Json Array,格式如下。
如果参数为空,则过滤器不起作用,但是 DiskIds
如果是一个空 Json Array(即[]
),则视为该过滤器有效,且返回空。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 系统规定参数,取值:DescribeDisks |
RegionId | String | 是 | 磁盘所属于的 Region ID |
ZoneId | String | 否 | 默认值为空,空代表查询所有可用区下的磁盘。 |
DiskIds | String | 否 |
磁盘 ID 一个带有格式的 Json Array:[“d-xxxxxxxxx”, ”d-yyyyyyyyy”, … “d-zzzzzzzzz”],最多 100 个 Id,用半角逗号字符隔开。 |
InstanceId | String | 否 | 实例 ID |
DiskType | String | 否 | all | system | data,默认值为 all。 |
Category | String | 否 | 磁盘种类 all | cloud | cloud_efficiency | cloud_ssd | ephemeral | ephemeral_ssd。默认值为all |
Status | String | 否 | 磁盘状态 In_use | Available | Attaching | Detaching | Creating | ReIniting | All,默认值为 All。 |
SnapshotId | String | 否 | 创建磁盘使用的快照 |
DiskName | String | 否 | 磁盘名称 |
Portable | String | 否 |
磁盘是否支持卸载:
本地磁盘,本地SSD盘 和 普通云盘,高效云盘和SSD云盘的系统盘 和 包月的普通云盘,高效云盘,SSD云盘,该属性都为 false。 这个属性用户不能更改。 |
DeleteWithInstance | String | 否 | 磁盘是否随实例释放:
|
DeleteAutoSnapshot | String | 否 | 删除磁盘时,是否同时删除自动快照。
|
EnableAutoSnapshot | String | 否 |
磁盘是否执行自动快照策略(前提是用户整体的自动快照策略已经开启):
|
DiskChargeType | String | 否 |
磁盘的付费方式。
|
Tag.n.Key | String | 否 |
标签 key,n 从 1 开始,最大为 5。 不允许为空字符串。 |
Tag.n.Value | String | 否 |
标签 value,n 从 1 开始,最大为 5。 允许为空字符串。 |
PageNumber | Integer | 否 | 磁盘状态列表的页码,起始值为 1,默认值为 1 |
PageSize | Integer | 否 | 分页查询时设置的每页行数,最大值 100 行,默认为 10 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
RegionId | String | 镜像所属地域 Id |
TotalCount | Integer | 磁盘总个数 |
PageNumber | Integer | 磁盘列表的页码 |
PageSize | Integer | 输入时设置的每页行数 |
Disks | DiskItemType | 磁盘信息 DiskItemType 组成的集合 |
错误码
错误代码 | 描述 | Http 状态码 | 语义 |
---|---|---|---|
MissingParameter | The input parameter "RegionId" that is mandatory for processing this request is not supplied. | 400 | RegionId 参数未指定 |
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 | 指定的磁盘状态不支持 |
InvalidParameter | The specified parameter ""Portable"" is not valid. | 400 | 指定的 Portable 参数不合法 |
InvalidParameter | The specified parameter ""DeleteWithInstance"" is not valid. | 400 | 指定的 DeleteWithInstance 参数不合法 |
InvalidParameter | The specified parameter ""DeleteAutoSnapshot"" is not valid. | 400 | 指定的 DeleteAutoSnapshot 参数不合法 |
InvalidParameter | The specified parameter ""PageNumber"" is not valid. | 400 | 指定的 PageNumber 参数不合法 |
InvalidParameter | The specified parameter ""PageSize"" is not valid. | 400 | 指定的 PageSize 参数不合法 |
InvalidDiskIds.Malformed | The amount of specified disk Ids exceeds the limit. | 403 | 指定的 DiskId 格式不正确 |
InvalidDiskChargeType.NotFound | The DiskChargeType does not exist in our records | 404 | 指定的 DiskChargeType 不存在 |
示例
请求示例
https://ecs.aliyuncs.com/?action=DescribeDisks
&RegionId=cn-qingdao
&PageNumber=1
&ZoneId=cn-qingdao-b
&<公共请求参数>
返回示例
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
}
最后更新:2016-11-23 16:03:50
上一篇:
创建磁盘__磁盘相关接口_API 参考_云服务器 ECS-阿里云
下一篇:
挂载磁盘__磁盘相关接口_API 参考_云服务器 ECS-阿里云
如何升级 Redis 版本?__FAQ_云数据库 Redis 版-阿里云
安骑士__安全防护_产品使用手册_云解析-阿里云
ZoneType__数据类型_API 参考_云服务器 ECS-阿里云
JAVA-SDK使用(CCP)__SDK使用参考_设备端接入手册_阿里云物联网套件-阿里云
支持的服务列表__产品简介_操作审计-阿里云
TXC for EDAS 快速入门__TXC for EDAS_二方服务_企业级分布式应用服务 EDAS-阿里云
服务区域__使用手册_媒体转码-阿里云
创建大盘__定制大盘_用户指南_业务实时监控服务 ARMS-阿里云
资源列表__RAM子用户访问_API-Reference_日志服务-阿里云
查询磁盘__磁盘相关接口_API 参考_云服务器 ECS-阿里云
相关内容
常见错误说明__附录_大数据计算服务-阿里云
发送短信接口__API使用手册_短信服务-阿里云
接口文档__Android_安全组件教程_移动安全-阿里云
运营商错误码(联通)__常见问题_短信服务-阿里云
设置短信模板__使用手册_短信服务-阿里云
OSS 权限问题及排查__常见错误及排除_最佳实践_对象存储 OSS-阿里云
消息通知__操作指南_批量计算-阿里云
设备端快速接入(MQTT)__快速开始_阿里云物联网套件-阿里云
查询API调用流量数据__API管理相关接口_API_API 网关-阿里云
使用STS访问__JavaScript-SDK_SDK 参考_对象存储 OSS-阿里云