调用ModifyParameter接口修改RDS实例参数。

您可以直接修改RDS实例的参数值,也可以通过参数模板修改。提交修改请求后,RDS将下发任务,将新修改的参数应用到实例,如果所提交的参数中有需要重启数据库的,RDS将重启数据库。可以修改的参数请参见设置实例参数

说明 RDS会在执行任务前检查参数是否存在、是否可修改以及是否合法。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyParameter

系统规定参数。取值:ModifyParameter

ClientToken String ETnLKlblzczshOTUbOCzxxxxxxxxxx

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

Parameters String {"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}

参数及其值的JSON串,参数的值都是字符串类型。格式:{"参数名称1":"参数值1","参数名称2":"参数值2"...}

说明 传入该参数,则无需传入参数ParameterGroupId
Forcerestart Boolean false

修改参数是否重启数据库,取值:

  • true:强制重启(若修改的参数当中,有需要重启的参数,则必须传入true,否则修改将不生效)。
  • false:不强制重启。

默认值:false

ParameterGroupId String rpg-xxxxxxxxx

参数模板ID。

说明
  • 传入该参数,则无需传入参数Parameters
  • 如果应用参数模板需要重启实例,需要传入参数Forcerestart
SwitchTimeMode String ScheduleTime

修改参数的执行时间,取值:

  • Immediately:默认值,立即执行。
  • MaintainTime:实例可运维时间段内执行。可调用ModifyDBInstanceMaintainTime接口修改可运维时间段。
  • ScheduleTime:手动指定执行时间。传入该值需要同时传入SwitchTime参数。
SwitchTime String 2022-05-06T09:24:00Z

指定修改参数的执行时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明 该时间必须大于当前时间(执行调用的时间)。

返回数据

名称 类型 示例值 描述
RequestId String 542BB8D6-4268-45CC-A557-B03EFD7AB30A

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=ModifyParameter
&DBInstanceId=rm-uf6wjk5xxxxxxx
&Parameters={"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyParameterResponse>
       <RequestId>542BB8D6-4268-45CC-A557-B03EFD7AB30A</RequestId>
</ModifyParameterResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "542BB8D6-4268-45CC-A557-B03EFD7AB30A"
}

错误码

HttpCode 错误码 错误信息 描述
400 PendingActionOverdue the action execution time is already overdue 选择的执行时间已过期
400 InvalidParameters.Format Specified parameters is not valid. 无效的参数。
400 InvalidParameters.Format The format of the specified parameter is invalid. 操作失败,指定的参数格式不合法。
400 Invalid.ParamGroupDBCategory ParamGroup category is basic, not standard. 参数组类别是基本的,而不是标准的。
403 IncorrectDBInstanceType The current database instance type does not support the operation. 当前数据库实例类型不支持此操作。
403 IncorrectDBInstanceState The current database status does not support the operation. 操作失败,数据库状态不支持此操作。请查看数据库信息,确保数据库状态为运行中。
404 InvalidDBInstance.NotFound The specified instance does not exist or is not supported. 没有找到指定的实例,请检查实例的正确性。

访问错误中心查看更多错误码。