DescribeParameterGroups - PolarDB - Alibaba Cloud Documentation Center

Queries parameter templates that are available in a specified region.

Operation description

You can use parameter templates to manage multiple parameters at a time and apply existing parameters to a PolarDB cluster. For more information, see Use a parameter template.

Note This operation is applicable only to PolarDB for MySQL clusters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:DescribeParameterGroups	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the cluster. Note You can call the DescribeRegions operation to query all regions that are available for your account, such as the region ID.	cn-hangzhou
DBType	string	No	The type of the database engine. Only MySQL is supported.	MySQL
DBVersion	string	No	The version of the database engine. Valid values: 5.6 5.7 8.0	8.0
ResourceGroupId	string	No	The ID of the resource group to which the virtual node belongs.	rg-************

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	944CED46-A6F7-40C6-B6DC-C6E5CC******
ParameterGroups	array<object>	The details of parameter templates.
ParameterGroups	object
DBType	string	The type of the engine.	MySQL
DBVersion	string	The version of the database engine	8.0
ParameterGroupName	string	The name of the parameter template.	test
ForceRestart	string	Indicates whether to restart the cluster when this parameter template is applied. Valid values: 0: A restart is not required. 1: A restart is required.	1
ParameterGroupType	string	The type of the parameter template. Valid values: 0: the default parameter template. 1: a custom parameter template. 2: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings and saves the backup as a template.	1
ParameterCounts	long	The number of parameters in the parameter template.	2
ParameterGroupDesc	string	The description of the parameter template.	testgroup
CreateTime	string	The time when the parameter template was created. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2023-03-10T08:40:39Z
ParameterGroupId	string	The ID of the parameter template.	pcpg-**************

Examples

Sample success responses

JSONformat

{
  "RequestId": "944CED46-A6F7-40C6-B6DC-C6E5CC******",
  "ParameterGroups": [
    {
      "DBType": "MySQL",
      "DBVersion": "8.0",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterCounts": 2,
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterGroupId": "pcpg-**************"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	The specified RegionId parameter is invalid.
400	InvalidEngine.Unsupported	The specified Engine does not support this feature.	This feature is not supported by the specified engine.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details