查看目标地域的参数模板列表。
接口说明
参数模板可以批量管理集群的参数，您可以使用参数模板功能快速应用模板到 PolarDB 集群上。更多详情，请参见使用参数模板。
当前仅支持 PolarDB MySQL 版集群。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
polardb:DescribeParameterGroups |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。 说明
您可以通过 DescribeRegions 接口查看当前账号下的所有可用地域信息，包括地域 ID。 |
cn-hangzhou |
| DBType |
string |
否 |
数据库引擎类型，当前仅支持 MySQL 类型。 |
MySQL |
| DBVersion |
string |
否 |
数据库引擎版本号，取值范围如下：
|
8.0 |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-************ |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
944CED46-A6F7-40C6-B6DC-C6E5CC****** |
| ParameterGroups |
array<object> |
参数模板列表。 |
|
|
object |
|||
| DBType |
string |
数据库引擎类型。 |
MySQL |
| DBVersion |
string |
数据库引擎版本号。 |
8.0 |
| ParameterGroupName |
string |
参数模板名称。 |
test |
| ForceRestart |
string |
应用该参数模板是否需要重启集群，取直范围如下：
|
1 |
| ParameterGroupType |
string |
参数模板类型，取值范围如下：
|
1 |
| ParameterCounts |
integer |
参数模板内的参数数量。 |
2 |
| ParameterGroupDesc |
string |
参数模板描述。 |
testgroup |
| CreateTime |
string |
参数模板创建时间，格式为 |
2023-03-10T08:40:39Z |
| ParameterGroupId |
string |
参数模板 ID。 |
pcpg-************** |
示例
正常返回示例
JSON格式
{
"RequestId": "944CED46-A6F7-40C6-B6DC-C6E5CC******",
"ParameterGroups": [
{
"DBType": "MySQL",
"DBVersion": "8.0",
"ParameterGroupName": "test",
"ForceRestart": "1",
"ParameterGroupType": "1",
"ParameterCounts": 2,
"ParameterGroupDesc": "testgroup",
"CreateTime": "2023-03-10T08:40:39Z",
"ParameterGroupId": "pcpg-**************"
}
]
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidRegionId.Malformed | The specified parameter RegionId is not valid. | 指定的参数RegionId无效 |
| 400 | InvalidEngine.Unsupported | The specified Engine does not support this feature. | 指定的引擎不支持此功能 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。