DescribeParameterGroups - PolarDB - Alibaba Cloud Documentation Center

Queries the list of database parameter templates created by users or supported by the system, including basic information, associated engine types, and modification times of each parameter template.

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

polardbx:DescribeParameterGroups

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region where the instance resides.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	9B2F3840-5C98-475C-B269-2D5C3A31797C
Data	object	The instance details.
RequestId	string	The request ID.	1E5DCFFC-A00D-****-836E-73318F8CA577
ParameterGroups	array<object>	The parameter template name.
	object	The list of parameter templates.
ParameterGroupId	string	The parameter template ID. Note You can call the DescribeParameterGroups operation to query the details of all parameter templates in the specified region, including the parameter template ID.	rpg-s1y1xy06****fqs7y
GmtCreated	string	The time when the account was created.	2024-12-19T16:41:31+08:00
GmtModified	string	The modification time, in timestamp format.	1605079985000
DbType	string	The database type.	polarx
DbVersion	string	The database engine version.	5.7
DnParamCount	integer	The number of DN parameters.	10
DnForceRestart	boolean	Indicates whether a forced restart of DN is required.
CnParamCount	integer	The number of CN parameters.	10
CnForceRestart	boolean	Indicates whether a forced restart of CN is required.
Series	string	The instance edition. Valid values: enterprise: Enterprise Edition. standard: Standard Edition.	enterprise
ParameterGroupName	string	The parameter template name.	dstest_api_new
ParameterGroupType	string	The parameter templatetype.	0

Examples

Success response

JSON format

{
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Data": {
    "RequestId": "1E5DCFFC-A00D-****-836E-73318F8CA577",
    "ParameterGroups": [
      {
        "ParameterGroupId": "rpg-s1y1xy06****fqs7y",
        "GmtCreated": "2024-12-19T16:41:31+08:00",
        "GmtModified": "1605079985000",
        "DbType": "polarx",
        "DbVersion": "5.7",
        "DnParamCount": 10,
        "DnForceRestart": false,
        "CnParamCount": 10,
        "CnForceRestart": false,
        "Series": "enterprise",
        "ParameterGroupName": "dstest_api_new",
        "ParameterGroupType": "0"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.