All Products
Search
Document Center

Elastic Compute Service:DescribeLensMonitorDisks

Last Updated:Sep 25, 2024

Queries one or more Elastic Block Storage (EBS) devices that you created.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ebs:DescribeLensMonitorDiskslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
DiskIdsarrayNo

The list of disks.

DiskIdstringNo

The list of disks.

d-cd40hxfu0v*****
DiskCategorystringNo

The type of the disk. Valid values:

  • cloud
  • cloud_efficiency
  • cloud_ssd
  • cloud_essd
  • cloud_auto
  • cloud_essd_entry
cloud_auto
LensTagsarrayNo

Event tags of the disk, which are used to filter the disks on which the events associated with the specified tags occurred in the previous 24 hours. Valid values:

  • NoSnapshot: specifies the event that is triggered because no snapshot is created for the disk to protect data on the disk.
  • BurstIOTriggered: specifies the event that is triggered when a burst I/O operation is performed on the disk.
  • CostOptimizationNeeded: specifies the event that is triggered when cost optimization is required.
  • DiskSpecNotMatchedWithInstance: specifies the event that is triggered if the disk specifications do not match the instance to which the disk is attached.
  • DiskIONo4kAligned: specifies the event that is triggered if the physical and logical sectors involved in a read or write operation are not 4K aligned.
  • DiskIOHang: specifies the event that is triggered when an I/O hang occurs on the disk.
  • InstanceIOPSExceedInstanceMaxLimit: specifies the event that is triggered when the number of IOPS on the instance reaches the upper limit.
  • InstanceBPSExceedInstanceMaxLimit: specifies the event that is triggered when the number of BPS on the instance reaches the upper limit.
  • DiskIOPSExceedInstanceMaxLimit: specifies the event that is triggered when the number of IOPS on the disk reaches the upper limit of the instance.
  • DiskBPSExceedInstanceMaxLimit: specifies the event that is triggered when the number of BPS on the disk reaches the upper limit of the instance.
  • DiskIOPSExceedDiskMaxLimit: specifies the event that is triggered when the number of IOPS on the disk reaches the upper limit of the disk.
  • DiskBPSExceedDiskMaxLimit: specifies the event that is triggered when the number of BPS on the disk reaches the upper limit of the disk.
  • DiskSlowIOTriggerred: specifies the event that is triggered when the I/O speed on the disk is slow.
stringNo

Event tags of the disk.

NoSnapshot
NextTokenstringNo

The token used to start the next query to retrieve more results.

Note The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of NextToken.
caeba0bbb2be03f84eb48b699f0a****
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object

DescribeLensMonitorDisksResponse

DiskInfosarray<object>

Cloud disk information list.

DiskInfoobject
DiskIdstring

The ID of the disk.

d-cd401****
DiskNamestring

The name of the disk.

disk-28c6b****
DiskTypestring

The disk type. Valid values:

  • system: system disk
  • data: data disk
system
DiskStatusstring

The disk status. Valid values:

  • Available
  • Deleted
Available
RegionIdstring

The region ID of the disk.

cn-hangzhou
DiskCategorystring

The type of the disk. Valid values:

  • cloud
  • cloud_efficiency
  • cloud_ssd
  • cloud_essd
  • cloud_auto
  • cloud_essd_entry
cloud_essd
PerformanceLevelstring

The new performance level of the ESSD. Valid values:

  • PL0: An ESSD can deliver up to 10,000 random read/write IOPS.
  • PL1: An ESSD can deliver up to 50,000 random read/write IOPS.
  • PL2: An ESSD can deliver up to 100,000 random read/write IOPS.
  • PL3: An ESSD delivers up to 1,000,000 random read/write IOPS.
PL0
Tagsarray<object>

Tags of the disk.

Tagobject

The tags.

TagValuestring

The tag value.

user
TagKeystring

The tag key.

tag1
ZoneIdstring

The ID of the zone.

cn-hangzhou-j
Sizeinteger

The size of the disk. Unit: GiB.

64
Iopsinteger

The IOPS.

4000
Bpsinteger

The BPS.

300
ProvisionedIopsinteger

The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}

Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}

Note This parameter is available only if the DiskCategory parameter is set to cloud_auto. For more information, see ESSD AutoPL disks
4000
BurstingEnabledboolean

Indicates whether the performance burst feature is enabled. Valid values:

  • true
  • false

This parameter is available only if you set DiskCategory to cloud_auto. For more information, see ESSD AutoPL disks.

true
LensTagsarray

Event tags of the disk.

LensTagstring

Event tags of the disk.

["NoSnapshot", "DiskIOHang"]
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

caeba0bbb2be03f84eb48b699f0a****
TotalCountlong

The total number of entries returned.

6
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Sample success responses

JSONformat

{
  "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****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe parameter %s is invalid.The specified parameter value is invalid.
400InvalidParameter.ConflictThe specified parameter %s and %s are not blank at the same time.-
400InvalidParameter.FormatSpecified parameter format is not valid.english description
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.The parameter must be specified.
403ForbiddenUser is not authorized to operate.You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403Forbidden.ActionUser is not authorized to operate this action.You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.-
403LastTokenProcessingThe last token request is processing.The value of clientToken is used in another request that is being processed. Try again later.
403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.You are not authorized to create service-linked roles.
403OperationDeniedThe operation is not allowed.The operation is not supported.
404InvalidApi.NotFoundSpecified api is not found, please check your url and method.-
404NoSuchResourceThe specified resource does not exist.The 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.An internal error has occurred.
504RequestTimeoutThe request is timeout, please try again later.The request has timed out. Try again later.

For a list of error codes, visit the Service error codes.