文档首页/ Flexus云服务_Flexus云数据库RDS/ API参考/ API/ 参数管理/ 修改指定实例的参数 - UpdateInstanceConfigurationAsync
更新时间:2025-12-15 GMT+08:00

修改指定实例的参数 - UpdateInstanceConfigurationAsync

功能介绍

修改指定实例的参数模板参数。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    rds:instance:updateParameter

    write

    instance

    g:EnterpriseProjectId

    g:ResourceTag/<tag-key>

    rds:param:modify

    -

URI

  • URI格式

    PUT /v3.1/{project_id}/instances/{instance_id}/configurations

  • 参数说明
    表1 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    参数解释

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    instance_id

    String

    参数解释

    实例ID。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

values

Map<String,String>

参数解释

参数值对象,用户基于默认参数模板自定义的参数值。

约束限制

不涉及。

取值范围

  • key:参数名称,如“div_precision_increment”,“connect_timeout”。为空时不修改参数值。
  • value:参数值,如“6”,“20”。key不为空时value也不可为空。

默认取值

不涉及。

请求示例

修改指定实例的参数。
https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations
{
  "values" : { 
    "max_connections" : "10", 
    "autocommit" : "OFF",
    "binlog_checksum" : "CRC32",
    "innodb_purge_threads" : "4"
  } 
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    job_id

    String

    参数解释

    任务ID。

    取值范围

    不涉及。

    restart_required

    Boolean

    参数解释

    实例是否需要重启。

    取值范围

    • “true”需要重启。
    • “false”不需要重启。

    ignored_params

    List

    参数解释

    请求参数“values”中被忽略掉,没有生效的参数名称列表。

    当参数不存在时,参数修改不会下发,并通过此参数返回所有被忽略的参数名称。

    取值范围

    不涉及。

  • 正常响应样例
    { 
      "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94",
      "restart_required" : "false",
      "ignored_params": []
    }
  • 异常响应

    请参见异常请求结果

状态码