You can call the DescribeParameterTemplates operation to query the valid values and default values of parameters for an instance.
Before you call this operation, make sure that the instance runs one of the following database engines:
- MySQL 5.5, MySQL 5.6, MySQL 5.7, or MySQL 8.0
- SQL Server 2008 R2
- PostgreSQL 10, PostgreSQL 11, PostgreSQL 12, PostgreSQL 13, PostgreSQL 14, or PostgreSQL 15
- MariaDB 10.3
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeParameterTemplates | The operation that you want to perform. Set the value to DescribeParameterTemplates. |
ClientToken | String | No | ETnLKlblzczshOTUbOCz**** | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the generated token is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. |
Engine | String | Yes | mysql | The database engine of the instance. Valid values:
|
EngineVersion | String | Yes | 8.0 | The database engine version of the instance.
|
Category | String | No | Basic | The RDS edition of the instance. Valid values:
|
RegionId | String | No | cn-hangzhou | The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. |
DBInstanceId | String | Yes | rm-bp1imnm**** | The ID of the instance. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 0F9B7410-EC73-510C-B385-8339455C12C6 | The ID of the request. |
Engine | String | mysql | The database engine of the instance. |
ParameterCount | String | 2 | The number of parameters. |
EngineVersion | String | 8.0 | The database engine version of the instance. |
Parameters | Array of TemplateRecord | An array that consists of details about the parameters. | |
TemplateRecord | |||
CheckingCode | String | [0-1024] | The valid values of the parameter. |
ParameterName | String | loose_multi_blocks_ddl_count | The name of the parameter. |
ParameterValue | String | 0 | The default value of the parameter. |
ForceModify | String | true | Indicates whether the parameter can be reconfigured. Valid values:
|
ForceRestart | String | false | Indicates whether you must restart the instance for the modifications to take effect. Valid values:
|
ParameterDescription | String | Page numbers of multi blocks reading once in some ddl query. | The description of the parameter. |
Examples
Sample requests
http(s)://rds.aliyuncs.com/?Action=DescribeParameterTemplates
&ClientToken=ETnLKlblzczshOTUbOCz****
&Engine=mysql
&EngineVersion=8.0
&Category=Basic
&RegionId=cn-hangzhou
&DBInstanceId=rm-bp1imnm****
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeParameterTemplatesResponse>
<ParameterCount>2</ParameterCount>
<EngineVersion>8.0</EngineVersion>
<Parameters>
<TemplateRecord>
<ForceModify>true</ForceModify>
<CheckingCode>[OFF|ON]</CheckingCode>
<ParameterValue>OFF</ParameterValue>
<ForceRestart>false</ForceRestart>
<ParameterName>loose_recycle_scheduler</ParameterName>
<ParameterDescription>Switch of purge thread.</ParameterDescription>
</TemplateRecord>
<TemplateRecord>
<ForceModify>true</ForceModify>
<CheckingCode>[0-1024]</CheckingCode>
<ParameterValue>0</ParameterValue>
<ForceRestart>false</ForceRestart>
<ParameterName>loose_multi_blocks_ddl_count</ParameterName>
<ParameterDescription>Page numbers of multi blocks reading once in some ddl query.</ParameterDescription>
</TemplateRecord>
</Parameters>
<RequestId>0F9B7410-EC73-510C-B385-8339455C12C6</RequestId>
<Engine>mysql</Engine>
</DescribeParameterTemplatesResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"ParameterCount" : 2,
"EngineVersion" : "8.0",
"Parameters" : {
"TemplateRecord" : [ {
"ForceModify" : "true",
"CheckingCode" : "[OFF|ON]",
"ParameterValue" : "OFF",
"ForceRestart" : "false",
"ParameterName" : "loose_recycle_scheduler",
"ParameterDescription" : "Switch of purge thread."
}, {
"ForceModify" : "true",
"CheckingCode" : "[0-1024]",
"ParameterValue" : "0",
"ForceRestart" : "false",
"ParameterName" : "loose_multi_blocks_ddl_count",
"ParameterDescription" : "Page numbers of multi blocks reading once in some ddl query."
} ]
},
"RequestId" : "0F9B7410-EC73-510C-B385-8339455C12C6",
"Engine" : "mysql"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | Invalid.ParamGroupDBCategory | Invalid parameter group category | The error message returned because the categories of parameter groups are invalid. |
For a list of error codes, see Service error codes.