DescribeDisks - 查询磁盘信息_边缘节点服务 ENS(ENS)-阿里云帮助中心

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ens:DescribeDisks	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
EnsRegionId	string	否	ENS 的节点 ID。	cn-kunming-telecom
DiskId	string	否	云盘 ID。	d-5soak1gqa507lyfzvz0xo****
DiskName	string	否	磁盘名称。	DiskName
PageNumber	string	否	查询列表的页码。起始值为 1。默认值：1。	1
PageSize	string	否	分页查询时设置的每页行数，最大值为 50 行。默认值：10。	10
Status	string	否	磁盘状态。 In-use：使用中 Available：待挂载 Attaching：挂载中 Detaching：卸载中 Creating：创建中 ReIniting：重置中 Deleting：释放中 Deleted：已释放 Expiring：即将过期	Available
Type	string	否	磁盘属性 system：系统盘 data：数据盘	system
Category	string	否	磁盘种类。高效云盘：cloud_efficiency 全闪云盘：cloud_ssd 本地 HDD 盘：local_hdd 本地盘 SSD：local_ssd	local_ssd
DiskChargeType	string	否	计费类型。 prepay：预付费 postpay：按量付费	prepay
EnsRegionIds	string	否	节点列表。	["cn-suzhou-telecom","cn-chengdu-telecom"]
DiskIds	string	否	磁盘 ID。	[\"d-wz99njena32z90ki****\"]
OrderByParams	string	否	排序使用：格式例子{"EnsRegionId":"desc"}。默认按节点 ID 降序排列。	{ "DiskNameSort":"desc","EnsRegionIdSort":"asc" }
DiskType	string	否	磁盘购买方式。 ServiceDisk：边缘服务创建磁盘 ResoureDisk：随实例购买 PostPayDisk：单独购买	PostPayDisk
InstanceId	string	否	云盘所挂载的实例。	i-5t77rb0yoz79m28ku60sx****
SnapshotId	string	否	快照 ID。	s-897654321****

返回参数

名称	类型	描述	示例值
	object
Code	integer	返回的业务码，正常成功为 0。	0
Disks	array<object>	磁盘信息例表。
Disks	object	磁盘信息例表。
Category	string	磁盘种类。高效云盘：cloud_efficiency 全闪云盘：cloud_ssd 本地 HDD 盘：local_hdd 本地盘 SSD：local_ssd	local_ssd
CreationTime	string	创建时间。时间格式以 ISO8601 为标准，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2021-11-11T14:34:55+08:00
DiskChargeType	string	云盘或本地盘的计费方式。取值： prepaid：包年包月。 postpaid：按量付费。	prepaid
DiskId	string	磁盘 ID。	d-5svum1dx1w4a4spr54lgr****
DiskName	string	磁盘名称。	fvt-ecs-5cf0****
EnsRegionId	string	ENS 节点 ID。	cn-guangzhou-10
InstanceId	string	实例 ID。	i-5t77rb0yoz79m28ku60sx****
InstanceName	string	实例名称。	边缘prod环境串流机器-1063
Size	integer	磁盘大小，单位：MiB。	20
Status	string	磁盘状态。 In-use：使用中 Available：待挂载 Attaching：挂载中 Detaching：卸载中 Creating：创建中 ReIniting：重置中	Available
Type	string	云盘或本地盘类型。取值： 1：系统盘 2：数据盘	1
Portable	boolean	云盘或本地盘是否支持卸载。取值： true：支持。可以独立存在，且可以在可用区内自由挂载和卸载。 false：不支持。不可以独立存在，且不可以在可用区内自由挂载和卸载。以下类型块存储的 Portable 属性都为 false，生命周期与实例等同：本地 HDD 盘本地 SSD 盘包年包月数据盘	true
SnapshotId	string	快照 ID。	s-bp67acfmxazb4p****
SerialId	string	序列号。	123
Encrypted	boolean	是否加密云盘。取值范围： true：是 false：否	false
EncryptedKeyId	string	云盘使用的 KMS 密钥 ID。	05467897a-4262-4802-b8cb-00d3fb40****
PageNumber	integer	当前查询页码。	1
PageSize	integer	分页查询时每页的行数，最大值为 50，默认值为 10。	50
RequestId	string	请求 ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCount	integer	分页查询时分页总页数。	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",
        "Description": "",
        "Size": 20,
        "Status": "Available",
        "Type": "1",
        "Portable": true,
        "SnapshotId": "s-bp67acfmxazb4p****",
        "SerialId": "123",
        "Encrypted": false,
        "EncryptedKeyId": "05467897a-4262-4802-b8cb-00d3fb40****",
        "DeleteWithInstance": true
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 13
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.	-
400	InstanceIdNotFound	The input parameter instancdId that is not found.	指定的实例ID不存在。
400	NoPermission	Permission denied.	没有足够的权限，请联系云账号管理员授予您相应权限。
400	CallInterface	Call Interface Happen Error.	接口调用出错。
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-

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

变更历史

变更时间	变更内容概要	操作
2024-11-18	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-11-14	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-10-17	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-07-20	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-03-02	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-10-28	新增 OpenAPI	查看变更详情