Adding an Audit Database Agent (to Be Brought Offline)

Function

Adding an Audit Database Agent

URI

POST /v2/{project_id}/{instance_id}/audit/agents

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID You can obtain the value by calling the IAM API for querying the project list of a specified IAM user. Restrictions: N/A Range: The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters. Default value: N/A
instance_id	Yes	String	Definition: Instance ID. The value can be obtained from the ID field of the API for querying the instance list. Restrictions: N/A Range: The value is subject to the value of the API for querying the instance list. The value contains 32 to 64 characters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Parameter description: User token. You can obtain the token by calling the IAM API used to query the user token. The token is the value of X-Subject-Token in the response header. Restrictions: N/A Value range: Used by the IAM service to query the user token. Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
db_id	Yes	String	Database ID, which can be obtained from the ID field of the API for querying the database list.
mode	Yes	Integer	Mode 0: Create an agent. 1: Select an existing agent.
agent_id	No	String	Mandatory when an existing agent is selected
agent_type	Yes	String	Agent type. The value can be: APP: application end DB: database
agent_os	Yes	String	Agent OS type. The value can be: LINUX64_X86 LINUX64_ARM WINDOWS64
agent_ip	No	String	Agent IP address. This is mandatory when node type is set to Application.
agent_nic	No	String	Name of the agent audit NIC
cpu_threshold	No	Integer	CPU threshold
mem_threshold	No	Integer	Memory Threshold

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	String	Response status

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 6** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 8** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 10** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Example Requests

/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
}