文档首页/ 数据库安全服务 DBSS/ API参考/ API/ 审计数据库/ 开启关闭数据库
更新时间：2025-09-10 GMT+08:00
查看PDF
分享

开启关闭数据库

功能介绍

开启关闭数据库

URI

POST /v3/{project_id}/audit/{instance_id}/databases/switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-64。

默认取值：

不涉及

instance_id

是

String

参数解释：

实例ID。可通过查询实例列表接口ID字段获取

约束限制：

不涉及

取值范围：

以查询实例列表接口值为准，字符长度32-64。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

id

是

String

数据库ID,可在查询数据库列表接口的ID字段获取。

status

是

String

开关状态

  • ON:开启

  • OFF:关闭

lts_audit_switch

否

Integer

是否关闭LTS审计,DWS数据库场景使用。若用户未选择关闭LTS审计,则不做操作。

  • 1 :是

  • 0 或 其它:保持原状

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

状态

  • SUCCESS:成功

  • FAILED:失败

状态码：400

表5 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表6 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：403

表7 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表8 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：500

表9 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表10 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

/v3/{project_id}/audit/{instance_id}/databases/switch

{
  "id" : "Gadr-Y4B51p4J06s5s5B",
  "status" : "OFF"
}

响应示例

状态码：200

成功

{
  "status" : "success"
}

状态码

状态码

描述

200

成功

400

失败

403

认证失败

500

服务端错误

错误码

请参见错误码。

父主题： 审计数据库