Query resource group information by using the DescribeDBResourceGroup operation - AnalyticDB - Alibaba Cloud - AnalyticDB

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

Operation description

This operation is suitable for the following editions:

Enterprise Edition.
Basic Edition.
Data Lakehouse Edition.
Data Warehouse Edition in elastic mode: 32 cores and 128 GB or more.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeDBResourceGroup

get

*DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

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	No	The name of the resource group.	USER_DEFAULT

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
GroupsInfo	array<object>	The queried resource group.
	array<object>	The resource group.
GroupType	string	The query execution mode. Valid values: interactive (default) batch job	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
MinComputeResource	string	The minimum amount of reserved computing resources. Unit: AnalyticDB compute unit (ACU). If the value of GroupType is interactive, 16ACU is returned. If the value of GroupType is job, 0ACU is returned.	0ACU
MaxComputeResource	string	The maximum amount of reserved computing resources, which refers to the amount of resources that are not allocated in the cluster. Unit: ACU. 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 16ACU. 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 8ACU.	32ACU
ClusterSizeResource	string	The resource specifications of a single compute cluster. Unit: ACU.	16ACU
MinClusterCount	integer	The minimum number of compute clusters that are required in the resource group. Minimum value: 1.	1
MaxClusterCount	integer	The maximum number of compute clusters that are allowed in the resource group. Maximum value: 10.	4
RunningClusterCount	integer	The number of compute clusters running in the resource group.	2
ClusterMode	string	The working mode of the resource group. Valid values: Disable (default) AutoScale	AutoScale
ElasticMinComputeResource	string	The minimum amount of elastic computing resources. Unit: ACU.	16ACU
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
Engine	string	The engine of the resource group. Valid values: AnalyticDB (default) SparkWarehouse	AnalyticDB
EngineParams	object	The Spark application configuration parameters that can be applied to all Spark jobs executed in the resource group. If you want to configure parameters for a specific Spark job, you can specify values for the parameters in the code editor when you submit the job.	{\"spark.adb.version\":\"3.5\"}
Status	string	The status of the resource group. Valid values: Pending Running Scaling Deleting Deleted	Running
ConnectionString	string	The endpoint of the resource group. Note This parameter is returned only when the value of Engine is SparkWarehouse.	amv-bp1nw64y******.ads.aliyuncs.com
Port	string	The port number of the resource group. Note This parameter is returned only when the value of Engine is SparkWarehouse.	3306
DBClusterId	string	The cluster ID.	am-bp1ub9grke1****

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "GroupsInfo": [
    {
      "GroupType": "interactive",
      "UpdateTime": "2022-11-09 16:57:35.241",
      "GroupName": "USER_DEFAULT",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "32ACU",
      "ClusterSizeResource": "16ACU",
      "MinClusterCount": 1,
      "MaxClusterCount": 4,
      "RunningClusterCount": 2,
      "ClusterMode": "AutoScale",
      "ElasticMinComputeResource": "16ACU",
      "CreateTime": "2022-10-09 16:57:35.241",
      "GroupUsers": "testb,testc",
      "NodeNum": 2,
      "GroupUserList": [
        "user1"
      ],
      "Engine": "AnalyticDB",
      "EngineParams": {
        "test": "test",
        "test2": 1
      },
      "Status": "Running",
      "ConnectionString": "amv-bp1nw64y******.ads.aliyuncs.com",
      "Port": "3306"
    }
  ],
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.