文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 参数模板管理/ 修改参数模板- UpdateGaussMySqlConfiguration
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改参数模板 - UpdateGaussMySqlConfiguration

功能介绍

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

接口约束

  • 该接口仅支持TaurusDB集群-独享版。
  • 默认参数模板不允许修改。
  • 修改参数模板名称“name”不能与默认参数模板名称重复。
  • 修改的参数必须在指定数据库版本的默认参数范围内。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:param:update

    Write

    -

    -

    gaussdb:param:modify

    -

URI

PUT /v3/{project_id}/configurations/{configuration_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

configuration_id

是

String

参数解释：

参数模板ID。

约束限制：

不涉及。

取值范围：

获取方法参见查询参数模板 - ListGaussMySqlConfigurations。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

参数解释：

参数模板名称。

约束限制：

不涉及。

取值范围：

长度1到64个字符之间，区分大小写字母，可包含字母、数字、中划线、下划线或句点，不能包含其他特殊字符。参数模板描述，参数名和参数值映射关系三项不能同时为空。

默认取值：

不涉及。

description

否

String

参数解释：

参数模板描述。

约束限制：

不涉及。

取值范围：

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

默认取值：

空。

parameter_values

否

Map<String,String>

参数解释：

参数名和参数值映射关系。用户可以基于默认参数模板的参数，自定义的参数值。不传入该参数，则保持原参数信息。

约束限制：

不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

修改参数模板的任务ID。

取值范围：

不涉及。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

修改参数模板。

PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr07
{
  "parameter_values" : {
    "max_user_connections" : "4"
  }
}

响应示例

状态码： 200

Success.

{
  "job_id" : "f6cb21fe-186a-4931-b20d-764ced1f1f6b"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数模板管理