DescribeApsResourceGroups - AnalyticDB - Alibaba Cloud Documentation Center

Retrieves details about the resource groups used for data synchronization.

Operation description

Public endpoint for a region: adb.<region-id>.aliyuncs.com. Example: adb.cn-hangzhou.aliyuncs.com.
VPC endpoint for a region: adb-vpc.<region-id>.aliyuncs.com. Example: adb-vpc.cn-hangzhou.aliyuncs.com.

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:DescribeApsResourceGroups

none

*DBClusterLakeVersion

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Note Call the DescribeRegions operation to view the region ID of a cluster.	cn-hangzhou
DBClusterId	string	Yes	The ID of the Data Lakehouse Edition cluster. Note Call the DescribeDBClusters operation to view the cluster ID.	amv-bp1t6rym21****
WorkloadId	string	No	The ID of the data synchronization task.	aps-hz1686v37sx****

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	6FC370D7-1D4C-5A8E-805E-F73366382C66
Message	string	Additional information about the call. Valid values: Success is returned if the request is successful. An error code is returned if the request fails.	Success
HttpStatusCode	integer	The HTTP status code.	200
Data	object	The information about the resource groups.
Step	integer	The step size of the resource group, in ACU. If GroupType is Interactive, the step size is 16 ACU. If GroupType is Job, the step size is 8 ACU.	8
ResourceGroups	array<object>	The resource groups.
	object	The resource groups.
CuOptions	array	The resource gradient values.
	integer	The resource gradient value.	无
MaxComputeResource	integer	The maximum reserved computing resources, in ACU. If GroupType is Interactive, the maximum reserved computing resources are the current unallocated resources of the cluster, and the step size is 16 ACU. If GroupType is Job, the maximum reserved computing resources are the current unallocated resources of the cluster, and the step size is 8 ACU.	512
LeftComputeResource	integer	The remaining computing resources, in ACU.	512
MinComputeResource	integer	The minimum reserved computing resources, in ACU. If GroupType is Interactive, the minimum reserved computing resources are 16 ACU. If GroupType is Job, the minimum reserved computing resources are 0 ACU.	0
GroupName	string	The name of the resource group.	test
GroupType	string	The type of the resource group. Valid values: Interactive Job Note For more information about resource groups in Data Lakehouse Edition, see Resource groups.	Job
Available	boolean	Indicates whether the resource group is available. Valid values: True False	True
Success	boolean	Indicates whether the request was successful. Valid values: True False	True

Examples

Success response

JSON format

{
  "RequestId": "6FC370D7-1D4C-5A8E-805E-F73366382C66",
  "Message": "Success",
  "HttpStatusCode": 200,
  "Data": {
    "Step": 8,
    "ResourceGroups": [
      {
        "CuOptions": [
          0
        ],
        "MaxComputeResource": 512,
        "LeftComputeResource": 512,
        "MinComputeResource": 0,
        "GroupName": "test",
        "GroupType": "Job",
        "Available": true
      }
    ]
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.