DescribeDisks

1. 接口描述

本接口（DescribeDisks）用于查询云硬盘列表。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

必选

类型

描述

diskIds

否

Array of String

云硬盘ID集合。

diskName

否

String

云硬盘名称。

diskStatus

否

DiskStatus

云硬盘状态。

diskType

否

String

云硬盘类型。

SYSTEM: 系统盘。
DATA: 数据盘。

diskSize

否

Integer

云硬盘大小，单位GB。

diskCategory

否

String

云硬盘种类。

STANDARD: 标准云盘
SSD: 固态硬盘

默认为STANDARD。可从 DescribeDiskCategory 中获取。

portable

否

Boolean

是否可拔插。 false 代表会随实例一起删除。 true 代表不会随实例一起删除，实例删除后，云盘处于AVAILABLE状态。

instanceId

否

String

实例ID。

zoneId

否

String

可用区ID。可从 DescribeZones 接口中获取到可用区ID。

pageSize

否

Integer

返回的分页大小。

默认为20，最大为1000。

pageNum

否

Integer

返回的分页数。

默认为1。

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID。每次请求都会返回。定位问题时需要提供该次请求的 requestId。

totalCount

Integer

符合条件的数据总数。

dataSet

Array of DiskInfo

结果集。

4. 代码示例

查询云硬盘列表。

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeDisks
<Common Request Params>

Request:
{
  "diskStatus": "AVAILABLE",
  "diskSize": 20,
  "portable": true,
  "zoneId": "SIN-E"
}

Response:
{
  "requestId": "T83B6A963-B111-4BF9-8466-1C3351E2DFD1",
  "response": {
    "requestId": "T83B6A963-B111-4BF9-8466-1C3351E2DFD1",
    "dataSet": [
      {
        "diskName": "default-SIN-20GB-01",
        "period": 1,
        "instanceName": "Test-Instanc",
        "chargeType": "PREPAID",
        "portable": true,
        "expiredTime": "2023-02-01T00:00:00Z",
        "diskSize": 20,
        "instanceId": "your-instance-id-1",
        "createTime": "2023-02-01T00:00:00Z",
        "zoneId": "SIN-E",
        "diskStatus": "AVAILABLE",
        "diskId": "disk-id-1",
        "diskType": "DATA",
        "diskCategory": "STANDARD",
        "autoRenew": true
      },
      {
        "diskName": "default-SIN-20GB-01",
        "period": 1,
        "instanceName": "Test-Instance",
        "chargeType": "PREPAID",
        "portable": true,
        "expiredTime": "2023-02-01T00:00:00Z",
        "diskSize": 20,
        "instanceId": "your-instance-id-1",
        "createTime": "2023-01-01T00:00:00Z",
        "zoneId": "SIN-E",
        "diskStatus": "AVAILABLE",
        "diskId": "disk-id-2",
        "diskType": "SYSTEM",
        "diskCategory": "STANDARD",
        "autoRenew": true
      }
    ],
    "totalCount": 2
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

404

INVALID_ZONE_NOT_FOUND

指定的区域不存在。

最后更新于1年前