DescribeDBResourceGroup - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about a resource group for an AnalyticDB for MySQL Data Warehouse Edition cluster.

Operation description

You can call this operation only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition that have 32 cores or more.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
adb:DescribeDBResourceGroup	get	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.	am-bp1ub9grke1****
GroupName	string	Yes	The name of the resource group.	USER_DEFAULT

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
GroupsInfo	array<object>	The queried resource groups.
	object	The queried resource group.
GroupType	string	The query execution mode. Valid values: interactive batch (default) Note For more information, see Query execution modes.	interactive
UpdateTime	string	The time when the resource group was updated.	2022-11-09 16:57:35.241
GroupName	string	The name of the resource group.	USER_DEFAULT
CreateTime	string	The time when the resource group was created.	2022-10-09 16:57:35.241
GroupUsers	string	The database accounts that are associated with the resource group. Multiple database accounts are separated by commas (,).	testb,testc
NodeNum	integer	The number of nodes. Each node provides 16 cores and 64 GB memory.	2
GroupUserList	array	The database accounts that are associated with the resource group.
	string	The database account that is associated with the resource group.	user1
DBClusterId	string	The cluster ID.	am-bp1ub9grke1****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "GroupsInfo": [
    {
      "GroupType": "interactive",
      "UpdateTime": "2022-11-09 16:57:35.241",
      "GroupName": "USER_DEFAULT",
      "CreateTime": "2022-10-09 16:57:35.241",
      "GroupUsers": "testb,testc",
      "NodeNum": 2,
      "GroupUserList": [
        "user1"
      ]
    }
  ],
  "DBClusterId": "am-bp1ub9grke1****"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.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.

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

Change history

Change time	Summary of changes	Operation
2024-07-01	The Error code has changed. The response structure of the API has changed	View Change Details