Use DescribeDBResourceGroup to query resource group information - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries the resource group information of a cluster.

Operation description

For the service registration of this service, see Endpoint.

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

list

*DBClusterLakeVersion

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the 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 specified 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 in Data Lakehouse Edition, see Resource group introduction.	Job
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query the region ID of the cluster.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	A94B6C02-7BD4-5D67-9776-3AC8317E8DD3
GroupsInfo	array<object>	The list of resource group information.
	array<object>	The list of resource group information.
GroupType	string	The resource group type. Valid values: Interactive Job Note For more information about resource groups of the Data Lakehouse Edition, see Resource group introduction (Data Lakehouse Edition).	Job
GroupName	string	The resource group name.	test1
MinComputeResource	string	The minimum reserved computing resources, in ACUs.	0ACU
MaxComputeResource	string	The maximum reserved computing resources, in ACUs.	512ACU
ClusterSizeResource	string	A reserved parameter. Not applicable.	Reserved parameter
MinClusterCount	integer	A reserved parameter. Not applicable.	Reserved parameter
MaxClusterCount	integer	A reserved parameter. Not applicable.	Reserved parameter
RunningClusterCount	integer	A reserved parameter. Not applicable.	Reserved parameter
ClusterMode	string	A reserved parameter. Not applicable.	Reserved parameter
ElasticMinComputeResource	string	The minimum elastic computing resources, in ACUs.	16ACU
EnableSpot	string	Indicates whether the spot instance feature is enabled for the resource group. After the spot instance feature is enabled, the unit price of resources is reduced, but the resources may be released. Valid values: True: The spot instance feature is enabled. False: The spot instance feature is disabled. Only Job-type resource groups can be set to True.	True
GroupUsers	string	The Resource Access Management (RAM) users attached to the resource group.	testb,testc
CreateTime	string	The time when the resource group was created, in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2022-08-29T03:34:30Z
UpdateTime	string	The time when the resource group was last updated, in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2022-08-31T03:34:30Z
Status	string	The resource group status. Valid values: Pending: being created. Running: running. Scaling: being scaled. Deleting: being deleted. Deleted: deleted.	Running
Rules	array<object>	The job routing rules.
	object	The list of rule information.
GroupName	string	The resource group name.	user_default
QueryTime	string	The query execution time threshold, in milliseconds (ms).	180000
TargetGroupName	string	The name of the target resource group.	job
Engine	string	The engine type.	AnalyticDB
Message	string	The job routing rule message.	SUCCESS
AutoStopInterval	string	The automatic stop interval, in the format of a number followed by m (minutes). The value ranges from 0m or 5m to 10080m. A value of 0m indicates that automatic stop is disabled.	0m
SpecName	string	The specification name.	ADB.MLLarge.2
TargetResourceGroupName	string	The name of the target resource group.	test
MinGpuQuantity	integer	The minimum number of GPUs.	1
MaxGpuQuantity	integer	The maximum number of GPUs.	2
RayConfig	object	The Ray configuration information.
EnableUserEni	boolean	Indicates whether ENI is enabled.
HeadSpecType	string	The resource type of the head node.	cpu
HeadSpec	string	The node specifications of the head node.	ADB.MLLarge.2
HeadAllocateUnit	string	The allocation unit of the head node.	1
HeadDiskCapacity	string	The disk capacity of the head node.	100Gi
Category	string	The Ray cluster type. Valid values: BASIC: basic type, non-high-availability. HIGH_AVAILABILITY: high-availability type.	BASIC
WorkerGroups	array<object>	The list of Ray worker groups.
	object	The list of Ray worker groups.
GroupName	string	The name of the Ray worker group.	g01
AllocateUnit	string	The allocation unit.	1
MaxWorkerQuantity	integer	The maximum number of workers.	1
MinWorkerQuantity	integer	The minimum number of workers.	1
WorkerDiskCapacity	string	The disk capacity per worker.	100G
WorkerSpecName	string	The worker specification name.	large
WorkerSpecType	string	The Ray worker resource type.	CPU
RayClusterAddress	string	The Ray cluster address.	http://ray-cluster-address.example.com
RayDashboardAddress	string	The Ray Dashboard address.	http://ray-dashboard-address.example.com
RayGrafanaAddress	string	The Ray Grafana address.	http://ray-grafana-address.example.com
RayServePublicAddress	string	The Ray Serve public address.	1.2.3.4:8100
AppConfig	object	The Ray application configuration.
AppName	string	The Ray application name.	app01
AppType	string	The Ray application type.	IsaacLab
ImageSelector	object	The image configuration.
Image	string	The image.	lab2.10.0-ray2.43.0
InferenceEngine	string	The inference engine.	vLLM
LlmModel	string	The LLM model.	Deepseek-R1
StorageMounts	array<object>	The list of storage mounts.
	object	The storage mount.
StorageId	integer	The storage ID.	1
MountPath	string	The mount path.	/mnt/data01
StorageName	string
UserDefinedRequirements	string
GpuElasticPlan	object	The GPU time-sharing elastic plan.
Enabled	boolean	Indicates whether the plan is enabled.	false
Rules	array<object>	The list of rules.
	object	The rule.
StartCronExpression	string	The start time in cron expression format. The interval must be at least 1 hour.	0 0 2 * * ?
EndCronExpression	string	The end time in cron expression format. The interval must be at least 1 hour.	0 0 3 * * ?
ScalePolicy	string	The scaling policy of the resource group. Valid values: AutoScaling: enables the AutoScaling automatic scaling policy. Disable: disables automatic scaling. MultiCluster: enables the MultiCluster automatic scaling policy.	AutoScaling
Classification	string	The classification of the resource group. Valid values: SQL SparkSQL MultiCluster AI	SQL
EngineParams	object	The engine parameters.
	any	The engine parameters.	{\"spark.adb.version\":\"3.5\"}
AtmConfig	object	The PromQL resource group configuration.
InsertNodeSpec	string	The node specifications of write nodes.	8ACU
InsertNodeNum	string	The number of write nodes.	1
SelectNodeSpec	string	The node specifications of query nodes.	8ACU
SelectNodeNum	string	The number of query nodes.	1
SelectNodeCacheSize	string	The cache size of query nodes.	10
StorageNodeSpec	string	The node specifications of storage nodes.	8ACU
StorageNodeNum	string	The number of storage nodes.	2
StorageNodeDiskSize	string	The disk size of storage nodes.	100
StorageNodeDiskType	string	The disk type of storage nodes.	essd_pl1
AuthNodeSpec	string	The node specifications of authentication nodes.	8ACU
AuthNodeNum	string	The number of authentication nodes.	2

Examples

Success response

JSON format

{
  "RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD3",
  "GroupsInfo": [
    {
      "GroupType": "Job",
      "GroupName": "test1",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "512ACU",
      "ClusterSizeResource": "Reserved parameter",
      "MinClusterCount": 0,
      "MaxClusterCount": 0,
      "RunningClusterCount": 0,
      "ClusterMode": "Reserved parameter",
      "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": "AnalyticDB",
      "Message": "SUCCESS",
      "AutoStopInterval": "0m",
      "SpecName": "ADB.MLLarge.2",
      "TargetResourceGroupName": "test",
      "MinGpuQuantity": 1,
      "MaxGpuQuantity": 2,
      "RayConfig": {
        "EnableUserEni": false,
        "HeadSpecType": "cpu",
        "HeadSpec": "ADB.MLLarge.2",
        "HeadAllocateUnit": "1",
        "HeadDiskCapacity": "100Gi",
        "Category": "BASIC",
        "WorkerGroups": [
          {
            "GroupName": "g01",
            "AllocateUnit": "1",
            "MaxWorkerQuantity": 1,
            "MinWorkerQuantity": 1,
            "WorkerDiskCapacity": "100G",
            "WorkerSpecName": "large",
            "WorkerSpecType": "CPU"
          }
        ],
        "RayClusterAddress": "http://ray-cluster-address.example.com",
        "RayDashboardAddress": "http://ray-dashboard-address.example.com",
        "RayGrafanaAddress": "http://ray-grafana-address.example.com",
        "RayServePublicAddress": "1.2.3.4:8100",
        "AppConfig": {
          "AppName": "app01",
          "AppType": "IsaacLab",
          "ImageSelector": {
            "Image": "lab2.10.0-ray2.43.0",
            "InferenceEngine": "vLLM",
            "LlmModel": "Deepseek-R1"
          }
        },
        "StorageMounts": [
          {
            "StorageId": 1,
            "MountPath": "/mnt/data01",
            "StorageName": ""
          }
        ],
        "UserDefinedRequirements": ""
      },
      "GpuElasticPlan": {
        "Enabled": false,
        "Rules": [
          {
            "StartCronExpression": "0 0 2 * * ?",
            "EndCronExpression": "0 0 3 * * ?"
          }
        ]
      },
      "ScalePolicy": "AutoScaling",
      "Classification": "SQL",
      "EngineParams": {
        "key": "{\\\"spark.adb.version\\\":\\\"3.5\\\"}"
      },
      "AtmConfig": {
        "InsertNodeSpec": "8ACU",
        "InsertNodeNum": "1",
        "SelectNodeSpec": "8ACU",
        "SelectNodeNum": "1",
        "SelectNodeCacheSize": "10",
        "StorageNodeSpec": "8ACU",
        "StorageNodeNum": "2",
        "StorageNodeDiskSize": "100",
        "StorageNodeDiskType": "essd_pl1",
        "AuthNodeSpec": "8ACU",
        "AuthNodeNum": "2"
      }
    }
  ]
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.