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

Updating the Status of a Tenant Audit Information Summary Task

Function

Update the status of a tenant audit information summary task.

URI

POST /v1/{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].

Constraints

N/A

Range

The value is determined by the value of the IAM API. The value contains 32 to 64 characters.

Default Value

N/A

busi_type

Yes

String

Definition

Service type.

Constraints

The value is case sensitive and is subject to the value range.

Range

  • risk: risk

  • risk: audit instance

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

Constraints

N/A

Range

Determined by the value of the IAM API used for querying user tokens.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

code

No

String

Operation code. This parameter is mandatory when operType is set to switch.

  • on: enabled

  • off: disabled

oper_type

Yes

String

Operation Type

  • switch: task switch

  • execute: update immediately

query_begin_time

No

Long

Query condition: start time

query_end_time

No

Long

Query condition: end time

Response Parameters

Status code: 200

Operation successful

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

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

{
  "code" : "on",
  "oper_type" : "switch"
}

Example Responses

None

Status Codes

Status Code

Description

200

Operation successful

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.