DescribeDBResourceGroup - AnalyticDB - Alibaba Cloud Documentation Center

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

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

There is currently no authorization information disclosed in the API.

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: Interactive Job 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

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	A94B6C02-7BD4-5D67-9776-3AC8317E8DD3
GroupsInfo	array<object>	The queried resource groups.
PoolInfo	object	The queried resource group.
GroupType	string	The type of the resource group. Valid values: Interactive Job Note For more information about resource groups, see Resource groups.	Job
GroupName	string	The name of the resource group.	test1
MinComputeResource	string	The minimum amount of reserved computing resources.	0ACU
MaxComputeResource	string	The maximum amount of reserved computing resources.	512ACU
ClusterSizeResource	string	A reserved parameter.	N/A
MinClusterCount	integer	A reserved parameter.	N/A
MaxClusterCount	integer	A reserved parameter.	N/A
RunningClusterCount	integer	A reserved parameter.	N/A
ClusterMode	string	A reserved parameter.	N/A
ElasticMinComputeResource	string	The minimum amount of elastic computing resources.	16ACU
EnableSpot	string	Indicates whether the preemptible instance feature is enabled for the resource group. After the preemptible instance feature is enabled, you are charged for resources at a lower unit price but the resources are probably released. Valid values: True False The True value is returned only for job resource groups.	True
GroupUsers	string	The Resource Access Management (RAM) user that is associated with the resource group.	testb,testc
CreateTime	string	The time when the resource group was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-08-29T03:34:30Z
UpdateTime	string	The time when the resource group was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-08-31T03:34:30Z
Status	string	The status of the resource group. Valid values: creating: The resource group is being created. ok: The resource group is created. pendingdelete: The resource group is pending to be deleted.	ok
Rules	array<object>	The job resubmission rules.
Rules	object
GroupName	string	The name of the resource group.	user_default
QueryTime	string	The execution duration of the query. Unit: milliseconds.	180000
TargetGroupName	string	The name of the destination resource group.	job

Examples

Sample success responses

JSONformat

{
  "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": "",
      "AutoStopInterval": "",
      "SpecName": "",
      "TargetResourceGroupName": "",
      "MinGpuQuantity": 0,
      "MaxGpuQuantity": 0
    }
  ]
}

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-10-16	The Error code has changed. The response structure of the API has changed	View Change Details
2024-09-29	The Error code has changed. The response structure of the API has changed	View Change Details
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