开启/关闭Agent - SwitchAgentNew
功能介绍
用于开启和关闭Agent审计的功能,当开启后,开始抓取用户的访问信息。
URI
POST /v2/{project_id}/audit/{instance_id}/agent/switch
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-64。 默认取值: 不涉及 |
instance_id | 是 | String | 参数解释: 实例ID。可通过查询实例列表接口ID字段获取 约束限制: 不涉及 取值范围: 以查询实例列表接口值为准,字符长度32-64。 默认取值: 不涉及 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
agent_id | 是 | String | 审计agent的ID。可在查询数据库agent列表接口ID字段获取。 |
status | 是 | Integer | Agent开关状态
|
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
result | String | 操作结果
|
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
details | Array of DbssErrorDetail objects | PDP5鉴权异常信息 |
encoded_authorization_message | String | PDP5鉴权异常信息 |
error_code | String | 错误码 |
error_msg | String | 错误信息 |
状态码:403
参数 | 参数类型 | 描述 |
|---|---|---|
details | Array of DbssErrorDetail objects | PDP5鉴权异常信息 |
encoded_authorization_message | String | PDP5鉴权异常信息 |
error_code | String | 错误码 |
error_msg | String | 错误信息 |
请求示例
/v2/{project_id}/audit/{instance_id}/agent/switch
{
"agent_id" : "ASWDSDSDSWEWDSDSD",
"status" : 1
} 响应示例
状态码:200
请求已成功。
{
"result" : "SUCCESS"
} 状态码
状态码 | 描述 |
|---|---|
200 | 请求已成功。 |
400 | 请求参数有误 |
403 | 认证失败。 |
错误码
请参见错误码。

