DescribeDiskIopsList - ENS - Alibaba Cloud Documentation Center

Queries the disk IOPS monitoring data.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ens:DescribeDiskIopsList	none	All Resources *	none	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 parameters

Parameter	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.
DiskIops	object
DiskId	string	The ID of the disk.	d-5tzm9wnhzlhjzcbtxo465****
RegionId	string	The ID of the node.	cn-hangzhou-3
ReadBytes	long	The read throughput. Unit: bytes.	10054
ReadLatency	long	The read latency. Unit: ms.	15646532
ReadOps	long	The read IOPS.	4
WriteBytes	long	The write throughput. Unit: bytes.	0
WriteLatency	long	The write latency. Unit: microseconds.	0
WriteOps	long	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

Sample success responses

JSONformat

{
  "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
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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