文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 参数管理/ 更新参数组V3
更新时间：2026-05-15 GMT+08:00
查看PDF
分享

更新参数组V3

功能介绍

更新参数组V3

接口约束

无

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ddm::updateParamGroup

    Write

    parameterGroup *

    -

    ddm:param:update

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

config_id

是

String

参数解释：

参数组ID。

约束限制：

不允许修改默认参数组。

取值范围：

只能由英文字母、数字组成，长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

description

否

String

参数解释：

参数组描述。

约束限制：

不涉及。

取值范围：

不能超过256位，且不能包含回车和特殊字符 ! < " = ' > &。

默认取值：

不涉及。

values

否

Map<String,String>

参数解释：

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

约束限制：

不涉及。

取值范围：

  • key：参数名称，如“contains_shard_key”，“connection_idle_timeout”。为空时不修改参数值。

  • value：参数值，如“6”，“20”。key不为空时value也不可为空。

默认取值：

不涉及。

name

否

String

参数解释：

参数组名称。

约束限制：

不涉及。

取值范围：

在1到64个字符之间，区分大小写，可包含字母、数字、中划线、下划线或句点，不能包含其他特殊字符。

默认取值：

不涉及。

请求示例

更新参数组。

PUT https://{endpoint}/v3/a8e2a5e2a6xxxxxxxxxx5af5b9ddabe5/configurations/849c450a43xxxxxxxxxxf33cff5f0717pr09

{
  "values" : {
    "ddl_flowcontrol_threshold" : "10005"
  }
}

响应参数

  • 正常响应参数说明
表3 响应Body参数

参数

参数类型

描述

need_restart

Boolean

参数解释：

DDM实例是否需要重启。

取值范围：

  • false：DDM实例不需要重启。

  • true：DDM实例需要重启。

响应示例

  • 正常响应示例 
    {
  "need_restart" : false
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 参数管理

相关文档