Disk IOPS Monitoring API Reference (DescribeDiskIopsList) - ENS

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

ens:DescribeDiskIopsList

none

*disk

acs:ens::{#accountId}:disk/{#DiskId}

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the format of yyyy-MM-dd HH:mm:ss.	2023-12-14 00:00:00
EndTime	string	Yes	The beginning of the time range to query. Specify the time in the format of yyyy-MM-dd HH:mm:ss. The time range specified by the StartTime and EndTime parameters cannot exceed one day for a query.	2023-12-14 23:59:59
DiskId	string	Yes	The ID of the disk. Format: d-***********.	d-5tzm9wnhzlhjzcbtxo465****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	A7814CAB-DB4E-140A-9D6F-7C8210C1DAC3
DiskIopsList	array<object>	The IOPS monitoring data of the cloud disk.
	object
DiskId	string	The ID of the disk.	d-5tzm9wnhzlhjzcbtxo465****
RegionId	string	The ID of the node.	cn-hangzhou-3
ReadBytes	integer	The read throughput. Unit: bytes.	10054
ReadLatency	integer	The read latency. Unit: ms.	15646532
ReadOps	integer	The read IOPS.	4
WriteBytes	integer	The write throughput. Unit: bytes.	0
WriteLatency	integer	The write latency. Unit: microseconds.	0
WriteOps	integer	The write IOPS.	0
BizTime	string	The business time . The time is displayed in the yyyy-MM-dd HH:mm:ss.	2023-12-14 00:00:00

Examples

Success response

JSON format

{
  "RequestId": "A7814CAB-DB4E-140A-9D6F-7C8210C1DAC3",
  "DiskIopsList": [
    {
      "DiskId": "d-5tzm9wnhzlhjzcbtxo465****",
      "RegionId": "cn-hangzhou-3",
      "ReadBytes": 10054,
      "ReadLatency": 15646532,
      "ReadOps": 4,
      "WriteBytes": 0,
      "WriteLatency": 0,
      "WriteOps": 0,
      "BizTime": "2023-12-14 00:00:00"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.