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

Deleting a Database Agent

Function

This API is used to delete a database agent.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2/{project_id}/{instance_id}/audit/agents/{agent_id}

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.

agent_id

Yes

String

Agent ID. You can obtain the value from the ID field of the API for querying the agent list.
Table 2 Query 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.

Request Parameter

Table 3 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.)

Response Parameters

Status code: 200

Table 4 Response body parameters

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

Request Example

None

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 Code

For details, see Error Codes.

Parent topic: Auditing Agent