文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 日志管理> 开启或者关闭全量SQL
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF

开启或者关闭全量SQL

功能介绍

开启或者关闭全量SQL。关闭全量SQL后，可能导致DAS和DBSS服务全量SQL功能不可用，请谨慎关闭。

URI

POST /v3/{project_id}/instance/{instance_id}/audit-log/switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

switch_status

是

String

全量SQL开关状态。

取值范围：

  • ON：开启全量SQL。
  • OFF：关闭全量SQL。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

result

String

开启或关闭全量SQL操作结果。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

开启审计日志。

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/61a4ea66210545909d74a05c27a7179ein07/audit-log/status
{
  "switch_status" : "ON"
}

响应示例

状态码： 200

Success.

{
  "result" : "success"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 日志管理