调用DescribeParameterTemplates接口查询数据库参数模板。
该接口适用的实例版本如下:
- MySQL 5.5、5.6、5.7、8.0
- SQL Server 2008 R2
- PostgreSQL 9.4、10、11、12
- PPAS 9.3、10.0
- MariaDB 10.3
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeParameterTemplates |
系统规定参数,取值:DescribeParameterTemplates。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxxxxx |
实例ID。 |
Engine | String | 是 | mysql |
数据库类型,取值:
|
EngineVersion | String | 是 | 5.6 |
数据库版本号,取值:
|
ClientToken | String | 否 | ETnLKlblzczshOTUbOCzxxxxxxx |
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
Category | String | 否 | Basic |
实例系列,取值:
|
RegionId | String | 否 | cn-hangzhou |
地域ID。可以通过接口DescribeRegions查看可用的地域ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Engine | String | MySQL |
数据库类型。 |
EngineVersion | String | 5.5 |
数据库版本号。 |
ParameterCount | String | 56 |
参数个数。 |
Parameters | Array |
参数列表。 |
|
TemplateRecord | |||
ParameterName | String | auto_increment_increment |
参数名。 |
ParameterValue | String | 1 |
参数默认值。 |
ForceModify | String | true |
参数是否可修改,取值:true | false |
ForceRestart | String | false |
是否重启才生效,取值:true | false |
CheckingCode | String | [10-3000] |
参数取值范围。 |
ParameterDescription | String | determines the starting point for the AUTO_INCREMENT column value. |
参数描述。 |
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
请求ID。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeParameterTemplates
&Engine=MySQL
&EngineVersion=5.6
&<公共请求参数>
正常返回示例
XML
格式
<DescribeParameterTemplatesResponse>
<Engine>mssql</Engine>
<EngineVersion>2008r2</EngineVersion>
<ParameterCount>1</ParameterCount>
<Parameters>
<TemplateRecord>
<CheckingCode>[0-100]</CheckingCode>
<ForceRestart>True</ForceRestart>
<Factor>1</Factor>
<ParameterDescription>xxxxxxx</ParameterDescription>
<ParameterName>fill factor</ParameterName>
<ParameterValue>0</ParameterValue>
<ForceModify>True</ForceModify>
<Unit>INT</Unit>
</TemplateRecord>
</Parameters>
<RequestId>7B96585A-0FF2-4979-8FE5-7D147A29FDC0</RequestId>
</DescribeParameterTemplatesResponse>
JSON
格式
{
"DescribeParameterTemplatesResponse": {
"Engine": "mssql",
"EngineVersion": "2008r2",
"ParameterCount": "1",
"Parameters": {
"TemplateRecord": {
"CheckingCode": "[0-100]",
"ForceRestart": "True",
"Factor": "1",
"ParameterDescription": "xxxxxxx",
"ParameterName": "fill factor",
"ParameterValue": "0",
"ForceModify": "True",
"Unit": "INT"
}
},
"RequestId": "7B96585A-0FF2-4979-8FE5-7D147A29FDC0"
}
}
错误码
访问错误中心查看更多错误码。