文档首页/ 云数据库 TaurusDB/ API参考/ API/ 日志管理/ 查询Binlog日志开关状态 - ShowBinlogSwitch
更新时间：2026-11-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询Binlog日志开关状态 - ShowBinlogSwitch

功能介绍

查询指定数据库实例的Binlog日志开关状态。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:log:getBinlogSwitch

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:log:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/binlog/switch

表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。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

switch_status

String

参数解释：

Binlog日志开关状态。

取值范围：

  • ON：开启。

  • OFF：关闭。

keep_days

Integer

参数解释：

Binlog日志保留天数。

取值范围：

1-180。如果为null表示未开启Binlog日志开关。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询实例的Binlog日志开关状态。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/binlog/switch

响应示例

状态码：200

{
  "switch_status" : "ON",
  "keep_days" : 7
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 日志管理

相关文档