文档首页/数据库安全服务 DBSS/API参考（联盟区域）/API说明/审计Agent/开启关闭Agent
更新时间：2025-12-31 GMT+08:00
在线调试
CLI示例
查看PDF
分享

开启关闭Agent

功能介绍

用于开启和关闭Agent审计的功能，当开启后，开始抓取用户的访问信息。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/{instance_id}/audit/agent/switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

instance_id

是

String

实例ID。可在查询实例列表接口的ID字段获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

agent_id

是

String

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

status

是

Integer

Agent开关状态

  • 1：开启
  • 0：关闭

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

result

String

响应状态

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表6 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表8 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

请求示例

/v1/{project_id}/{instance_id}/audit/agent/switch

{
  "agent_id" : "ASWDSDSDSWEWDSDSD",
  "status" : 1
}

响应示例

状态码： 200

请求已成功。

{
  "result" : "SUCCESS"
}

状态码： 400

请求参数有误。

{
  "error" : {
    "error_code" : "DBSS.XXX",
    "error_msg" : "XXX"
  }
}

状态码： 403

认证失败。

{
  "error" : {
    "error_code" : "DBSS.XXX",
    "error_msg" : "XXX"
  }
}

状态码

状态码

描述

200

请求已成功。

400

请求参数有误。

403

认证失败。

错误码

请参见错误码。

父主题：审计Agent