Use DescribeDBResourceGroup to query resource group information - AnalyticDB

Queries the resource group information for a cluster.

Operation description

For the access endpoint of this service, see Endpoints.

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 cluster ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition.	amv-bp11q28kvl688****
GroupName	string	No	The name of the resource group. Note If you do not specify this parameter, the system returns information about all resource groups in the specified cluster by default.	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 management.	Job
RegionId	string	No	The region ID. Note 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 type of the resource group. Valid values: Interactive Job Note For more information about resource groups, see Resource group management.	Job
GroupName	string	The name of the resource group.	test1
MinComputeResource	string	The minimum reserved computing resources, in ACU.	0ACU
MaxComputeResource	string	The maximum reserved computing resources, in ACU.	512ACU
ClusterSizeResource	string	Reserved parameter. Not applicable.	预留参数，不涉及
MinClusterCount	integer	Reserved parameter. Not applicable.	预留参数，不涉及
MaxClusterCount	integer	Reserved parameter. Not applicable.	预留参数，不涉及
RunningClusterCount	integer	Reserved parameter. Not applicable.	预留参数，不涉及
ClusterMode	string	Reserved parameter. Not applicable.	预留参数，不涉及
ElasticMinComputeResource	string	The minimum elastic computing resources, in ACU.	16ACU
EnableSpot	string	Enable Spot Instances for the resource group to reduce unit costs. But resouces may be reclaimed. Valid values: True: Enable. False: Disable. Only Job resource groups can be set to True.	True
GroupUsers	string	The RAM users bound to the resource group.	testb,testc
CreateTime	string	The creation time of the resource group. The time is in UTC and follows the yyyy-MM-ddTHH:mm:ssZ format.	2022-08-29T03:34:30Z
UpdateTime	string	The update time. The time is in UTC and follows the yyyy-MM-ddTHH:mm:ssZ format.	2022-08-31T03:34:30Z
Status	string	The status of the resource group. Valid values: creating: Creating ok: Created pendingdelete: Waiting for deletion	ok
Rules	array<object>	The job delivery rules.
	object	The list of rule information.
GroupName	string	The name of the resource group.	user_default
QueryTime	string	The threshold for query running time, in milliseconds (ms).	180000
TargetGroupName	string	The name of the target resource group.	job
Engine	string
Message	string
AutoStopInterval	string
SpecName	string
TargetResourceGroupName	string
MinGpuQuantity	integer
MaxGpuQuantity	integer
RayConfig	object
EnableUserEni	boolean
HeadSpecType	string
HeadSpec	string
HeadAllocateUnit	string
HeadDiskCapacity	string
Category	string
WorkerGroups	array<object>	The list of Ray Worker groups.
	object
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 size of each Worker.	100G
WorkerSpecName	string	The resource specifications of the Ray Worker.	large
WorkerSpecType	string	The resource type of the Ray Worker.	CPU
RayClusterAddress	string	The address of the Ray cluster.	http://ray-cluster-address.example.com
RayDashboardAddress	string	The address of the Ray Dashboard.	http://ray-dashboard-address.example.com
RayGrafanaAddress	string	The address of the Ray Grafana.	http://ray-grafana-address.example.com
AppConfig	object	The Ray application configuration.
AppName	string	The name of the Ray application.	app01
AppType	string	The type of the Ray application.	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 mounted storage.
	object	The mounted storage.
StorageId	integer	The storage ID.	1
MountPath	string	The mount path.	/mnt/data01
GpuElasticPlan	object
Enabled	boolean
Rules	array<object>
	object
StartCronExpression	string
EndCronExpression	string
ScalePolicy	string
Classification	string
EngineParams	object	The engine parameters.
	any	The engine parameters.

Examples

Success response

JSON format

{
  "RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD3",
  "GroupsInfo": [
    {
      "GroupType": "Job",
      "GroupName": "test1",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "512ACU",
      "ClusterSizeResource": "预留参数，不涉及",
      "MinClusterCount": 0,
      "MaxClusterCount": 0,
      "RunningClusterCount": 0,
      "ClusterMode": "预留参数，不涉及",
      "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": "",
      "Message": "",
      "AutoStopInterval": "",
      "SpecName": "",
      "TargetResourceGroupName": "",
      "MinGpuQuantity": 0,
      "MaxGpuQuantity": 0,
      "RayConfig": {
        "EnableUserEni": false,
        "HeadSpecType": "",
        "HeadSpec": "",
        "HeadAllocateUnit": "",
        "HeadDiskCapacity": "",
        "Category": "",
        "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",
        "AppConfig": {
          "AppName": "app01",
          "AppType": "IsaacLab",
          "ImageSelector": {
            "Image": "lab2.10.0-ray2.43.0",
            "InferenceEngine": "vLLM",
            "LlmModel": "Deepseek-R1"
          }
        },
        "StorageMounts": [
          {
            "StorageId": 1,
            "MountPath": "/mnt/data01"
          }
        ]
      },
      "GpuElasticPlan": {
        "Enabled": false,
        "Rules": [
          {
            "StartCronExpression": "",
            "EndCronExpression": ""
          }
        ]
      },
      "ScalePolicy": "",
      "Classification": "",
      "EngineParams": {
        "key": ""
      }
    }
  ]
}

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.