调用ListDisks查询指定地域下一个或多个已创建的磁盘信息。
接口说明
InstanceId和DiskIds不是必需的请求参数，但是可以构建过滤器逻辑，参数之间为逻辑与（And）关系。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListDisks |
系统规定参数。取值：ListDisks |
| RegionId | String | 是 | cn-hangzhou |
地域ID。 |
| InstanceId | String | 否 | 2ad1ae67295445f598017499dc**** |
指定的轻量应用服务器的实例ID。 |
| DiskIds | String | 否 | ["d-bp14wq0149cpp2x****", "d-bp14wq0149cpp2y****"] |
磁盘ID。取值可以由多个磁盘ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。 |
| PageSize | Integer | 否 | 10 |
分页查询时设置的每页行数。 最大值：100 默认值：10 |
| PageNumber | Integer | 否 | 1 |
磁盘列表的页码。 默认值：1 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Disks | Array of Disk |
磁盘信息组成的数组。 |
|
| Category | String | ESSD |
磁盘种类。可能值：
|
| CreationTime | String | 2021-03-08T05:31:06Z |
创建时间。时间格式以ISO8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 |
| Device | String | /dev/xvda |
磁盘挂载服务器中的设备名。 |
| DiskChargeType | String | PrePaid |
磁盘的计费方式。 |
| DiskId | String | d-bp14wq0149cpp2x**** |
磁盘ID。 |
| DiskName | String | SystemDisk |
磁盘名称。 |
| DiskType | String | System |
磁盘类型。可能值：
|
| InstanceId | String | 2ad1ae67295445f598017499dc**** |
磁盘对应的轻量应用服务器的实例ID。 |
| RegionId | String | cn-hangzhou |
地域ID。 |
| Size | Integer | 50 |
磁盘大小。单位：GB |
| Status | String | In_use |
磁盘状态。可能值：
|
| PageNumber | Integer | 1 |
磁盘列表的页码。 |
| PageSize | Integer | 10 |
分页查询时设置的每页行数。 |
| TotalCount | Integer | 1 |
磁盘总条数。 |
| RequestId | String | 20758A-585D-4A41-A9B2-28DA8F4F534F |
请求ID。 |
示例
请求示例
https://swas.cn-hangzhou.aliyuncs.com/?Action=ListDisks
&InstanceId=2ad1ae67295445f598017499dc****
&<公共请求参数>正常返回示例
XML格式
<ListDisksResponse>
<TotalCount>1</TotalCount>
<RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Disks>
<DiskType>System</DiskType>
<Status>In_use</Status>
<Category>ESSD</Category>
<InstanceId>2ad1ae67295445f598017499dc****</InstanceId>
<Size>50</Size>
<Device>/dev/xvda</Device>
<CreationTime>2021-03-08T05:31:06Z</CreationTime>
<DiskChargeType>PrePaid</DiskChargeType>
<RegionId>cn-hangzhou</RegionId>
<DiskName>SystemDisk</DiskName>
<DiskId>d-bp14wq0149cpp2x****</DiskId>
</Disks>
</ListDisksResponse>JSON格式
{
"TotalCount": 1,
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
"PageSize": 10,
"PageNumber": 1,
"Disks": [
{
"DiskType": "System",
"Status": "In_use",
"Category": "ESSD",
"InstanceId": "2ad1ae67295445f598017499dc****",
"Size": 50,
"Device": "/dev/xvda",
"CreationTime": "2021-03-08T05:31:06Z",
"DiskChargeType": "PrePaid",
"RegionId": "cn-hangzhou",
"DiskName": "SystemDisk",
"DiskId": "d-bp14wq0149cpp2x****"
}
]
}错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的实例不存在，请您检查实例ID是否正确。 |
| 500 | InternalError | An error occurred while processing your request. | 内部错误，请重试。如果多次尝试失败，请提交工单。 |
| 403 | InvalidParam | The specified parameter value is invalid. | 参数非法。 |
访问错误中心查看更多错误码。
