文档首页/云数据库 RDS/API参考/API v3.1（推荐）/修改指定实例的参数 - UpdateInstanceConfigurationAsync
更新时间：2026-03-31 GMT+08:00
查看PDF
分享

修改指定实例的参数 - UpdateInstanceConfigurationAsync

功能介绍

修改指定实例的参数。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:updateParameter

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:param:modify

-

接口约束

  • 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。
  • 修改的参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见《云数据库RDS用户指南》中“修改RDS for MySQL实例参数”的内容。
  • 敏感参数，例如：“lower_case_table_names”，修改存在风险，详情请参见《云数据库RDS用户指南》中“RDS for MySQL参数调优建议”的内容。

URI

  • URI格式

    PUT https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/configurations

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

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

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

    默认取值：

    不涉及。

请求消息

表2 请求Body参数

参数

是否必选

参数类型

描述

values

是

Map<String,String>

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求示例

  • 修改MySQL实例的参数值。 
    PUT https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations
{
  "values" : { 
    "div_precision_increment": "6",
    "connect_timeout": "20",
    "binlog_checksum" : "CRC32",
    "innodb_purge_threads" : "4"
  } 
}
  • 修改PostgreSQL实例的参数值。 
    {
  "values" : { 
    "autovacuum" : "on",
    "bytea_output" : "escape",
    "client_encoding" : "UTF8",
    "cpu_tuple_cost" : "0.01"
  } 
}
  • 修改SQL Server实例的参数值。 
    {
   "values":{
     "max server memory (MB)":"26317",
     "max degree of parallelism":"4"
   }
}

响应消息

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

    参数

    参数类型

    描述

    job_id

    String

    参数解释：

    任务ID。

    取值范围：

    不涉及。

    restart_required

    Boolean

    参数解释：

    实例是否需要重启。

    取值范围：

    • true：需要重启。
    • false：不需要重启。
  • 正常响应样例 
    { 
  "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94",
  "restart_required" : false
}
  • 异常响应

    请参见异常响应结果。

状态码

错误码

请参见错误码。

相关文档