该接口用于修改RDS实例的参数值。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifyParameter | WRITE |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 | ETnLKlblzczshOTUbOCz**** |
DBInstanceId | string | 是 | 实例ID。 | rm-uf6wjk5**** |
Parameters | string | 否 | 参数及其值的JSON串,参数的值都是字符串类型。格式:{"参数名称1":"参数值1","参数名称2":"参数值2"...}。可调用DescribeParameterTemplates查询参数名称和参数值。 说明
传入该参数,则无需传入参数ParameterGroupId。
| {"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"} |
Forcerestart | boolean | 否 | 修改参数是否重启数据库,取值:
默认值:false。 | false |
ParameterGroupId | string | 否 | 参数模板ID。 说明
| rpg-**** |
SwitchTimeMode | string | 否 | 修改参数的执行时间,取值:
| ScheduleTime |
SwitchTime | string | 否 | 指定修改参数的执行时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明
该时间必须大于当前时间(执行调用的时间)。
| 2022-05-06T09:24:00Z |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "542BB8D6-4268-45CC-A557-B03EFD7AB30A"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | PendingActionOverdue | the action execution time is already overdue | 选择的执行时间已过期 |
400 | EngineMigration.ActionDisabled | Specified action is disabled while custins is in engine migration. | 实例在引擎迁移中时,指定的操作被禁用。 |
400 | %s | The following parameters are prohibited: <br />%s | - |
400 | Invalid.ParamGroupDBCategory | ParamGroup category is basic, not standard. | 参数组类别是基本的,而不是标准的。 |
400 | InvalidEffectiveTime.SpecialTimeIsNull | SpecialTime is not valid. | SpecialTime无效。 |
400 | InvalidParameters.Format | Specified parameters is not valid. | 无效的参数。 |
400 | StorageEngine.NotSupported | Current instance storage engine dose not support this operation. | 当前实例的存储引擎不支持该操作。 |
400 | InvalideStatus.Format | The instance status does not support this operation. | 实例状态不支持此操作。 |
403 | IncorrectDBInstanceType | The current database instance type does not support the operation. | 当前数据库实例类型不支持此操作。 |
403 | IncorrectDBInstanceState | The current database status does not support the operation. | 操作失败,该实例状态下不支持此操作。 |
403 | ParamNotSupportedForCurrentVersion | Parameter is not supported for current version. | - |
403 | Invalid.Parameter | Specified parameters is not valid. | 指定的参数无效。 |
403 | IncorrectEffectiveTime | The specified EffectiveTime params is not valid. | EffectiveTime参数无效。 |
403 | GroupReplicationNotSupport.InvalidEngineVersion | Group Replication requires the instance engine version to be 8.0. | 实例数据库版本不是MySQL 8.0,不支持组复制。 |
403 | GroupReplicationNotSupport.InvalidNodeClassCode | Group Replication requires the ClassCode of each node to be consistent. | 实例各节点间规格不一致,不支持组复制。 |
403 | GroupReplicationNotSupport.InvalidNodeNum | Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3. | 实例节点个数不是大于等于3的单数,不支持组复制。 |
403 | GroupReplicationNotSupport.InvalidXengine | Group Replication is not supported because the instance has xengine tables. | 实例存在xengine引擎表,不支持组复制。 |
403 | GroupReplicationNotSupport.MemoryTooSmall | Group Replication is not supported because the memory is too small. | 实例规格内存太小,不支持组复制。 |
403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 当前引擎小版本不支持此操作。 |
403 | GroupReplicationNotSupport.TableWithoutPrimaryKey | Group Replication is not supported because the instance exists table has no primary key. | 实例存在无主键的表,不支持组复制。 |
403 | IncorrectDBInstance | The current DB instance does not support this operation. | 操作失败,当前实例不支持此操作。 |
404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例,请检查实例的正确性。 |
404 | InvalidParam | Sepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | 指定的wal_level参数无效。实例中有此参数,因此无法替换。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-06-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-06-20 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-05-09 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2023-04-25 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2022-10-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2021-10-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2021-10-26 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
2021-10-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
|