DescribeDBResourceGroup API Reference - AnalyticDB for PostgreSQL

Retrieves the details of one or more resource groups.

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

gpdb:DescribeDBResourceGroup

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specified region.	gp-xxxxxxxxx
ResourceGroupName	string	No	The name of the resource group. Note If this parameter is omitted, details for all resource groups are returned. Otherwise, only details for the specified resource group are returned.	testgroup

Response elements

Element	Type	Description	Example
	object	The returned information.
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
ResourceGroupItems	object
ResourceGroupItem	array<object>	The details of resource groups.
	array<object>	Details of a resource group.
ResourceGroupName	string	The name of the resource group.	testgroup
ResourceGroupConfig	string	The configuration of the resource group. Note `CpuRateLimit`: The percentage of CPU resources that the resource group can use. Unit: %. `MemoryLimit`: The percentage of memory resources that the resource group can use. Unit: %. `MemorySharedQuota`: The percentage of memory resources that can be shared among transactions in the resource group. Unit: %. Default value: 80. `MemorySpillRatio`: The memory usage threshold for memory-intensive transactions. When a transaction reaches this threshold, it spills data to disk. Unit: %. Default value: 0. `Concurrency`: The maximum concurrency for the resource group. Default value: 20.	{"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}
RoleList	object
Role	array	A list of associated roles.
	string	The role name.	testrole

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "ResourceGroupItems": {
    "ResourceGroupItem": [
      {
        "ResourceGroupName": "testgroup",
        "ResourceGroupConfig": "{\"CpuRateLimit\":10,\"MemoryLimit\":12,\"MemorySharedQuota\":20,\"MemorySpillRatio\":75,\"Concurrency\":3}",
        "RoleList": {
          "Role": [
            "testrole"
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.