DescribeAPSADBInstances - AnalyticDB - Alibaba Cloud Documentation Center

Queries a list of AnalyticDB for MySQL clusters for AnalyticDB Pipeline Service (APS) federated analytics.

Operation description

You can call this operation to query the performance data of a cluster over a time range based on performance metrics. The collection granularity is 30 seconds. This operation allows you to query information about slow queries, such as the SQL query duration, number of scanned rows, and amount of scanned 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:
- For mandatory resource types, indicate with a prefix of * .
- 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
adb:DescribeAPSADBInstances	none	*DBClusterLakeVersion `acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page.	30
RegionId	string	Yes	The region ID.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	******
PageNumber	string	The page number.	1
PageSize	string	The number of entries per page.	30
TotalCount	string	The total number of entries returned.	100
Items	array<object>	The queried clusters.	-
DBCluster	object	The queried cluster.
DBClusterId	string	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.	am-bp1********
DBClusterDescription	string	The description of the cluster.	adb_test
ZoneId	string	The zone ID of the cluster.	cn-hangzhou-h
ComputeResource	string	The specifications of the reserved computing resources.	16ACU
StorageResource	long	The specifications of the reserved storage resources.	24ACU
ReservedACU	string	The amount of remaining reserved computing resources that are available in the cluster.	24ACU
DBClusterStatus	string	The status of the cluster.	Running
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The HTTP status code or the error code.	0
Message	string	The returned message. Valid values: If the request was successful, a success message is returned.**** If the request failed, an error message is returned.	Success
HttpStatusCode	integer	The HTTP status code.	200

Examples

Sample success responses

JSONformat

{
  "RequestId": "******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 100,
  "Items": [
    {
      "DBClusterId": "am-bp1********",
      "DBClusterDescription": "adb_test",
      "ZoneId": "cn-hangzhou-h",
      "ComputeResource": "16ACU",
      "StorageResource": 0,
      "ReservedACU": "24ACU",
      "DBClusterStatus": "Running"
    }
  ],
  "Success": true,
  "Code": 0,
  "Message": "Success",
  "HttpStatusCode": 200
}

Error codes

HTTP status code	Error code	Error message
400	InvalidInput	The specified parameter is invalid.

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