文档首页/云数据库 RDS/API参考/API v3（推荐）/参数管理/修改参数模板参数 - UpdateConfiguration
更新时间：2026-03-31 GMT+08:00
查看PDF
分享

修改参数模板参数 - UpdateConfiguration

功能介绍

修改指定参数模板的参数信息，包括名称、描述、指定参数的值。

调试

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

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:param:updateTemplate

write

-

-

rds:param:modify

-

接口约束

  • 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。
  • 修改参数模板名称“name”不能与默认参数模板或已有参数模板的名称重复，默认参数模板不允许修改。
  • 修改的参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见《云数据库 RDS用户指南》中“修改实例参数”的内容。
  • 敏感参数，例如：“lower_case_table_names”，修改存在风险，详情请参见《云数据库RDS用户指南》中“RDS for MySQL参数调优建议”的内容。
  • 要修改的参数信息，不可全部为空。

URI

  • URI格式

    PUT /v3/{project_id}/configurations/{config_id}

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

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

    默认取值：

    不涉及。

    config_id

    是

    参数解释：

    参数模板ID。

    约束限制：

    不涉及。

    取值范围：

    该参数值可调用获取参数模板列表接口，通过表3中的“id”获取。

    默认取值：

    不涉及。

请求消息

请求体参数中，至少有一个非空，否则会下发失败。

表2 参数说明

名称

是否必选

参数类型

说明

name

否

String

参数解释：

参数模板名称。

约束限制：

不涉及。

取值范围：

最长64个字符，只允许大写字母、小写字母、数字和特殊字符“-_.”。

默认取值：

不涉及。

description

否

String

参数解释：

参数模板描述。

约束限制：

不涉及。

取值范围：

最长256个字符，不支持!<>=&"'特殊字符。

默认取值：

默认为空。

values

否

Map<String,String>

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

为空时不修改参数值。

请求示例

修改参数模板的参数值。

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9
{ 
    "name": "configuration_test", 
    "description": "configuration_test", 
    "values": { 
       "div_precision_increment": "6",
       "connect_timeout": "20"
    } 
}

响应消息

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

    名称

    参数类型

    说明

    configuration

    Object

    参数解释：

    参数模板信息。详情请参见表4。

    表4 configuration字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    参数解释：

    参数模板ID。

    取值范围：

    不涉及。

    name

    String

    参数解释：

    参数模板名称。

    取值范围：

    不涉及。

    ignored_params

    List

    参数解释：

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

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

    取值范围：

    不涉及。

  • 正常响应样例 
    {
    "configuration": {
        "id": "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
        "name": "configuration_test",
        "ignored_params": {}
    }
}
  • 异常响应

    请参见异常响应结果。

状态码

错误码

请参见错误码。

父主题：参数管理

相关文档