# 添加审计数据库Agent\[待下线\] - AddAuditAgent #### 功能介绍 添加审计数据库Agent #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DBSS/doc?api=AddAuditAgent)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dbss/dbss_01_0428.html)。 #### URI POST /v2/{project_id}/{instance_id}/audit/agents 表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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | db_id | 是 | String | 数据库ID, 可在查询数据库列表接口的ID字段获取。 | | mode | 是 | Integer | 模式 - 0：创建agent - 1：选择已有agent | | agent_id | 否 | String | 选择已有agent时必输 | | agent_type | 是 | String | agent类型 - APP：应用端 - DB：数据库端 | | agent_os | 是 | String | agent OS类型: - LINUX64_X86：LINUX64_X86 - LINUX64_ARM：LINUX64_ARM - WINDOWS64：WINDOWS64 | | agent_ip | 否 | String | agent IP，安装节点类型为应用端时必输。 | | agent_nic | 否 | String | agent审计网卡名称 | | cpu_threshold | 否 | Integer | CPU阈值 | | mem_threshold | 否 | Integer | 内存阈值 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | 响应状态 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表6DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 错误信息 | 表8DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 错误信息 | 表10DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | #### 请求示例 ``` /v2/{project_id}/{instance_id}/audit/agents { "db_id" : "Gadr-Y4B51p4J06s5s5B", "mode" : 0, "agent_type" : "DB", "agent_os" : "LINUX64_X86", "cpu_threshold" : 80, "mem_threshold" : 80 } ``` #### 响应示例 **状态码：200** 成功 ``` { "result" : "SUCCESS" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | | 400 | 失败 | | 403 | 认证失败 | | 500 | 服务端错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dbss/ErrorCode.html)。