文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 参数模板管理> 修改指定实例的参数
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF

修改指定实例的参数

功能介绍

修改指定实例的参数。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

Content-Type

是

String

内容类型。

取值：application/json。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

parameter_values

是

Map<String,String>

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

修改指定实例参数的任务ID。

restart_required

Boolean

是否需要重启。

  • true：是。
  • false：否。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

修改指定实例的参数。

PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/3ef58db3986540d19f95151309368d34in07/configurations
{
  "parameter_values" : {
    "max_user_connections" : "100"
  }
}

响应示例

状态码： 200

Success.

{
  "job_id" : "e5d698a9-d8db-47d2-bf75-3c9018f72b6f",
  "restart_required" : false
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 参数模板管理