ListDisks - 查询一个或多个磁盘信息 - 轻量应用服务器

查询指定地域下一个或多个已创建的磁盘信息。

接口说明

InstanceId、DiskIds和ResourceGroupId不是必需的请求参数，但是可以构建过滤器逻辑，参数之间为逻辑与（And）关系。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
swas-open:ListDisks	get	Disk acs:swas-open:{#regionId}:{#accountId}:disk/{#DiskId} Disk acs:swas-open:{#regionId}:{#accountId}:disk/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
InstanceId	string	否	指定的轻量应用服务器的实例 ID。	2ad1ae67295445f598017499dc****
DiskIds	string	否	磁盘 ID。取值可以由多个磁盘 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。	["d-bp14wq0149cpp2x**", "d-bp14wq0149cpp2y**"]
PageSize	integer	否	分页查询时设置的每页行数。最大值：100 默认值：10	10
PageNumber	integer	否	磁盘列表的页码。默认值：1	1
DiskType	string	否	磁盘类型。可能值： System：系统盘。 Data：数据盘。默认全量查询	system
Tag	array<object>	否	磁盘的标签列表。
	object	否	标签。
Key	string	否	磁盘的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。	TestKey
Value	string	否	磁盘的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。	TestValue
ResourceGroupId	string	否	指定的资源组 ID。	rg-aek2bti7cf7****

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	磁盘总条数。	1
RequestId	string	请求 ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	分页查询时设置的每页行数。	10
PageNumber	integer	磁盘列表的页码。	1
Disks	array<object>	磁盘信息组成的数组。
Disk	object
CreationTime	string	创建时间。时间格式以 ISO8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2021-03-08T05:31:06Z
Status	string	磁盘状态。可能值： ReIniting：初始化中。 Creating：创建中。 In_use：使用中。 Available：待挂载。 Attaching：挂载中。 Detaching：卸载中。	In_use
Device	string	磁盘挂载服务器中的设备名。	/dev/xvda
Size	integer	磁盘大小。单位：GB。	50
DiskName	string	磁盘名称。	SystemDisk
DiskChargeType	string	磁盘的计费方式。	PrePaid
DiskType	string	磁盘类型。可能值： System：系统盘。 Data：数据盘。	System
Category	string	磁盘类型，可能值： ESSD：ESSD 云盘，性能级别 PL0。 SSD：SSD 云盘。 CLOUD_EFFICIENCY：高效云盘。	ESSD
DiskId	string	磁盘 ID。	d-bp14wq0149cpp2x****
InstanceId	string	磁盘对应的轻量应用服务器的实例 ID。	2ad1ae67295445f598017499dc****
RegionId	string	地域 ID。	cn-hangzhou
Remark	string	磁盘备注。	remark
Tags	array<object>	磁盘的标签列表。
tag	object	标签。
Key	string	磁盘的标签键。	TestKey
Value	string	磁盘的标签值。	TestValue
InstanceName	string	轻量应用服务器名称。	myInstance
ResourceGroupId	string	磁盘所属的资源组 ID。	rg-aek2bti7cf7****

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Disks": [
    {
      "CreationTime": "2021-03-08T05:31:06Z",
      "Status": "In_use",
      "Device": "/dev/xvda",
      "Size": 50,
      "DiskName": "SystemDisk",
      "DiskChargeType": "PrePaid",
      "DiskType": "System",
      "Category": "ESSD",
      "DiskId": "d-bp14wq0149cpp2x****",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "RegionId": "cn-hangzhou",
      "Remark": "remark",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "InstanceName": "myInstance",
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	An error occurred while processing your request.	内部错误，请重试。如果多次尝试失败，请提交工单。

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

变更历史

变更时间	变更内容概要	操作
2024-05-29	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-02-20	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-05-25	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情