备案控制台
文档
产品文档
输入文档关键字查找
首页 云服务器 ECS 开发参考 API参考（EBS高阶） API目录 数据洞察 DescribeLensMonitorDisks - 查询一块或多块您已经创建的块存储云盘

DescribeLensMonitorDisks - 查询一块或多块您已经创建的块存储云盘

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

查询一块或多块您已经创建的块存储云盘。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring是

地域 ID。您可以调用 DescribeRegions 查询块存储数据洞察支持的地域列表。

cn-hangzhou
DiskIdsarray否

指定云盘 ID 列表。

string否

云盘 ID。

d-cd40hxfu0v*****
DiskCategorystring否

云盘类型。取值范围：

  • cloud：普通云盘。
  • cloud_efficiency：高效云盘。
  • cloud_ssd：SSD 盘。
  • cloud_essd：ESSD 云盘。
  • cloud_auto：ESSD AutoPL 云盘。
  • cloud_essd_entry：ESSD Entry 云盘。
cloud_auto
LensTagsarray否

云盘事件标签列表，用于筛选 24 小时内发生过这些事件类型的云盘。取值范围：

  • NoSnapshot：数据保护
  • BurstIOTriggered：突发 IO
  • CostOptimizationNeeded：成本优化
  • DiskSpecNotMatchedWithInstance：实例与磁盘规格不匹配
  • DiskIONo4kAligned：非 4K 对齐读写
  • DiskIOHang：磁盘有 IOHang 发生
  • InstanceIOPSExceedInstanceMaxLimit：实例 IOPS 到达上限
  • InstanceBPSExceedInstanceMaxLimit：实例 BPS 到达上限
  • DiskIOPSExceedInstanceMaxLimit：磁盘 IOPS 到达实例上限
  • DiskBPSExceedInstanceMaxLimit：磁盘 BPS 到达实例上限
  • DiskIOPSExceedDiskMaxLimit：磁盘 IOPS 到达磁盘上限
  • DiskBPSExceedDiskMaxLimit：磁盘 BPS 到达磁盘上限
  • DiskSlowIOTriggerred：磁盘存在慢 IO
string否

云盘事件标签。

NoSnapshot
NextTokenstring否

查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。

caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger否

分页查询时每页行数。最大值为 100。 默认值：

  • 默认值为 10。

  • 当设置的值大于 100 时，默认值为 100。

10

返回参数

名称类型描述示例值
object

DescribeLensMonitorDisksResponse

DiskInfosobject []

云盘信息列表。

DiskIdstring

云盘 ID。

d-cd401****
DiskNamestring

云盘名称。

disk-28c6b****
DiskTypestring

云盘类型。可能值：

  • system：系统盘。
  • data：数据盘。
system
DiskStatusstring

云盘状态。可能值：

  • Available：使用中。
  • Deleted：已删除。
Available
RegionIdstring

地域 ID。

cn-hangzhou
DiskCategorystring

云盘类型。取值范围：

  • cloud：普通云盘。
  • cloud_efficiency：高效云盘。
  • cloud_ssd：SSD 盘。
  • cloud_essd：ESSD 云盘。
  • cloud_auto：ESSD AutoPL 云盘。
  • cloud_essd_entry：ESSD Entry 云盘。
cloud_essd
PerformanceLevelstring

ESSD 云盘的性能等级。可能值：

  • PL0：单盘最高随机读写 IOPS 1 万。
  • PL1：单盘最高随机读写 IOPS 5 万。
  • PL2：单盘最高随机读写 IOPS 10 万。
  • PL3：单盘最高随机读写 IOPS 100 万。
PL0
Tagsobject []

云盘的标签集合。

TagValuestring

标签值。

user
TagKeystring

标签键。

tag1
ZoneIdstring

云盘所属的可用区 ID。

cn-hangzhou-j
Sizeinteger

云盘大小，单位为 GiB。

64
Iopsinteger

每秒读写（I/O）操作的次数上限，单位：次/s。

4000
Bpsinteger

每秒读写（I/O）成功传输的数据数量上限，单位：MB/s。

300
ProvisionedIopsinteger

ESSD AutoPL 云盘预配置的读写 IOPS。可能值：0~min{50000, 1000*容量-基准性能}。

基准性能=min{1,800+50*容量, 50,000}。

当DiskCategory取值为cloud_auto时才支持设置该参数。更多信息，请参见ESSD AutoPL 云盘。

4000
BurstingEnabledboolean

是否开启 Burst（性能突发）。可能值：

  • true：是。
  • false：否。

当DiskCategory取值为cloud_auto时才支持设置该参数。更多信息，请参见ESSD AutoPL 云盘。

true
LensTagsarray

云盘的事件标签集合。事件标签展示云盘 24 小时内发生过的事件，相比事件有 1 小时之内的延迟。

string

云盘的事件标签。

["NoSnapshot", "DiskIOHang"]
NextTokenstring

查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。

caeba0bbb2be03f84eb48b699f0a****
TotalCountlong

查询结果总条数。

6
RequestIdstring

请求 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\"]"
      ]
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "TotalCount": 6,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe parameter %s is invalid.参数错误
400InvalidParameter.ConflictThe specified parameter %s and %s are not blank at the same time.参数冲突
400InvalidParameter.FormatSpecified parameter format is not valid.返回值格式不正确（Format 不支持）。返回格式支持 XML 与 JSON，默认为 XML。
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.参数缺失。
403ForbiddenUser is not authorized to operate.当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403Forbidden.ActionUser is not authorized to operate this action.当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.您的账户余额不足。
403LastTokenProcessingThe last token request is processing.相同clientToken的请求正在执行，请稍后再重试。
403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.当前用户无权限创建SLR。
403OperationDeniedThe operation is not allowed.当前操作不允许执行。
404InvalidApi.NotFoundSpecified api is not found, please check your url and method.找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确，请注意确认大小写。
404NoSuchResourceThe specified resource does not exist.指定的资源不存在。
429BLOCK.LimitedRequestRequest was denied due to user flow control.-
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
504RequestTimeoutThe request is timeout, please try again later.该请求超时，请稍后再重试。

访问错误中心查看更多错误码。
文档推荐
  • 本页导读 （1）
文档反馈