文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 实例管理/ 修改DDM实例参数
更新时间：2024-07-15 GMT+08:00
查看PDF
分享

修改DDM实例参数

功能介绍

修改DDM实例参数。

接口约束

修改的参数必须在控制台“参数管理”页面内，具体可配置范围请参见《分布式数据库中间件DDM 用户指南》中“修改DDM实例参数”的内容。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

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

instance_id

是

String

DDM实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

否

String

语种，默认中文。中文：zh-cn，英文：en-us。

X-Auth-Token

是

String

用户Token。

通过调用IAM服务的“获取用户Token”接口来获取。
表3 请求Body参数

参数

是否必选

参数类型

描述

values

是

values object

Map<String,String>

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

  • key：参数名称。为空时不修改该参数值。
  • value：参数值。
表4 values

参数

是否必选

参数类型

描述

bind_table

否

String

用于描述多个拆分表的内在数据关联性，用于告知优化器在处理join时，把join下推到MySQL层执行。格式为:[{tb.col1,tb2.col2},{tb.col2,tb3.col1},...]。

character_set_server

否

String

DDM服务端字符集，如果需要存储emoji表情符号，请选择utf8mb4，并设置RDS字符集也为utf8mb4。修改DDM服务端字符集时，DDM服务端字符序必须同步修改为对应类型的值。

枚举值：

  • gbk
  • utf8
  • utf8mb4

collation_server

否

String

DDM服务端字符序。修改DDM服务端字符序时，DDM服务端字符集必须同步修改为对应类型的值。

枚举值：

  • utf8_unicode_ci
  • utf8_bin
  • gbk_chinese_ci
  • gbk_bin
  • utf8mb4_unicode_ci
  • utf8mb4_bin

concurrent_execution_level

否

String

逻辑表扫描时的分片并发执行级别。

  • DATA_NODE: 分库间并行扫描，同一分库内各分片串行扫描，
  • RDS_INSTANCE: RDS实例间并行扫描，同一RDS实例内各分片串行扫描。
  • PHY_TABLE: 各物理分片全部并行扫描。

枚举值：

  • RDS_INSTANCE
  • DATA_NODE
  • PHY_TABLE

connection_idle_timeout

否

String

服务器关闭连接之前等待连接活动的秒数，以秒为单位，取值范围为60-28800，默认值28800，表示服务器关闭连接之前等待28800秒后，关闭连接。

enable_table_recycle

否

String

是否开启表回收站。

枚举值：

  • OFF
  • ON

insert_to_load_data

否

String

insert常量值是否使用load data执行。

枚举值：

  • OFF
  • ON

live_transaction_timeout_on_shutdown

否

String

在途事务等待时间窗口，以秒为单位，取值范围为0-100，默认值为1，表示服务器关闭前端连接之前等待1秒后关闭连接。

long_query_time

否

String

记录慢查询的最小秒数，以秒为单位，取值范围为0.01-10，默认值为1，表示如果SQL执行大于等于1秒就定义为慢SQL。

max_allowed_packet

否

String

服务端和客户端在一次传送数据包的过程中最大允许的数据包大小。该值必须设置为1024的倍数。取值范围为1024~1073741824，默认值为1073741824。

max_backend_connections

否

String

允许每个DDM节点同时连接RDS的最大客户端总数。0为默认值标识符，实际值等于(RDS的最大连接数-20)/DDM节点数。取值范围为0-10000000。

max_connections

否

String

允许同时连接的客户端总数。与后端RDS规格及数量有关。以个数为单位，取值范围为10-40000，默认值为20000，表示允许同时连接的客户端总数不能超过40000。

min_backend_connections

否

String

允许每个DDM节点同时连接RDS的最小客户端总数。默认值为10。取值范围为0-10000000。

not_from_pushdown

否

String

是否强制下推查询语句中不含FROM的语句。

枚举值：

  • OFF
  • ON

seconds_behind_master

否

String

主从RDS节点延迟时间阈值，以秒为单位，取值范围为0-7200，默认值为30，表示主RDS与从RDS之间的数据同步时间值不能超过30秒，如果超过30秒，读数据指令就不走当前读节点。

sql_audit

否

String

开启或关闭SQL审计。

枚举值：

  • OFF
  • ON

sql_execute_timeout

否

String

SQL执行超时秒数，以秒为单位，取值范围为100-28800，默认值28800，表示SQL执行大于等于28800秒超时。

support_ddl_binlog_hint

否

String

DDL语句添加binlog hint。

枚举值：

  • OFF
  • ON

transaction_policy

否

String
  • XA：XA 事务，保证原子性，保证可见性。
  • FREE：允许多写，不保证原子性，无性能损耗。
  • NO_DTX：单分片事务。

枚举值：

  • XA
  • FREE
  • NO_DTX

ultimate_optimize

否

String

开启或关闭优化器中的极致下推优化功能。

枚举值：

  • OFF
  • ON

请求示例

修改慢查询的参数值为2，表示如果SQL执行大于等于2秒就定义为慢SQL。

PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/configurations

{
  "values" : {
    "long_query_time" : 2
  }
}

响应参数

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

    参数

    参数类型

    描述

    nodeList

    String

    节点列表。

    needRestart

    Boolean

    是否需要重启实例。

    jobId

    String

    任务ID。

    configId

    String

    参数组ID。

    configName

    String

    参数组名称。
  • 正常响应示例 
    {
  "nodeList" : null,
  "needRestart" : "false",
  "jobId" : "9fe84a77-6a6b-4b03-9a3e-db910a548657",
  "configId" : null,
  "configName" : null
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档