DescribeParameterGroup - PolarDB - Alibaba Cloud Documentation Center

Queries the information about a parameter template.

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 parameter is valid only for a PolarDB for MySQL cluster.

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:DescribeParameterGroup	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query all regions that are available within your account, such as the region ID.	cn-hangzhou
ParameterGroupId	string	Yes	The ID of the parameter template. Note You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.	pcpg-**************
ResourceGroupId	string	No	The ID of the resource group.	rg-************

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	F1F16757-D31B-49CA-9BF4-305BAF******
ParameterGroup	object []	Details about the parameter templates.
DBType	string	The type of the database 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	integer	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
ParameterDetail	object []	Details about the parameters.
ParamValue	string	The value of the parameter.	3000
ParamName	string	The name of the parameter.	back_log
ParameterGroupId	string	The ID of the parameter template.	pcpg-**************

Examples

Sample success responses

JSONformat

{
  "RequestId": "F1F16757-D31B-49CA-9BF4-305BAF******",
  "ParameterGroup": [
    {
      "DBType": "MySQL",
      "DBVersion": "8.0",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterCounts": 2,
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterDetail": [
        {
          "ParamValue": "3000",
          "ParamName": "back_log"
        }
      ],
      "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	InvalidParameterGroupId.Malformed	The Specified parameter ParameterGroupId is not valid.	The specified ParameterGroupId parameter is invalid.

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

Change history

Change time	Summary of changes	Operation

No change history