Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Security Reports/ Querying the Security Report List
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Security Report List

Function

ListReports

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/sa/reports

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

report_period

Yes

String

Report period.

status

Yes

String

Status.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of ReportInfo objects

ReportInfo
Table 6 ReportInfo

Parameter

Type

Description

id

String

Report ID.

report_name

String

Report name.

report_period

String

Report period. The options are weekly, daily, annual, and monthly.

report_range

report_range object

Data scope.

language

String

Language.

notification_task

String

Notification task ID.

layout_id

String

Layout ID.

status

String

Report status. enable or disable.

is_generated

Boolean

Whether the report has been generated.

report_rule_infos

Array of ReportRuleInfo objects

report rules
Table 7 report_range

Parameter

Type

Description

start

String

Start time.

end

String

End time.
Table 8 ReportRuleInfo

Parameter

Type

Description

id

String

Report sending rule ID.

project_id

String

User ID.

workspace_id

String

Workspace ID.

cycle

String

Data period.

rule

String

Cron expression.

start_time

String

Start time of the report data period.

end_time

String

End time of the report data period.

email_title

String

Email subject.

email_to

String

Recipient email address.

email_content

String

Email content.

report_file_type

String

Report type. Image, PDF, and HTML are supported.

Status code: 400

Table 9 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.
Table 10 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

Error Codes

See Error Codes.

Parent topic: Security Reports