更新时间:2022-08-16 GMT+08:00

修改DDM实例参数

功能介绍

修改DDM实例参数。

接口约束

无。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。

instance_id

String

DDM实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

语种,默认中文。中文:zh-cn;英文:en-us。

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

values

Array of Values objects

需要修改的DDM实例参数的集合。

表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

包或任何生成的中间字符串的最大值。包缓冲区初始化为net_buffer_length字节,但需要时可以增长到max_allowed_packet字节。该值默认很小,以捕获大的(可能是错误的)数据包。该值必须设置为1024的倍数。取值范围为1024~1073741824,默认值为16777216。

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秒,如果超过30s,读数据指令就不走当前读节点。

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

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

nodeList

String

节点列表。

needRestart

Boolean

是否需要重启实例。

jobId

String

任务id。

configId

String

参数模板id。

configName

String

参数模板名称。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码

externalMessage

String

错误信息

状态码: 500

表7 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码

externalMessage

String

错误信息

请求示例

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

{
        "values": {
            "character_set_server": "gbk",
            "collation_server": "gbk_bin"
        }
}

响应示例

状态码: 200

ok

{
    "nodeList": xxxx,
    "needRestart": false,
    "jobId": "cd4572a9-9bfc-4952-9a9f-388a90fef02f",
    "configId": xxxx,
    "configName": xxxx
}

状态码: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码: 500

server error

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码

状态码

描述

200

OK

400

bad request

500

server error

错误码

请参见错误码