Help Center/ Database Security Service/ API Reference/ API/ Dashboard/ Obtaining the Status of the Tenant Audit Information Summary Task
Updated on 2025-09-10 GMT+08:00

Obtaining the Status of the Tenant Audit Information Summary Task

Function

Obtaining the Status of the Tenant Audit Information Summary Task

URI

GET /v3/{project_id}/audit/summary/{busi_type}/task-status

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

busi_type

Yes

String

Definition:

Service type.

Constraints:

N/A

Value range:

  • audit: audit instance

  • risk

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

begin_time

Long

Start time

busi_type

String

Service type.

  • audit

  • risk

completed_num

Integer

Counted instances

end_time

Long

End time

id

Long

Task ID

project_id

String

Project ID

query_begin_time

Long

Query condition: start time

query_end_time

Long

Query condition: end time

task_status

String

Task status. The options are as follows:

  • 0: ready

  • 2: success

  • 3: failed

-1: running

task_switch

String

Specifies the task switch.

total_num

Integer

Total Instances

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: 401

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

Status code: 403

Table 8 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 9 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 10 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 11 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v3/{project_id}/audit/summary/{busi_type}/task-status

Example Responses

Status code: 200

OK

{
  "id" : 32,
  "project_id" : "b9351f98c724428794ba7d105fa3558d",
  "busi_type" : "risk",
  "task_switch" : "off",
  "task_status" : "2",
  "total_num" : 10,
  "completed_num" : 10,
  "begin_time" : 1753427737077,
  "end_time" : 1753427757803,
  "query_begin_time" : 1752974753000,
  "query_end_time" : 1753427733000
}

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.