备案 控制台 登录 注册
文档中心 > DescribeDisks
DescribeDisks

最近更新时间：2021-11-19

请求方法：GET

接口描述：使用DescribeDisks查看云硬盘列表。


请求参数

名称

类型

是否必须

描述

Action

String

是

要执行的操作。取值DescribeDisks

RegionId

String

是

云硬盘所在的地域。

  • HB1-BJMY （华北2-北京2）

  • HD1-SHMY（华东1-上海）

Page

int

否

页码。不传默认为1

Size

int

否

每页个数。不传默认为10

DiskName

String

否

硬盘名称。

DiskId

String

否

硬盘实例ID。

SpecificationCode

String

否

硬盘类型。ebs.highIO.ssd（SSD云硬盘）；ebs.hybrid.hdd（高性能HDD云硬盘）

Status

String

否

硬盘状态。Available（可用）；In-use（使用中）

InstanceId

String

否

绑定的主机ID。

Version

String

是

版本号。取值2


返回参数

名称

类型

描述

RequestId

String

请求ID。

records

List

硬盘信息。

+diskId

String

硬盘ID

+diskName

String

硬盘名称

+regionId

String

区域ID

+azoneId

String

可用域ID

+userId

String

用户ID

+diskType

String

硬盘类型

+diskSize

String

硬盘大小

+createTime

Date

创建硬盘时间

+updateTime

Date

更新硬盘时间

+status

String

硬盘状态

  • Creating：创建中

  • Available：可用

  • Attaching：挂载中

  • Detaching：卸载中

  • In-use：使用中

  • Resizing：扩容中

  • Resetting：回滚中

  • Stopped：已停止

  • CreatingSnapshot：创建快照中

+description

String

硬盘描述

+specificationCode

String

产品类型编码

+payType

String

计费类型

+chargeType

int

支付类型

+instanceStartTime

long

开通时间

+instanceEndTime

long

到期时间

+attachInfos

object[]

挂载的实例列表

++instanceId

String

挂载的实例ID

++type

String

挂载的实例的类型

+storageType

String

存储类型

current

String

当前页

total

String

硬盘总数

pages

String

页码总数

size

String

每页个数


示例

请求示例

GET https://api.unicloud.com/ebs?&Action=DescribeDisks

&RegionId=cn-beijing

&Version=2

&公共请求参数


返回示例

JSON格式

{

 " records ": [

          {

            "diskName": "EBS022700561",

            "instanceEndTime": 0,

            "chargeType": 1,

            "description": "",

            "updateTime": "2020-02-26T16:57:44.000+0000",

            "instanceStartTime": 1582736219000,

            "userId": "00211f11-43f2-4925-b5fc-a9000a07730c",

            "diskSize": "25",

            "azoneId": "cn-beijing-a",

            "payType": "CHARGING_HOURS",

            "expired": false,

            "regionId": "cn-beijing",

            "createTime": "2020-02-26T16:57:01.000+0000",

            "storageType": "3par",

            "diskId": "ebs-jnf1w9yka0s8",

            "diskType": "DATA_DISK",

            "specificationCode": "ebs.highIO.ssd",

            "attachInfos": [

                {

                    "instanceId": "ecs-koul95ranirt",

                    "type": "ECS"

                }

            ]

            "status": "Resizing"

        }

    ],

    "current": 1,

    "size": 10,

    "total": 1,

    "pages": 1,

    "RequestId": "b9de1a62-d09e-4d34-9a61-38f0f56564b6"

}