DescribeParameterGroup - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the information about a parameter template.

Operation description

Supported database engines

MySQL
PostgreSQL

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
rds:DescribeParameterGroup	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ParameterGroupId	string	Yes	The parameter template ID. You can call the DescribeParameterGroups operation to query the parameter template ID.	rpg-dp****
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	498AE8CA-8C81-4A01-AF37-2B902014ED30
ParamGroup	array<object>	The information about the parameter template.
ParameterGroup	object
UpdateTime	string	The time when the parameter template was last updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-10-22T06:07:54Z
ParameterGroupDesc	string	The description of the parameter template.	testGroup1
CreateTime	string	The time when the parameter template was created.	2019-10-22T06:02:53Z
ForceRestart	integer	Indicates whether the restart of an instance is required for the parameter template to take effect. Valid values: 0: A restart is not required. 1: A restart is required.	1
ParameterGroupId	string	The ID of the parameter template.	rpg-dp****
ParameterGroupName	string	The name of the parameter template.	test123456
Engine	string	The database engine of the instance.	mysql
ParamCounts	integer	The number of parameters in the parameter template.	2
EngineVersion	string	The database engine version of the instance.	5.6
ParameterGroupType	integer	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
ParamDetail	array<object>	The details of the parameters.
ParameterDetail	object
ParamName	string	The name of the parameter.	back_log
ParamValue	string	The value of the parameter.	2000
RelatedCustinsInfo	array<object>	The information about the instance to which the parameter template is applied. Note This parameter is available only for ApsaraDB RDS for PostgreSQL instances.
RelatedCustinsInfo	object
DBInstanceName	string	The instance ID.	rm-bp170****
AppliedTime	string	The time when the parameter template was applied.	2022-10-17T03:19:02Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "498AE8CA-8C81-4A01-AF37-2B902014ED30",
  "ParamGroup": {
    "ParameterGroup": [
      {
        "UpdateTime": "2019-10-22T06:07:54Z",
        "ParameterGroupDesc": "testGroup1",
        "CreateTime": "2019-10-22T06:02:53Z",
        "ForceRestart": 1,
        "ParameterGroupId": "rpg-dp****",
        "ParameterGroupName": "test123456",
        "Engine": "mysql",
        "ParamCounts": 2,
        "EngineVersion": "5.6",
        "ParameterGroupType": 1,
        "ParamDetail": {
          "ParameterDetail": [
            {
              "ParamName": "back_log",
              "ParamValue": "2000"
            }
          ]
        }
      }
    ]
  },
  "RelatedCustinsInfo": {
    "RelatedCustinsInfo": [
      {
        "DBInstanceName": "rm-bp170****",
        "AppliedTime": "2022-10-17T03:19:02Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParamGroupsNotExist	The specified paramGroups does not exist.	The parameter template cannot be found. You can call the DescribeParameterGroups operation to query the parameter templates that are available to a specified region.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.

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

Change history

Change time	Summary of changes	Operation
2022-10-14	The Error code has changed. The response structure of the API has changed	View Change Details