全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
云服务器 ECS

DescribeDisks

更新时间:2017-11-01 13:58:27

描述

RegionIdZoneIdDiskIdsInstanceId 等参数都是过滤器的概念,参数间是逻辑与(AND)关系。

其中,DiskIds 是一个 JSON 格式的 Json Array,如果参数为空,则过滤器不起作用,但是 DiskIds 如果是一个空 Json Array(即[]),则视为该过滤器有效,且返回空。

请求参数

名称 类型 是否必需 描述
Action String 系统规定参数。取值:DescribeDisks
RegionId String 磁盘所属于的 Region ID。
Encrypted Boolean 过滤加密磁盘。取值范围:
  • true:只筛选出加密磁盘。
  • false:不做加密属性的筛选。
默认值:false
ZoneId String 可用区 ID。默认值:空。
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:SSD 云盘
  • ephemeral:本地磁盘
  • ephemeral_ssd:本地 SSD 盘
默认值:all
Status String 磁盘状态,参考文档普通云盘状态表。取值范围:
  • In_use
  • Available
  • Attaching
  • Detaching
  • Creating
  • ReIniting
  • All
默认值:All
SnapshotId String 创建磁盘使用的快照。
DiskName String 磁盘名称。
Portable String 磁盘是否支持卸载。这个属性用户不能更改。取值范围:
  • true:可卸载云盘,可以独立存在且可以自由在可用区内挂载和卸载。
  • false:不可卸载云盘,不可以独立存在且不可以自由在可用区内挂载和卸载。
这个属性为 true 的磁盘才能挂载(attach)和卸载(detach)。
其中:
  • 本地磁盘
  • 本地 SSD 盘
  • 普通云盘,高效云盘和 SSD 云盘的系统盘
  • 包年包月的普通云盘、高效云盘、SSD云盘
该属性都为 false。
DeleteWithInstance String 磁盘是否随实例释放。取值范围:
  • true:实例释放时,这块磁盘随 Instance 一起释放。
  • false:实例释放时,这块磁盘保留不释放。
默认值:false
DeleteAutoSnapshot String 删除磁盘时,是否同时删除自动快照。取值范围:
  • true:同时删除自动快照。
  • false:保留自动快照。
默认值:false
EnableAutoSnapshot String 磁盘是否执行自动快照策略(前提是用户整体的自动快照策略已经开启)。取值范围:
  • true:表示这块磁盘执行自动快照策略。
  • false:表示这块磁盘不执行自动快照策略。
默认值:false
DiskChargeType String 磁盘的付费方式。取值范围:
  • PrePaid:预付费,即包年包月。
  • PostPaid:后付费,即按量付费。
Tag.n.Key String 标签键,n 的取值范围为 [1, 5]。
不允许为空字符串。
Tag.n.Value String 标签值,n 的取值范围为 [1, 5]。
允许为空字符串。
PageNumber Integer 磁盘状态列表的页码,起始值为 1。
默认值: 1
PageSize Integer 分页查询时设置的每页行数,最大值 100 行。
默认值: 10

返回参数

名称 类型 描述
Encrypted Boolean 是否为加密磁盘
TotalCount Integer 磁盘总个数
PageNumber Integer 磁盘列表的页码
PageSize Integer 输入时设置的每页行数
Disks DiskItemType 磁盘信息 DiskItemType 组成的集合

错误码

错误代码 描述 HTTP 状态码 语义
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 指定的磁盘状态不支持。
InvalidDiskIds.Malformed The amount of specified disk Ids exceeds the limit. 403 指定的 DiskId 格式不正确。
InvalidDiskChargeType.NotFound The DiskChargeType does not exist. 404 指定的 DiskChargeType 不存在。
InvalidLockReason.NotFound The specified LockReason is not found 404 指定的 LockReason 不存在。
InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. 400 指定的 Tag.n.Key 和 Tag.n.Value 不匹配。
InvalidTagCount The specified tags are beyond the permitted range. 400 指定的 Tag 数超过了 5 个。
InvalidRegion.NotFound The specified parameter RegionId is not valid. 400 指定的 RegionId 不存在。
InvalidZoneId.NotFound The ZoneId provided does not exist. 400 指定的 ZoneId 不存在。

示例

请求示例

  1. https://ecs.aliyuncs.com/?action=DescribeDisks
  2. &RegionId=cn-qingdao
  3. &PageNumber=1
  4. &ZoneId=cn-qingdao-b
  5. &<公共请求参数>

返回示例

XML 格式

  1. <DescribeDisksResponse>
  2. <Disks>
  3. <Disk>
  4. <DeleteAutoSnapshot>true</DeleteAutoSnapshot>
  5. <DeleteWithInstance>false</DeleteWithInstance>
  6. <EnableAutoSnapshot>false</EnableAutoSnapshot>
  7. <Category>cloud</Category>
  8. <Description></Description>
  9. <DiskName></DiskName>
  10. <Size>5</Size>
  11. <Type>data</Type>
  12. <InstanceId></InstanceId>
  13. <CreationTime>2014-07-23T02:44:07Z</CreationTime>
  14. <ImageId></ImageId>
  15. <ZoneId>cn-qingdao-b</ZoneId>
  16. <AttachedTime>2014-07-23T07:47:35Z</AttachedTime>
  17. <DetachedTime>2014-07-23T08:28:48Z</DetachedTime>
  18. <Device></Device>
  19. <OperationLocks></OperationLocks>
  20. <Portable>true</Portable>
  21. <ProductCode></ProductCode>
  22. <RegionId>cn-qingdao</RegionId>
  23. <DiskId>d-28m5zbua0</DiskId>
  24. <SourceSnapshotId></SourceSnapshotId>
  25. <Status>Available</Status>
  26. </Disk>
  27. <Disk>
  28. <DeleteAutoSnapshot>true</DeleteAutoSnapshot>
  29. <DeleteWithInstance>false</DeleteWithInstance>
  30. <EnableAutoSnapshot>false</EnableAutoSnapshot>
  31. <Category>cloud</Category>
  32. <Description></Description>
  33. <DiskName></DiskName>
  34. <Size>5</Size>
  35. <Type>data</Type>
  36. <InstanceId></InstanceId>
  37. <CreationTime>2014-07-23T02:44:06Z</CreationTime>
  38. <ImageId></ImageId>
  39. <ZoneId>cn-qingdao-b</ZoneId>
  40. <AttachedTime></AttachedTime>
  41. <DetachedTime></DetachedTime>
  42. <Device></Device>
  43. <OperationLocks></OperationLocks>
  44. <Portable>true</Portable>
  45. <ProductCode></ProductCode>
  46. <RegionId>cn-qingdao</RegionId>
  47. <DiskId>d-28zfrmo13</DiskId>
  48. <SourceSnapshotId></SourceSnapshotId>
  49. <Status>Available</Status>
  50. </Disk>
  51. </Disks>
  52. <PageNumber>1</PageNumber>
  53. <PageSize>2</PageSize>
  54. <TotalCount>9</TotalCount>
  55. <RequestId>ED5CF6DD-71CA-462C-9C94-A61A78A01479</RequestId>
  56. </DescribeDisksResponse>

JSON 格式

  1. {
  2. "Disks": {
  3. "Disk": [
  4. {
  5. "AttachedTime": "2014-07-23T07:47:35Z",
  6. "Category": "cloud",
  7. "CreationTime": "2014-07-23T02:44:07Z",
  8. "DeleteAutoSnapshot": true,
  9. "DeleteWithInstance": false,
  10. "EnableAutoSnapshot": false
  11. "Description": "",
  12. "DetachedTime": "2014-07-23T08:28:48Z",
  13. "Device": "",
  14. "DiskId": "d-28m5zbua0",
  15. "DiskName": "",
  16. "ImageId": "",
  17. "InstanceId": "",
  18. "OperationLocks": {
  19. "OperationLock": []
  20. },
  21. "Portable": true,
  22. "ProductCode": "",
  23. "RegionId": "cn-qingdao",
  24. "Size": 5,
  25. "SourceSnapshotId": "",
  26. "Status": "Available",
  27. "Type": "data",
  28. "ZoneId": "cn-qingdao-b"
  29. },
  30. {
  31. "AttachedTime": "",
  32. "Category": "cloud",
  33. "CreationTime": "2014-07-23T02:44:06Z",
  34. "DeleteAutoSnapshot": true,
  35. "DeleteWithInstance": false,
  36. "EnableAutoSnapshot": false
  37. "Description": "",
  38. "DetachedTime": "",
  39. "Device": "",
  40. "DiskId": "d-28zfrmo13",
  41. "DiskName": "",
  42. "ImageId": "",
  43. "InstanceId": "",
  44. "OperationLocks": {
  45. "OperationLock": []
  46. },
  47. "Portable": true,
  48. "ProductCode": "",
  49. "RegionId": "cn-qingdao",
  50. "Size": 5,
  51. "SourceSnapshotId": "",
  52. "Status": "Available",
  53. "Type": "data",
  54. "ZoneId": "cn-qingdao-b"
  55. }
  56. ]
  57. },
  58. "PageNumber": 1,
  59. "PageSize": 2,
  60. "RequestId": "ACD9BBB0-A9D1-46D7-9630-B7A69889E110",
  61. "TotalCount": 9
  62. }
本文导读目录