DescribeDisks

DescribeDisks

1. 接口描述

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

2. 请求参数

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

参数名称
必选
类型
描述

diskIds

否

Array of String

云硬盘ID集合。

diskName

否

String

云硬盘名称。

diskStatus

否

String

云硬盘状态。

diskType

否

String

云硬盘类型。

  • SYSTEM: 系统盘。

  • DATA: 数据盘。

diskCategory

否

String

云硬盘种类。

  • Basic NVMe SSD: 经济型 NVMe SSD

  • Standard NVMe SSD: 标准型 NVMe SSD

默认为Standard NVMe SSD。可从DescribeDiskCategory 中获取。

instanceId

否

String

实例ID。

zoneId

否

String

可用区ID。

pageSize

否

Integer

返回的分页大小。

默认为20，最大为1000。

pageNum

否

Integer

返回的分页数。

默认为1。

resourceGroupId

否

String

资源组ID。

3. 响应结果

参数名称
类型
描述

requestId

String

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

totalCount

Integer

符合条件的数据总数。

dataSet

Array of DiskInfo

结果集。

4. 代码示例

  1. 查询云硬盘列表。

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

Request:
{
  "diskStatus": "IN_USE",
  "diskSize": 20,
  "zoneId": "asia-east-1a"
}

Response:
{
    "requestId": "T83B6A963-B111-4BF9-8466-1C3351E2DFD1",
    "response": {
        "requestId": "T83B6A963-B111-4BF9-8466-1C3351E2DFD1",
        "dataSet": [
            {
                "chargeType": "PAY_AS_YOU_GO_BY_HOUR",
                "createTime": "2025-07-02T09:51:00Z",
                "diskCategory": "Basic NVMe SSD",
                "diskId": "your disk id",
                "diskName": "Boot-disk-asia-east-1a-20GB-01",
                "diskSize": 20,
                "diskStatus": "IN_USE",
                "diskType": "SYSTEM",
                "instanceId": "your instance id",
                "instanceName": "Ubuntu-1vCPU-2gb-asia-east-1a-1",
                "portable": false,
                "resourceGroupId": "0a253bb0-eb7d-4328-84ec-fc8d1487b31a",
                "resourceGroupName": "Default Resource Group",
                "serial": "d1ig21p4rprh9bc5irsg",
                "regionId": "asia-east-1",
                "zoneId": "asia-east-1a"
            }
        ],
        "totalCount": 1
    }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码
错误码
说明

404

INVALID_ZONE_NOT_FOUND

指定的区域不存在。

PreviousCreateDisksNextAttachDisks

Last updated