查询数据库集群默认参数的列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
polardb:DescribeParameterTemplates |
get |
*DBCluster
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
DBType |
string |
是 |
数据库引擎类型,当前仅支持 MySQL。 |
MySQL |
DBVersion |
string |
是 |
数据库版本,取值范围如下:
|
5.7 |
RegionId |
string |
是 |
地域 ID。 说明
您可以通过 DescribeRegions 接口查看当前账号下的所有可用地域信息,包括地域 ID。 |
cn-hangzhou |
ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-************ |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
ParameterCount |
string |
参数数量。 |
183 |
DBVersion |
string |
数据库引擎版本。 |
5.7 |
Parameters |
object |
||
TemplateRecord |
array<object> |
参数列表。 |
|
object |
|||
CheckingCode |
string |
参数取值范围。 |
[ROW|STATEMENT|MIXED] |
ParameterName |
string |
参数名称。 |
binlog_format |
ParameterValue |
string |
参数默认值。 |
ROW |
ForceModify |
string |
参数是否可修改,取值范围如下:
|
true |
ForceRestart |
string |
参数修改后,是否需要重启新参数值才生效。取值范围如下:
|
false |
ParameterDescription |
string |
参数描述。 |
What form of binary logging the master will use. |
IsNodeAvailable |
string |
是否是全局参数。取值:
|
1 |
ParamRelyRule |
string |
参数依赖。 |
utf8 |
RequestId |
string |
请求 ID。 |
D963934D-8605-4473-8EAC-54C719****** |
DBType |
string |
数据库引擎类型。 |
MySQL |
Engine |
string |
数据库引擎。 |
POLARDB |
示例
正常返回示例
JSON
格式
{
"ParameterCount": "183",
"DBVersion": "5.7",
"Parameters": {
"TemplateRecord": [
{
"CheckingCode": "[ROW|STATEMENT|MIXED]",
"ParameterName": "binlog_format",
"ParameterValue": "ROW",
"ForceModify": "true",
"ForceRestart": "false",
"ParameterDescription": "What form of binary logging the master will use.",
"IsNodeAvailable": "1",
"ParamRelyRule": "utf8"
}
]
},
"RequestId": "D963934D-8605-4473-8EAC-54C719******",
"DBType": "MySQL",
"Engine": "POLARDB"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InvalidDBType.NotFound | The Specified DBType does not found. | |
400 | InvalidDBVersion.Malformed | The Specified DBVersion is not valid. | 指定的DBVersion无效 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。