DescribeApsResourceGroups - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about resource groups of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

Operation description

Regional public endpoint: adb.<region-id>.aliyuncs.com. Example: adb.cn-hangzhou.aliyuncs.com.
Regional Virtual Private Cloud (VPC) endpoint: adb-vpc.<region-id>.aliyuncs.com. Example: adb-vpc.cn-hangzhou.aliyuncs.com.

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:DescribeApsResourceGroups	none	*DBClusterLakeVersion `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.	amv-bp1t6rym21****
WorkloadId	string	No	The ID of the data synchronization job.	aps-hz1686v37sx****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	6FC370D7-1D4C-5A8E-805E-F73366382C66
Message	string	The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.	Success
HttpStatusCode	long	The HTTP status code.	200
Data	object	The queried resource groups.
Step	long	The step size of resources. Unit: AnalyticDB compute units (ACUs). If the value of GroupType is Interactive, 16 is returned. If the value of GroupType is Job, 8 is returned.	8
ResourceGroups	array<object>	The queried resource groups.
validPoolsInfo	object
MaxComputeResource	integer	The maximum amount of reserved computing resources. Unit: ACUs. If the value of GroupType is Interactive, the amount of reserved computing resources that are not allocated in the cluster is returned in increments of 16 ACUs. If the value of GroupType is Job, the amount of reserved computing resources that are not allocated in the cluster is returned in increments of 8 ACUs.	512
LeftComputeResource	integer	The amount of remaining computing resources. Unit: ACUs.	512
MinComputeResource	integer	The minimum amount of reserved computing resources. Unit: ACUs. If the value of GroupType is Interactive, 16 is returned. If the value of GroupType is Job, 0 is returned.	0
GroupName	string	The name of the resource group.	test
GroupType	string	The type of the resource group. Valid values: Interactive Job Note For more information about resource groups, see Resource groups.	Job
Available	boolean	Indicates whether the resource group is available. Valid values: true false	True
Success	boolean	Indicates whether the request was successful. Valid values: true false	True

Examples

Sample success responses

JSONformat

{
  "RequestId": "6FC370D7-1D4C-5A8E-805E-F73366382C66",
  "Message": "Success",
  "HttpStatusCode": 200,
  "Data": {
    "Step": 8,
    "ResourceGroups": [
      {
        "CuOptions": [
          0
        ],
        "MaxComputeResource": 512,
        "LeftComputeResource": 512,
        "MinComputeResource": 0,
        "GroupName": "test",
        "GroupType": "Job",
        "Available": true
      }
    ]
  },
  "Success": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-04-10	The request parameters of the API has changed	View Change Details
2023-05-09	The response structure of the API has changed	View Change Details