修改PolarDB集群的参数或将已有的参数模板应用到目标集群上。
接口说明
PolarDB 新增参数模板功能，您可以使用参数模板功能，对参数进行集中管理，并快速应用至集群。更多详情，请参见使用参数模板。
说明
当前仅 PolarDB MySQL 版支持参数模板功能。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| polardb:ModifyDBClusterParameters | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息，包括集群 ID。
| pc-************** |
| Parameters | string | 否 | 参数及其值的 JSON 串，参数的值都是字符串类型，例如 说明
ParameterGroupId参数中选择一个传入。 | {"wait_timeout":"86","innodb_old_blocks_time":"10"} |
| ParameterGroupId | string | 否 | 参数模板 ID。 说明
Parameters参数中选择一个传入。 | pcpg-************** |
| PlannedStartTime | string | 否 | 开始执行定时（即在目标时间段内执行）任务的最早时间。格式为 说明
2021-01-14T09:00:00Z，此处允许填入的开始时间范围为2021-01-14T09:00:00Z~2021-01-15T09:00:00Z。 | 2022-04-28T14:00:00Z |
| PlannedEndTime | string | 否 | 开始执行目标定时任务的最晚时间。格式为 说明
PlannedStartTime但未指定该参数，执行目标任务的最晚时间默认为开始时间+30 分钟。例如当设置PlannedStartTime为2021-01-14T09:00:00Z且该参数留空时，目标任务最晚将于2021-01-14T09:30:00Z开始执行。 | 2022-04-28T14:30:00Z |
| FromTimeService | boolean | 否 | 立即执行或定时执行修改参数并重启集群。取值：
| false |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "C5D526E5-91B5-48B8-B980-FE07FF******"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameters.Format | Specified parameters is not valid. | 指定的参数无效。 |
| 400 | InvalidParameters.Format | The specified parameters are invalid. | 参数不正确。 |
| 400 | MinorVersionNotSupport | Custins minor version does not support current action. | 当前小版本不支持该功能，请先升级到最新版本. |
| 400 | ParamDynamicException | Conflicting parameters: %s | 请检查实例内核参数及当前修改参数是否存在提示相同的情况 %s |
| 400 | InvalidParameters.Malformed | The Specified parameters is not valid. | 指定的参数无效 |
| 400 | InvalidParameter.Malformed | Choose one of parameters and ParamGroupId. | 从parameters中选择一个ParamGroupId。 |
| 404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的 DBClusterId。 |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的参数DBClusterId无效 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-09-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-06-13 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-06-13 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2022-11-24 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2021-03-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2021-03-08 | OpenAPI 入参发生变更 | 看变更集 | ||||||||
|