Call the DescribeLensMonitorDisks API to query disk information - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries one or more block storage cloud disks that you have created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ebs:DescribeLensMonitorDisks

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the list of regions supported by EBS Lens.	cn-hangzhou
DiskIds	array	No	The list of cloud disk IDs.	['d-1', 'd-2']
	string	No	The cloud disk ID.	d-cd40hxfu0v*****
DiskCategory	string	No	The cloud disk type. Valid values: cloud: basic cloud disk. cloud_efficiency: ultra cloud disk. cloud_ssd: standard SSD. cloud_essd: Enterprise SSD (ESSD). cloud_auto: ESSD AutoPL cloud disk. cloud_essd_entry: ESSD Entry disk.	cloud_auto
LensTags	array	No	The list of cloud disk event tags, used to filter cloud disks that have experienced these event types within the last 24 hours. Valid values: NoSnapshot: data protection BurstIOTriggered: burst I/O CostOptimizationNeeded: cost optimization DiskSpecNotMatchedWithInstance: instance and cloud disk specifications do not match DiskIONo4kAligned: non-4K aligned read/write DiskIOHang: I/O hang occurred on the cloud disk InstanceIOPSExceedInstanceMaxLimit: instance IOPS reached the upper limit InstanceBPSExceedInstanceMaxLimit: instance BPS reached the upper limit DiskIOPSExceedInstanceMaxLimit: cloud disk IOPS reached the instance upper limit DiskBPSExceedInstanceMaxLimit: cloud disk BPS reached the instance upper limit DiskIOPSExceedDiskMaxLimit: cloud disk IOPS reached the disk upper limit DiskBPSExceedDiskMaxLimit: cloud disk BPS reached the disk upper limit
	string	No	The cloud disk event tag.	NoSnapshot
NextToken	string	No	The pagination token. Set this parameter to the NextToken value returned in the previous API call.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The maximum number of entries per page for a paged query. Maximum value: 100. Default value: The default value is 10. If the specified value is greater than 100, the default value of 100 is used.	10
DiskIdPattern	string	No	The regular expression pattern used for fuzzy match filtering of cloud disk IDs.	d-cd40hxfu0v*
		No	The ECS instance ID.	i-2zedroc0yv8z19ubnyos

Response elements

Element	Type	Description	Example
	object	DescribeLensMonitorDisksResponse
DiskInfos	array<object>	The list of cloud disk information.
	array<object>	The cloud disk information.
Bps	integer	The maximum data throughput for read/write (I/O) operations per second. Unit: MB/s.	300
BurstingEnabled	boolean	Indicates whether burst (performance bursting) is enabled. Valid values: true: Enabled. false: Disabled. This parameter is supported only when DiskCategory is set to cloud_auto. For more information, see ESSD AutoPL cloud disk.	true
DiskCategory	string	The cloud disk type. Valid values: cloud: basic cloud disk. cloud_efficiency: ultra cloud disk. cloud_ssd: standard SSD. cloud_essd: Enterprise SSD (ESSD). cloud_auto: ESSD AutoPL cloud disk. cloud_essd_entry: ESSD Entry disk.	cloud_essd
DiskId	string	The cloud disk ID.	d-cd401****
DiskName	string	The cloud disk name.	disk-28c6b****
DiskStatus	string	The cloud disk status. Valid values: Available: in use. Deleted: deleted.	Available
DiskType	string	The cloud disk type. Valid values: system: system cloud disk. data: data cloud disk.	system
Iops	integer	The maximum number of read/write (I/O) operations per second. Unit: operations/s.	4000
LensTags	array	The collection of event tags for the cloud disk. Event tags display events that occurred on the cloud disk within the last 24 hours, with a delay of up to 1 hour compared to the actual events.
	string	The event tag of the cloud disk.	["NoSnapshot", "DiskIOHang"]
PerformanceLevel	string	The performance level (PL) of the ESSD cloud disk. Valid values: PL0: maximum random read/write IOPS of 10,000 per standard SSD. PL1: maximum random read/write IOPS of 50,000 per standard SSD. PL2: maximum random read/write IOPS of 100,000 per standard SSD. PL3: maximum random read/write IOPS of 1,000,000 per standard SSD.	PL0
ProvisionedIops	integer	The provisioned read/write IOPS of the ESSD AutoPL cloud disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline performance}. Baseline performance = min{1,800 + 50 × Capacity, 50,000}. This parameter is supported only when DiskCategory is set to cloud_auto. For more information, see ESSD AutoPL cloud disk.	4000
RegionId	string	The region ID.	cn-hangzhou
SharingEnabled	string	Indicates whether the cloud disk is a shared cloud disk.	true
Size	integer	The cloud disk size. Unit: GiB.	64
Tags	array<object>	The collection of tags for the cloud disk.
	object	The tag of the cloud disk.
TagKey	string	The tag key.	tag1
TagValue	string	The tag value.	user
ZoneId	string	The zone ID of the cloud disk.	cn-hangzhou-j
NextToken	string	The pagination token. Set this parameter to the NextToken value returned in the previous API call.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	The request ID. A request ID is returned regardless of whether the API call succeeds.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	The total number of entries returned.	6

Examples

Success response

JSON format

{
  "DiskInfos": [
    {
      "Bps": 300,
      "BurstingEnabled": true,
      "DiskCategory": "cloud_essd",
      "DiskId": "d-cd401****",
      "DiskName": "disk-28c6b****",
      "DiskStatus": "Available",
      "DiskType": "system",
      "Iops": 4000,
      "LensTags": [
        "[\"NoSnapshot\", \"DiskIOHang\"]"
      ],
      "PerformanceLevel": "PL0",
      "ProvisionedIops": 4000,
      "RegionId": "cn-hangzhou",
      "SharingEnabled": "true",
      "Size": 64,
      "Tags": [
        {
          "TagKey": "tag1",
          "TagValue": "user"
        }
      ],
      "ZoneId": "cn-hangzhou-j"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 6
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter %s is invalid.	The specified parameter value is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.	A parameter conflict occurred.
400	InvalidParameter.Format	Specified parameter format is not valid.	english description
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	The parameter must be specified.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User 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.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.	Your account balance is insufficient.
403	LastTokenProcessing	The last token request is processing.	The value of clientToken is used in another request that is being processed. Try again later.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.	You are not authorized to create service-linked roles.
403	OperationDenied	The operation is not allowed.	The operation is not supported.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.
429	BLOCK.LimitedRequest	Request was denied due to user flow control.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.