文档

DescribeDisks - 查询磁盘信息

调用DescribeDisks查询一个或多个已创建的磁盘信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
EnsRegionIdstring

ENS 的节点 ID。

cn-kunming-telecom
DiskIdstring

云盘 ID。

d-5soak1gqa507lyfzvz0xo****
DiskNamestring

磁盘名称。

DiskName
PageNumberstring

查询列表的页码。起始值为 1

默认值:1

1
PageSizestring

分页查询时设置的每页行数,最大值为 50 行。

默认值:10

10
Statusstring

磁盘状态。

  • In-use:使用中
  • Available:待挂载
  • Attaching:挂载中
  • Detaching:卸载中
  • Creating:创建中
  • ReIniting:重置中
  • Deleting:释放中
  • Deleted:已释放
  • Expiring:即将过期
Available
Typestring

磁盘属性

  • system:系统盘
  • data:数据盘
system
Categorystring

磁盘种类。

  • 高效云盘:cloud_efficiency
  • 全闪云盘:cloud_ssd
  • 本地 HDD 盘:local_hdd
  • 本地盘 SSD:local_ssd
local_ssd
DiskChargeTypestring

计费类型。

  • prepay:预付费
  • postpay:按量付费
prepay
EnsRegionIdsstring

节点列表。

["cn-suzhou-telecom","cn-chengdu-telecom"]
DiskIdsstring

磁盘 ID。

[\"d-wz99njena32z90ki****\"]
OrderByParamsstring

排序使用:格式例子{"EnsRegionId":"desc"}。默认按节点 ID 降序排列。

{ "DiskNameSort":"desc","EnsRegionIdSort":"asc" }
DiskTypestring

磁盘购买方式。

  • ServiceDisk:边缘服务创建磁盘
  • ResoureDisk:随实例购买
  • PostPayDisk:单独购买
PostPayDisk
InstanceIdstring

云盘所挂载的实例。

i-5t77rb0yoz79m28ku60sx****
SnapshotIdstring

快照 ID。

s-897654321****

返回参数

名称类型描述示例值
object
Codeinteger

返回的业务码,正常成功为 0。

0
Disksobject []

磁盘信息例表。

Categorystring

磁盘种类。

  • 高效云盘:cloud_efficiency
  • 全闪云盘:cloud_ssd
  • 本地 HDD 盘:local_hdd
  • 本地盘 SSD:local_ssd
local_ssd
CreationTimestring

创建时间。时间格式以 ISO8601 为标准,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2021-11-11T14:34:55+08:00
DiskChargeTypestring

云盘或本地盘的计费方式。取值:

  • prepaid:包年包月。
  • postpaid:按量付费。
prepaid
DiskIdstring

磁盘 ID。

d-5svum1dx1w4a4spr54lgr****
DiskNamestring

磁盘名称。

fvt-ecs-5cf0****
EnsRegionIdstring

ENS 节点 ID。

cn-guangzhou-10
InstanceIdstring

实例 ID。

i-5t77rb0yoz79m28ku60sx****
InstanceNamestring

实例名称。

边缘prod环境串流机器-1063
Sizeinteger

磁盘大小,单位:MiB。

20
Statusstring

磁盘状态。

  • In-use:使用中
  • Available:待挂载
  • Attaching:挂载中
  • Detaching:卸载中
  • Creating:创建中
  • ReIniting:重置中
Available
Typestring

云盘或本地盘类型。取值:

  • 1:系统盘
  • 2:数据盘
1
Portableboolean

云盘或本地盘是否支持卸载。取值:

  • true:支持。可以独立存在,且可以在可用区内自由挂载和卸载。
  • false:不支持。不可以独立存在,且不可以在可用区内自由挂载和卸载。

以下类型块存储的 Portable 属性都为 false,生命周期与实例等同:

  • 本地 HDD 盘
  • 本地 SSD 盘
  • 包年包月数据盘
true
SnapshotIdstring

快照 ID。

s-bp67acfmxazb4p****
SerialIdstring

序列号。

123
Encryptedboolean

是否加密云盘。取值范围:

  • true:是

  • false:否

false
EncryptedKeyIdstring

云盘使用的 KMS 密钥 ID。

05467897a-4262-4802-b8cb-00d3fb40****
PageNumberinteger

当前查询页码。

1
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 10

50
RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCountinteger

分页查询时分页总页数。

13

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "Disks": {
    "Disks": [
      {
        "Category": "local_ssd",
        "CreationTime": "2021-11-11T14:34:55+08:00",
        "DiskChargeType": "prepaid",
        "DiskId": "d-5svum1dx1w4a4spr54lgr****",
        "DiskName": "fvt-ecs-5cf0****",
        "EnsRegionId": "cn-guangzhou-10",
        "InstanceId": "i-5t77rb0yoz79m28ku60sx****",
        "InstanceName": "边缘prod环境串流机器-1063",
        "Size": 20,
        "Status": "Available",
        "Type": "1",
        "Portable": true,
        "SnapshotId": "s-bp67acfmxazb4p****",
        "SerialId": "123",
        "Encrypted": false,
        "EncryptedKeyId": "05467897a-4262-4802-b8cb-00d3fb40****"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 13
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter domainName that is mandatory for processing this request is not supplied.-
400InstanceIdNotFoundThe input parameter instancdId that is not found.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400CallInterfaceCall Interface Happen Error.接口调用出错。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-10-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-07-20OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-03-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
入参OpenAPI 入参发生变更
    新增入参:InstanceId
    新增入参:SnapshotId
出参OpenAPI 返回结构发生变更
2021-10-28新增 OpenAPI看变更集
  • 本页导读 (1)