DescribeParameterGroup - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeParameterGroup operation to query information about a parameter template.

Operation Description

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.

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	READ	RDS acs:rds::{#accountId}:dbinstance/ RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The information about the parameter template.	498AE8CA-8C81-4A01-AF37-2B902014ED30
ParamGroup	object []	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.
UpdateTime	string	The description of the parameter template.	2019-10-22T06:07:54Z
ParameterGroupDesc	string	The time when the parameter template was created.	testGroup1
CreateTime	string	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.	2019-10-22T06:02:53Z
ForceRestart	integer	The ID of the parameter template.	1
ParameterGroupId	string	The name of the parameter template.	rpg-dp****
ParameterGroupName	string	The database engine.	test123456
Engine	string	The number of parameters in the parameter template.	mysql
ParamCounts	integer	The database engine version.	2
EngineVersion	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.	5.6
ParameterGroupType	integer	The array of parameters.	1
ParamDetail	object []	The name of the parameter.
ParamName	string	The value of the parameter.	back_log
ParamValue	string	The instance to which the parameter template was applied. NoteThe RelatedCustinsInfo parameter is available only for ApsaraDB RDS for PostgreSQL instances.	2000
RelatedCustinsInfo	object []	The ID of the instance.
DBInstanceName	string	The time when the parameter template was applied.	rm-bp170****
AppliedTime	string	You can configure a number of parameters at a time by using a parameter template and then apply the parameter template to instances. For more information, see Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances or Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances. NoteYou can apply parameter templates only to ApsaraDB RDS for MySQL instances and ApsaraDB RDS for PostgreSQL instances.	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 operation that you want to perform. Set the value to DescribeParameterGroup.	-
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 codes of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.