修改集群参数并应用到指定节点。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
polardb:ModifyDBClusterAndNodesParameters | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 | pc-**************** |
DBNodeIds | string | 否 | 节点 ID。通过设置该参数可以修改集群参数和指定节点的参数。多个节点 ID 间用英文逗号(,)分隔。 说明
当该参数为空时,则表示只修改集群参数。
| pi-****************,pi-**********, |
Parameters | string | 否 | 参数及参数值的 JSON 串。 | {"wait_timeout":"86","innodb_old_blocks_time":"10"} |
ParameterGroupId | string | 否 | 参数模板 ID。 | pcpg-************** |
PlannedStartTime | string | 否 | 开始执行定时(即在目标时间段内执行)任务的最早时间。格式为 说明
2021-01-14T09:00:00Z ,此处允许填入的开始时间范围为2021-01-14T09:00:00Z ~2021-01-15T09:00:00Z 。 | 2021-01-14T09:00:00Z |
PlannedEndTime | string | 否 | 开始执行目标定时任务的最晚时间。格式为 说明
PlannedStartTime 但未指定该参数,执行目标任务的最晚时间默认为开始时间+30 分钟 。例如当设置PlannedStartTime 为2021-01-14T09:00:00Z 且该参数留空时,目标任务最晚将于2021-01-14T09:30:00Z 开始执行。 | 2021-01-14T09:30:00Z |
FromTimeService | boolean | 否 | 立即执行或定时执行修改参数并重启集群。取值:
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameters.Format | Specified parameters is not valid. | 指定的参数无效。 |
400 | InvalidDBType.Malformed | The Specified DBType is not valid. | 指定的数据库类型无效. |
400 | ParamCollationServerNotValid | This param collation_server is not valid. | 此参数collation_server无效. |
400 | MinorVersionNotSupport | Custins minor version does not support current action. | 当前小版本不支持该功能,请先升级到最新版本. |
400 | ScheduleTaskExist | The specified dbCluster already has a scheduled task. | 指定的实例已经存在定时任务。 |
400 | ParamTypeException | Param is isClusterAvailable, not allow to change alone | 参数为isClusterAvailable,不允许单独更改 |
400 | ParamDynamicException | Conflicting parameters: %s | 请检查实例内核参数及当前修改参数是否存在提示相同的情况 %s |
400 | InvalidParameterGroupId.Malformed | The Specified parameter ParameterGroupId is not valid. | 指定的参数ParameterGroupId无效 |
400 | InvalidParameters.Malformed | The Specified parameters is not valid. | 指定的参数无效 |
400 | InvalidParameter.Malformed | Choose one of parameters and ParamGroupId. | 从parameters中选择一个ParamGroupId。 |
404 | InvalidDBCluster.NotFound | The specified DBClusterId is not found. | 操作失败,指定的集群实例ID不存在。 |
404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的 DBClusterId。 |
404 | InvalidDBNodeId.NotFound | The DBNodeId provided does not exist in our records. | 当前的记录中不存在提供的DBNodeId。 |
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 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2022-07-13 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2022-02-24 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2022-02-24 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2022-02-24 | 新增 OpenAPI | 看变更集 | ||||||||||||||
2022-02-24 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
|