Help Center/ Database Security Service/ API Reference/ API/ APIs to Be Taken Offline/ Downloading the Audit Agent (to Be Brought Offline)
Updated on 2025-09-10 GMT+08:00

Downloading the Audit Agent (to Be Brought Offline)

Function

Downloading the Audit Agent

URI

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

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

agent_id

Yes

String

Agent ID. You can obtain the value from the ID field of the API for querying the agent list.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

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

** Restrictions**:

N/A

Range:

Used by the IAM service to query the user token.

** Default value**:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

String

Response status

Status code: 400

Table 4 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 5 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

Table 6 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 7 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

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

Example Responses

Status code: 200

Request succeeded.

{
  "result" : "SUCCESS"
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request parameter.

403

Authentication failed.

Error Codes

See Error Codes.