文档首页/ 云数据库 TaurusDB/ API参考/ API(推荐)/ 数据库代理/ 设置数据库代理事务拆分- UpdateTransactionSplitStatus
更新时间:2025-10-21 GMT+08:00

设置数据库代理事务拆分 - UpdateTransactionSplitStatus

功能介绍

开启/关闭事务拆分。

调用方法

请参见如何调用API

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:proxy:modifyTransactionSplit

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:proxy:modifyTransactionSplit

    -

URI

POST /v3/{project_id}/instances/{instance_id}/proxy/transaction-split

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

transaction_split

String

参数解释

开启/关闭事务拆分。

约束限制

不涉及。

取值范围

  • ON:开启。

  • OFF:关闭。

默认取值

不涉及。

proxy_id_list

Array of strings

参数解释

实例的数据库代理列表。

约束限制

不涉及。

响应参数

状态码: 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

错误信息。

请求示例

关闭数据库代理的事务拆分。

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/6b030d160ac24eda9a5320fb38dc2d0ain07/proxy/transaction-split
{
  "transaction_split" : "OFF",
  "proxy_id_list" : [ "2a2060f2486e4a47934182d91a3b53d2po01" ]
}

响应示例

状态码: 200

success

{
  "job_id" : "11921bf5-f286-45ee-ab35-12a3d4084c57"
}

状态码

请参见状态码

错误码

请参见错误码