# 打开或关闭数据库代理拉取Binlog开关 - SwitchGaussMySqlProxyBinlogPull #### 功能介绍 打开或关闭数据库代理拉取Binlog开关。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbformysql:proxy:modifyBinlogPull | Write | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | gaussdb:proxy:modifyBinlogPull | - | #### URI POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/binlog-pull 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID，此参数是实例的唯一标识。 获取方法请参见[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstancesUnifyStatus.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 **默认取值**： 不涉及。 | | proxy_id | 是 | String | **参数解释**： 数据库代理ID，此参数是代理的唯一标识。 获取方法请参见[查询数据库代理信息列表](https://support.huaweicloud.com/api-taurusdb/ShowGaussMySqlProxyList.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为po01，长度为36个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。 - zh-cn：中文。 **默认取值**： en-us。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释**： 数据库代理模式。 **约束限制**： 不涉及。 **取值范围**： - readwrite：读写模式。 - readonly：TP只读模式。 **默认取值**： 不涉及。 | | support_binlog_pull | 是 | Boolean | **参数解释**： 数据库代理拉取Binlog开关。 **约束限制**： 不涉及。 **取值范围**： - true：开启。 - false：关闭。 **默认取值**： 不涉及。 | | binlog_route_master | 否 | Boolean | **参数解释**： 数据库代理是否从数据库主节点拉取Binlog。 **约束限制**： - 读写代理可以设置从数据库主节点或者只读节点拉取Binlog，TP只读代理只支持从只读节点拉取Binlog。 - binlog_route_master参数仅在support_binlog_pull为true时生效。 **取值范围**： - true：从主节点拉取。 - false：从只读节点拉取。 **默认取值**： false。 | #### 响应参数 **状态码：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 | 错误消息。 | #### 请求示例 - 开启读写数据库代理从数据库主节点拉取Binlog开关。 ``` POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/proxy/0f46fc46396e4fb19a0cb52f578e9511po01/binlog-pull { "type" : "readwrite", "support_binlog_pull" : true, "binlog_route_master" : true } ``` - 关闭读写数据库代理从数据库主节点拉取Binlog开关。 ``` POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/proxy/0f46fc46396e4fb19a0cb52f578e9511po01/binlog-pull { "type" : "readwrite", "support_binlog_pull" : false, "binlog_route_master" : false } ``` #### 响应示例 **状态码：200** ``` { "job_id" : "a4217ac4-12cd-4fb3-acfc-db4a4a1896ea" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。