文档首页/数据复制服务 DRS/API参考/API v3（不再推广）/公共接口管理/修改数据库参数 - UpdateParams
更新时间：2025-12-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改数据库参数 - UpdateParams

功能介绍

修改数据库参数。

接口约束

  • 仅MySQL迁移和MySQL灾备支持调用。
  • 任务job_direction为up时才能调用，任务状态为CONFIGURATION才能调用。
  • 需要先调用获取数据库参数接口，才能调用修改数据库参数接口。
  • 双主灾备时父任务不支持。

授权信息

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

URI

POST /v3/{project_id}/jobs/{job_id}/params

表1 路径参数

参数

是否必选

参数类型

描述

job_id

是

String

任务ID。

project_id

是

String

租户在某一Region下的Project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

指定类型为application/json。

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。

X-Language

否

String

请求语言类型。

缺省值：en-us

取值：

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

参数

是否必选

参数类型

描述

group

是

String

参数分组。取值：

  • common
  • performance

params

是

Array of objects

修改的参数信息。

详情请参见表4。

表4 params字段数据结构说明

参数

是否必选

参数类型

描述

key

是

String

数据库参数名。

target_value

是

String

目标数据库参数值。

响应参数

状态码：202

表5 响应Body参数

参数

参数类型

描述

success

Boolean

修改参数是否成功。

should_restart

String

是否需要重启。取值：

  • true
  • false

error_code

String

错误码。

error_msg

String

错误信息。

请求示例

修改数据库binlog_stmt_cache_size参数值为32678、bulk_insert_buffer_size值为8388608

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/140b5236-88ad-43c8-811c-1268453jb101/params

{
  "group" : "performance",
  "params" : [ {
    "key" : "binlog_stmt_cache_size",
    "target_value" : "32678"
  }, {
    "key" : "bulk_insert_buffer_size",
    "target_value" : "8388608"
  } ]
}

响应示例

状态码：202

Accepted

{
  "success" : true,
  "should_restart" : "false"
}

状态码

状态码

描述

202

Accepted

400

Bad Request

错误码

请参见错误码。

父主题：公共接口管理