1. 查询云盘列表

本接口用于查询云盘列表。

该接口用于查询用户已创建未删除的云盘列表。
该接口为同步接口，接口调用后会直接返回查询结果。
该接口会以列表的形式返回所有符合条件的云盘信息。

1.1. 接口说明

本接口所属服务类型为 ebs

本接口操作类型为 DescribeDisks

1.1.1. 请求路径

POST {baseUrl}/v3/ebs/DescribeDisks

1.1.2. 请求体

{
  "ecsUuid": "a5fd0143-0a6b-4825-b26a-142e2367c560",
  "ebsUuid": "12b8a31a-109a-44c1-a640-3f7a2d9c6bd3",
  "aliasName":"ecs-pnwtykfs-volumn-2",
  "pageNum": 1,
  "pageSize": 10
}

请求体内容说明

属性名	属性类型	是否必须	查询方式	说明
ecsUuid	String	否	等值查询	云服务器 UUID。
ebsUuid	String	否	等值查询	云盘 UUID。
aliasName	String	否	等值查询	云盘名称。
pageNum	Integer	否	等值查询	页号
pageSize	Integer	否	等值查询	页大小

1.1.3. 返回内容

{
  "code": 200,
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "rows": [
      {
        "aliasName": "ecs-pnwtykfs-volumn-2",
        "attr": "Root",
        "autoRenewCnt": 0,
        "billingType": "PrePaid",
        "createdTime": "2023-10-23 16:53:48",
        "destroyTime": "2023-12-26 16:53:48",
        "diskType": {
          "diskType": "HDD"
        },
        "expireStrategy": "AutoDelete",
        "expireTime": "2023-12-23 16:53:48",
        "operatingSystem": "Ubuntu",
        "payPeriod": 2,
        "prepaidTime": "2023-10-23 16:53:48",
        "resourceName": "dev-GT-Ubuntu20-04-CMD-V2-0-8GB-5M-volumn-1",
        "resourceStatus": "Active",
        "resourceUuid": "12b8a31a-109a-44c1-a640-3f7a2d9c6bd3",
        "parentResourceUuid": "8e3bd6fb-a52c-4f1f-a8ff-ed1f276b3bdf",
        "diskSize": 40,
        "updatedTime": "2023-10-23 16:56:30",
        "zone": {
          "regionCode": "cn-zhongwei",
          "regionName": "中卫",
          "zoneCode": "cn-zhongwei-a",
          "zoneName": "中卫一区"
        }
      }
    ],
    "total": 1
  },
  "message": "查询云盘列表成功"
}

返回体内容说明

属性名	属性类型	说明
aliasName	String	云盘别名
attr	String	云盘属性。目前只有两个值 Root 表示系统盘，Data 表示数据盘
autoRenewCnt	Integer	包月云盘自动续费月数
billingType	String	云盘计费类型
createdTime	Datetime	云盘创建时间
updatedTime	Datetime	云盘更新时间
destroyTime	Datetime	策略为到期删除的包月云盘最后删除时间
diskType	DiskType	云盘规格类型
expireStrategy	String	包月云盘到期策略
expireTime	Datetime	包月云盘到期时间
operatingSystem	String	云盘适用的操作系统
payPeriod	Integer	购买月数，例如：payPeriod=1表示购买1个月
prepaidTime	Datetime	包月云盘的包月开始时间
resourceName	String	云盘名称
resourceStatus	String	云盘状态
resourceUuid	String	云盘唯一id
parentResourceUuid	String	云服务器唯一id
diskSize	Integer	云盘大小
zone	Zone	云盘所属可用区信息

💡

云服务器状态resourceStatus属性值详见云盘状态

挂载云盘卸载云盘