获取云盘列表

1. 接口描述

接口方法: POST

Action= ListDisk 获取云盘列表

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。

输入参数是否必选类型描述
LimitUInt一页显示条目,最大值为10000,最小值为1
OffsetUInt当前起始位置,默认从0开始
ZoneIdString可用区
POST的body内容需要带上如下内容:

{
}

3. 输出参数

以下输出参数列表仅列出了接口特定输出参数,其它参数见公共输出参数页面。

输出参数类型描述
CodeString公共错误码
MessageString错误信息描述
TotalSizeUInt总数
DiskCxtsArrary数组
DiskCxtObject对象
DiskCxt.ZoneIdString可用区
DiskCxt.DiskIdLong云盘ID
DiskCxt.TypeString可选值CloudSsd,CloudHighPerformanceSsd,CloudSas
DiskCxt.CapacityUInt云盘大小,单位GB, 要求10的整数倍
DiskCxts.DiskNameString卷名称
DiskCxts.VolumeUUIDString底层卷UUID
DiskCxts.SourceSnapshotIdLong快照ID(如果是从快照创建则非0)
DiskCxts.SourceSnapshotNameString快照来源名称(如果是从快照创建则非null)
DiskCxt.EnableEncryptUInt取值为ture、false目前只支持false,用户不可见
DiskCxt.ScopeString云盘适用范围,到值NCS, NVM.面向容器服务的云硬盘默认格式化成 Ext4,面向云服务器的云硬盘需自行挂载后执行 mount 操作才能成功挂载
DiskCxt.EnableEncryptUInt取值为ture、false目前只支持false
DiskCxt.StatusString云盘状态
DiskCxt.AttachedInstanceString挂载实例ID(或者为容器namespace)
DiskCxt.ChargeTypeString计费类型,MONTH代表包年包月,HOUR代表按量计费
DiskCxt.DevicePathString挂载路径
DiskCxt.CreateAtStringUTC时间

4. Status值

Status描述
creating创建中
create_succ创建成功
create_fail创建失败
mounting挂载中
mount_succ挂载成功
mount_fail挂载失败
unmounting卸载中
unmounted已卸载
unmount_fail卸载失败
extending扩容中
extend_succ扩容成功
extend_fail扩容失败
error_attaching挂载错误
error_detaching卸载错误
error_extending扩容错误
arrear_shutoffing欠费停服中
arrear_shutoff欠费停服
arrear_shutoff_fail欠费停服失败
arrear_recovery欠费恢复
arrear_recovery_fail欠费恢复失败

5. 请求示例

https://open.c.163.com/ncv?Action=ListDisk&Version=2017-12-28&Limit=20&Offset=0&ZoneId=cn-east-1a

-d '{}'

6. 返回示例

{
    "RequestId": "00264957-8531-4421-ab2d-f12651920f05",
    "DiskCxts": [
        {
            "DiskId": 12345,
            "SourceSnapshotId": 0,
            "SourceSnapshotName": null,
            "ZoneId": "cn-east-1a",
            "DiskName": "test-1",
            "VolumeUUID": "7a377258-d1d7-4ffc-aacd-abf36cb720c1",
            "Type": "CloudSsd",
            "ChargeType": "MONTH",
            "Capacity": 20,
            "EnableEncrypt": false,
            "Scope": "NVM",
            "Status": "extend_succ",
            "AttachedInstance": "",
            "DevicePath": null,
            "CreateAt": "2018-06-01T07:00:27Z",
            "UpdateAt": "2018-06-01T07:05:26Z",
            "DefaultSnapshotQuota": 7,
            "UsedSnapshotQuota": 0
        },
        {
            "DiskId": 12346,
            "SourceSnapshotId": 0,
            "SourceSnapshotName": null,
            "ZoneId": "cn-east-1a",
            "DiskName": "test-2",
            "VolumeUUID": "0de9de9b-e00d-4cc1-9ca1-1b1d30c8fa64",
            "Type": "CloudSas",
            "ChargeType": "HOUR",
            "Capacity": 10,
            "EnableEncrypt": false,
            "Scope": "NVM",
            "Status": "create_succ",
            "AttachedInstance": "",
            "DevicePath": null,
            "CreateAt": "2018-05-24T08:53:07Z",
            "UpdateAt": "2018-06-01T07:03:31Z",
            "DefaultSnapshotQuota": 7,
            "UsedSnapshotQuota": 1
        }
    ],
    "TotalSize": 2
}