查询一块或多块您已经创建的块存储云盘。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ebs:DescribeLensMonitorDisks |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。您可以调用 DescribeRegions 查询块存储数据洞察支持的地域列表。 |
cn-hangzhou |
| DiskIds |
array |
否 |
指定云盘 ID 列表。 |
['d-1', 'd-2'] |
|
string |
否 |
云盘 ID。 |
d-cd40hxfu0v***** |
|
| DiskCategory |
string |
否 |
云盘类型。取值范围:
|
cloud_auto |
| LensTags |
array |
否 |
云盘事件标签列表,用于筛选 24 小时内发生过这些事件类型的云盘。取值范围:
|
|
|
string |
否 |
云盘事件标签。 |
NoSnapshot |
|
| NextToken |
string |
否 |
查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 |
caeba0bbb2be03f84eb48b699f0a**** |
| MaxResults |
integer |
否 |
分页查询时每页行数。最大值为 100。 默认值:
|
10 |
| DiskIdPattern |
string |
否 |
正则匹配模糊查询筛选云盘 ID。 |
d-cd40hxfu0v* |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
DescribeLensMonitorDisksResponse |
||
| DiskInfos |
array<object> |
云盘信息列表。 |
|
|
array<object> |
云盘信息。 |
||
| DiskId |
string |
云盘 ID。 |
d-cd401**** |
| DiskName |
string |
云盘名称。 |
disk-28c6b**** |
| DiskType |
string |
云盘类型。可能值:
|
system |
| DiskStatus |
string |
云盘状态。可能值:
|
Available |
| RegionId |
string |
地域 ID。 |
cn-hangzhou |
| DiskCategory |
string |
云盘类型。取值范围:
|
cloud_essd |
| PerformanceLevel |
string |
ESSD 云盘的性能等级。可能值:
|
PL0 |
| Tags |
array<object> |
云盘的标签集合。 |
|
|
object |
云盘的标签。 |
||
| TagValue |
string |
标签值。 |
user |
| TagKey |
string |
标签键。 |
tag1 |
| ZoneId |
string |
云盘所属的可用区 ID。 |
cn-hangzhou-j |
| Size |
integer |
云盘大小,单位为 GiB。 |
64 |
| Iops |
integer |
每秒读写(I/O)操作的次数上限,单位:次/s。 |
4000 |
| Bps |
integer |
每秒读写(I/O)成功传输的数据数量上限,单位:MB/s。 |
300 |
| ProvisionedIops |
integer |
ESSD AutoPL 云盘预配置的读写 IOPS。可能值:0~min{50000, 1000*容量-基准性能}。 基准性能=min{1,800+50*容量, 50,000}。 当 |
4000 |
| BurstingEnabled |
boolean |
是否开启 Burst(性能突发)。可能值:
当 |
true |
| LensTags |
array |
云盘的事件标签集合。事件标签展示云盘 24 小时内发生过的事件,相比事件有 1 小时之内的延迟。 |
|
|
string |
云盘的事件标签。 |
["NoSnapshot", "DiskIOHang"] |
|
| SharingEnabled |
string |
是否共享盘 |
true |
| NextToken |
string |
查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 |
caeba0bbb2be03f84eb48b699f0a**** |
| TotalCount |
integer |
查询结果总条数。 |
6 |
| RequestId |
string |
请求 ID。无论调用接口成功与否,我们都会返回请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
示例
正常返回示例
JSON格式
{
"DiskInfos": [
{
"DiskId": "d-cd401****",
"DiskName": "disk-28c6b****",
"DiskType": "system",
"DiskStatus": "Available",
"RegionId": "cn-hangzhou",
"DiskCategory": "cloud_essd",
"PerformanceLevel": "PL0",
"Tags": [
{
"TagValue": "user",
"TagKey": "tag1"
}
],
"ZoneId": "cn-hangzhou-j",
"Size": 64,
"Iops": 4000,
"Bps": 300,
"ProvisionedIops": 4000,
"BurstingEnabled": true,
"LensTags": [
"[\"NoSnapshot\", \"DiskIOHang\"]"
],
"SharingEnabled": "true"
}
],
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"TotalCount": 6,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The parameter %s is invalid. | 参数错误 |
| 400 | InvalidParameter.Conflict | The specified parameter %s and %s are not blank at the same time. | 参数冲突 |
| 400 | InvalidParameter.Format | Specified parameter format is not valid. | 返回值格式不正确(Format 不支持)。返回格式支持 XML 与 JSON,默认为 XML。 |
| 400 | MissingParameter | The input parameter %s that is mandatory for processing this request is not supplied. | 参数缺失。 |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误。 |
| 403 | Forbidden | User is not authorized to operate. | 当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。 |
| 403 | Forbidden.Action | User is not authorized to operate this action. | 当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。 |
| 403 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance. | 您的账户余额不足。 |
| 403 | LastTokenProcessing | The last token request is processing. | 相同clientToken的请求正在执行,请稍后再重试。 |
| 403 | NoPermission.SLR | The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS. | 当前用户无权限创建SLR。 |
| 403 | OperationDenied | The operation is not allowed. | 当前操作不允许执行。 |
| 404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | |
| 404 | NoSuchResource | The specified resource does not exist. | 指定的资源不存在。 |
| 504 | RequestTimeout | The request is timeout, please try again later. | 该请求超时,请稍后再重试。 |
| 429 | BLOCK.LimitedRequest | Request was denied due to user flow control. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。