Updated on 2025-09-10 GMT+08:00

Downloading the Audit Agent

Function

Downloading the Audit Agent

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

** Parameter description**:

Specifies the 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

** Value 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

** Parameter description**:

Instance ID. The value can be obtained from the ID field of the API for querying the instance list.

** Restrictions**:

N/A

** Value 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

Definition:

Audit agent ID. The value can be obtained from the agent_id field in the API for obtaining the agent list.

** Restrictions**:

N/A

Range:

The value is the same as the value of agent_id in the API for obtaining the agent list. The value is a string of 16 to 64 characters.

** Default value**:

N/A

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

The response body is lengthy; it is recommended to download it for viewing the complete content.

Status code: 400

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

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

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

Example Requests

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

Example Responses

None

Status Codes

Status Code

Description

200

The response body is lengthy; it is recommended to download it for viewing the complete content.

400

Invalid request parameter.

403

Authentication failed.

Error Codes

See Error Codes.