创建PolarDB参数模板。
接口说明
参数模板可以批量管理集群的参数,您可以使用参数模板功能,快速应用模板到 PolarDB 集群上。详情请参见使用参数模板。
说明
当前仅支持 PolarDB MySQL 版集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
polardb:CreateParameterGroup | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 参数模板所在地域的地域 ID。 说明
您可以通过接口 DescribeRegions 查看地域 ID。
| cn-hangzhou |
DBType | string | 是 | 数据库引擎类型,当前仅支持 MySQL。 | MySQL |
DBVersion | string | 是 | 数据库引擎版本号,取值范围如下:
| 8.0 |
ParameterGroupName | string | 是 | 参数模板的名称,需满足如下要求:
| test_group |
ParameterGroupDesc | string | 否 | 参数模板的描述,长度为 0~199 个字符。 | test_group |
Parameters | string | 是 | 参数及其值的 JSON 串,参数的值都是字符串类型,例如 说明
您可以通过接口 DescribeParameterTemplates 查看目标数据库引擎版本数据库集群的所有参数详情,包括参数名称、取值范围等。
| {"wait_timeout":"86400","innodb_old_blocks_time":"1000"} |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-********** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "514D1D87-E243-4A5F-A87D-2785C3******",
"ParameterGroupId": "pcpg-**************"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidRegionId.Malformed | he specified parameter RegionId is not valid. | - |
400 | InvalidDBVersion.Malformed | The Specified DBVersion is not valid. | 指定的DBVersion无效 |
400 | InvalidParameterGroupName.Malformed | The Specified parameter ParameterGroupName is not valid. | 指定的参数ParameterGroupName无效 |
400 | NumberExceed.parameterGroupDesc | The ParameterGroupDesc parameter`s number is exceed. | ParameterGroupDesc参数的编号已超过 |
400 | InvalidEngine.Unsupported | The specified Engine does not support this feature. | 指定的引擎不支持此功能 |
400 | ParamGroupsNameInvalid | The Specified parameter ParameterGroupName is not valid. | 指定的参数ParameterGroupName无效 |
404 | InvalidDBType.NotFound | The Specified DBType does not found. | 找不到指定的DBType。 |
404 | InvalidUser.NotFound | Specified user does not exist. | 指定的用户不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2023-04-24 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
|