Help Center/ Database Security Service/ API Reference/ API/ Auditing Agent/ Adding an Audit Database Agent
Updated on 2024-11-01 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Adding an Audit Database Agent

Function

This API is used to add an audit database agent.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 URI parameter

Parameter

Mandatory

Parameter Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID. You can obtain the value from the ID field in the API for querying the instance list.

Request Parameter

Table 2 Request header parameter

Parameter

Mandatory

Parameter Type

Description

X-Auth-Token

Yes

String

User token. The token can be queried by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)
Table 3 Request body parameters

Parameter

Mandatory

Parameter 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

Schema

  • 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
  • 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 parameter

Parameter

Parameter Type

Description

result

String

Response status

Status code: 400

Table 5 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 6 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 403

Table 7 Response body parameters

Parameter

Parameter Type

Description

error

Object

Error message.
Table 8 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 9 Response body parameters

Parameter

Parameter Type

Description

error

Object

Error message.
Table 10 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Example request

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

Example Response

Status code: 200

Succeeded

{
  "result" : "SUCCESS"
}

Status code: 400

Failed

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

Status Code

Status Code

Description

200

Success

400

Failed

403

Authentication failed.

500

Server error.

Error Codes

For details, see Error Codes.

Parent topic: Auditing Agent