Help Center/ Database Security Service/ API Reference/ API/ Report Management/ Obtaining the Scheduled Task Configuration Information of a Report (Topic Mode)
Updated on 2025-09-10 GMT+08:00

Obtaining the Scheduled Task Configuration Information of a Report (Topic Mode)

Function

Obtaining the Scheduled Task Configuration Information of a Report (Topic Mode)

URI

GET /v2/{project_id}/audit/{instance_id}/reports/tasks/{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

id

Yes

String

Definition:

Template ID. You can obtain the value by obtaining the report template interface ID.

** Restrictions**:

N/A

Range:

The value is subject to the value of the interface for obtaining the report template. The value contains 16 to 64 characters.

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

scheduler

SchedulerConfigBase object

Scheduling settings.

smn_effective

Boolean

Whether to support subscription

  • true: support

  • false: not supported

Table 4 SchedulerConfigBase

Parameter

Type

Description

db_ids

String

Database ID.

format

String

File type.

frequency

String

Period

  • AUDIT_REPORT_DAY: day

  • AUDIT_REPORT_WEEK: week

  • AUDIT_REPORT_MONTH: month

  • AUDIT_REPORT_YEAR: year

  • AUDIT_REPORT_REAL_TIME: real-time

id

String

Report template ID.

mode

String

Scheduling mode.

notice

String

Whether to send notifications.

  • OFF: no

  • ON: yes

start_time

String

Start time

status

String

Template status

topic_urn

String

Topic URN

Status code: 400

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

Status code: 401

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

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

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

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

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

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v2/{project_id}/audit/{instance_id}/reports/tasks/{id}

Example Responses

Status code: 200

OK

{
  "scheduler" : null,
  "smn_effective" : true
}

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.