全部产品
Search
文档中心

云数据库 RDS:ModifyParameter - 修改实例参数

更新时间:Mar 22, 2024

该接口用于修改RDS实例的参数值。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:ModifyParameterWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
  • rds:TLSVersion

请求参数

名称类型必填描述示例值
ClientTokenstring

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

ETnLKlblzczshOTUbOCz****
DBInstanceIdstring

实例 ID。

rm-uf6wjk5****
Parametersstring

参数及其值的 JSON 串,参数的值都是字符串类型。格式:{"参数名称 1":"参数值 1","参数名称 2":"参数值 2"...}。可调用 DescribeParameterTemplates 查询参数名称和参数值。

说明 传入该参数,则无需传入参数 ParameterGroupId
{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
Forcerestartboolean

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

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

默认值:false

false
ParameterGroupIdstring

参数模板 ID。

说明
  • 传入该参数,则无需传入参数 Parameters
  • 如果应用参数模板需要重启实例,需要传入参数 Forcerestart
  • rpg-****
    SwitchTimeModestring

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

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

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

    说明 该时间必须大于当前时间(执行调用的时间)。
    2022-05-06T09:24:00Z

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    RequestIdstring

    请求 ID。

    542BB8D6-4268-45CC-A557-B03EFD7AB30A

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400PendingActionOverduethe action execution time is already overdue选择的执行时间已过期
    400EngineMigration.ActionDisabledSpecified action is disabled while custins is in engine migration.实例在引擎迁移中时,指定的操作被禁用。
    400%sThe following parameters are prohibited: <br />%s-
    400Invalid.ParamGroupDBCategoryParamGroup category is basic, not standard.参数组类别是基本的,而不是标准的。
    400InvalidEffectiveTime.SpecialTimeIsNullSpecialTime is not valid.SpecialTime无效。
    400InvalidParameters.FormatSpecified parameters is not valid.无效的参数。
    400StorageEngine.NotSupportedCurrent instance storage engine dose not support this operation.当前实例的存储引擎不支持该操作。
    400InvalideStatus.FormatThe instance status does not support this operation.实例状态不支持此操作。
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
    400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
    400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
    403IncorrectDBInstanceTypeThe current database instance type does not support the operation.当前数据库实例类型不支持此操作。
    403IncorrectDBInstanceStateThe current database status does not support the operation.操作失败,该实例状态下不支持此操作。
    403ParamNotSupportedForCurrentVersionParameter is not supported for current version.-
    403Invalid.ParameterSpecified parameters is not valid.指定的参数无效。
    403IncorrectEffectiveTimeThe specified EffectiveTime params is not valid.EffectiveTime参数无效。
    403GroupReplicationNotSupport.InvalidEngineVersionGroup Replication requires the instance engine version to be 8.0.实例数据库版本不是MySQL 8.0,不支持组复制。
    403GroupReplicationNotSupport.InvalidNodeClassCodeGroup Replication requires the ClassCode of each node to be consistent.实例各节点间规格不一致,不支持组复制。
    403GroupReplicationNotSupport.InvalidNodeNumGroup Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.实例节点个数不是大于等于3的单数,不支持组复制。
    403GroupReplicationNotSupport.InvalidXengineGroup Replication is not supported because the instance has xengine tables.实例存在xengine引擎表,不支持组复制。
    403GroupReplicationNotSupport.MemoryTooSmallGroup Replication is not supported because the memory is too small.实例规格内存太小,不支持组复制。
    403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
    403GroupReplicationNotSupport.TableWithoutPrimaryKeyGroup Replication is not supported because the instance exists table has no primary key.实例存在无主键的表,不支持组复制。
    403IncorrectDBInstanceThe current DB instance does not support this operation.操作失败,当前实例不支持此操作。
    404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.没有找到指定的实例,请检查实例的正确性。
    404InvalidParamSepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的wal_level参数无效。实例中有此参数,因此无法替换。

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

    变更历史

    变更时间变更内容概要操作
    2023-12-21OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    2023-06-28OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
    2023-06-20OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      错误码 403 变更
      删除错误码:404
    2023-05-09OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
    2023-04-25OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 404 变更
      删除错误码:400
      删除错误码:403
    2022-10-28OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      错误码 403 变更
      删除错误码:404
    2021-10-26OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 403 变更
      删除错误码:400
      删除错误码:404
    2021-10-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:SwitchTimeMode
      新增入参:SwitchTime
    2021-10-26OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 404 变更
      删除错误码:400
      删除错误码:403