获取云硬盘详情

1. 接口描述

接口方法: GET

Action= DescribeDisk 获取云硬盘详情

2. 输入参数

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

输入参数是否必选类型描述
DiskIdLong云盘Id

3. 输出参数

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

输出参数类型描述
CodeString公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码。
MessageString错误信息描述
DiskCxtObject对象
DiskCxt.ZoneIdString可用区
DiskCxt.DiskIdLong云盘ID
DiskCxt.TypeString云盘类型。可选值CloudSsd,CloudHighPerformanceSsd,CloudSas
DiskCxt.ChargeTypeString实例计费类型。可选值MONTH,HOUR
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.StatusString云盘状态
DiskCxt.AttachedInstanceString挂载实例ID(或者为容器namespace)
DiskCxt.DevicePathString挂载路径
DiskCxt.CreateAtString创建时间。UTC时间
DiskCxt.UpdateAtString更新时间。UTC时间
DiskCxt.DefaultSnapshotQuotaLong默认快照配额
DiskCxt.UsedSnapshotQuotaLong已用快照配额

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=DescribeDisk&Version=2017-12-28&DiskId=12345

6. 返回示例

{
    "DiskCxt": {
        "DiskId": 12345,
        "SourceSnapshotId": 0,
        "SourceSnapshotName": null,
        "ZoneId": "cn-east-1a",
        "DiskName": "test",
        "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
    },
    "RequestId": "6a3d2b0d-7b86-4c7c-bffd-b3f960a2ff74"
}