Queries the information about resource groups of an AnalyticDB for MySQL cluster.
Operation description
For information about the endpoints of AnalyticDB for MySQL, see Endpoints .
Debugging
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 |
---|---|---|---|---|
adb:DescribeDBResourceGroup | list |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterId | string | Yes | The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. | amv-bp11q28kvl688**** |
GroupName | string | No | The name of the resource group. Note
If you do not specify this parameter, the information about all resource groups in the cluster is returned.
| test_group |
GroupType | string | No | The type of the resource group. Valid values:
Note
For more information about resource groups, see Resource group overview.
| Job |
RegionId | string | No | The region ID of the cluster. Note
You can call the DescribeRegions operation to query the most recent region list.
| cn-hangzhou |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD3",
"GroupsInfo": [
{
"GroupType": "Job",
"GroupName": "test1",
"MinComputeResource": "0ACU",
"MaxComputeResource": "512ACU",
"ClusterSizeResource": "N/A\n",
"MinClusterCount": 0,
"MaxClusterCount": 0,
"RunningClusterCount": 0,
"ClusterMode": "N/A\n",
"ElasticMinComputeResource": "16ACU",
"EnableSpot": "True",
"GroupUsers": "testb,testc",
"CreateTime": "2022-08-29T03:34:30Z",
"UpdateTime": "2022-08-31T03:34:30Z",
"Status": "ok",
"Rules": [
{
"GroupName": "user_default",
"QueryTime": "180000",
"TargetGroupName": "job"
}
],
"Engine": "",
"EngineParams": {
"test": "test",
"test2": 1
},
"Message": ""
}
]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidPoolName.Malformed | The specified parameter PoolName is not valid. | The PoolName parameter is invalid. Check the parameter. |
400 | InvalidPoolUser.Malformed | The specified parameter PoolUser is not valid. | The PoolUser parameter is invalid. Check the parameter. |
400 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid. |
400 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | The DBClusterId parameter is invalid. Check the parameter. |
400 | InvalidPoolType.Malformed | The specified parameter PoolType is not valid. | The PoolType parameter is invalid. Check the parameter. |
400 | InvalidMinComputeResource.Malformed | The specified parameter MinComputeResource is not valid. | The MinComputeResource parameter is invalid. Check the parameter. |
400 | InvalidMaxComputeResource.Malformed | The specified parameter MaxComputeResource is not valid. | The MaxComputeResource parameter is invalid. Check the parameter. |
408 | AcsServerTimeOut | The request has failed due to Adb Cloud Service time out. | The backend service timed out. Please try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-14 | The Error code has changed. The response structure of the API has changed | View Change Details |
2024-03-25 | The Error code has changed. The response structure of the API has changed | View Change Details |
2024-03-01 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2024-01-26 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-09-25 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-03-31 | The Error code has changed | View Change Details |