Help Center/ Cloud Firewall/ API Reference/ API/ Security report./ Querying the Security Report Template List
Updated on 2025-08-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Security Report Template List

Function

This API is used to query the security report template list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/report-profile

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

32-bit UUID.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

category

No

String

Definition

Report type.

Constraints

N/A

Range

daily: daily report

weekly: weekly report

custom: custom report

Default Value

N/A

fw_instance_id

Yes

String

Definition

Firewall ID. It is a unique ID generated after a firewall instance is created. You can obtain the firewall ID by referring to Obtaining a Firewall ID.

Constraints

N/A

Range

32-bit UUID.

Default Value

N/A

limit

Yes

Integer

Definition

Maximum number of records that can be returned.

Constraints

N/A

Range

1-1024

Default Value

N/A

offset

Yes

Integer

Definition

Offset. The records after this offset will be queried.

Constraints

N/A

Range

0 - 1024

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

data object

Definition

Response to the request for querying the template list.

Range

N/A
Table 4 data

Parameter

Type

Description

limit

Integer

Definition

Quantity limit.

Range

N/A

offset

Integer

Definition

Offset.

Range

N/A

records

Array of ReportProfileVO objects

Definition

Template list.

Range

N/A

total

Integer

Definition

Total number.

Range

N/A
Table 5 ReportProfileVO

Parameter

Type

Description

profile_id

String

Definition

Template ID.

Range

N/A

name

String

Definition

Template name.

Range

N/A

category

String

Definition

Template type.

Range

daily: daily report

weekly: weekly report

custom: custom report

status

Integer

Definition

Enabling status.

Range

N/A

report_id

String

Definition

Latest report ID.

Range

N/A

last_time

Long

Definition

Latest report generation time.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Example Requests

Query the security report template list of the firewall whose project ID is eb7accd78ea845078275b2ad5280a109 and firewall ID is 8a996d43-75bd-48b4-b1b8-de0706b72b8f. The offset is 0, and the maximum number of returned records is 10.

https://{Endpoint}/v1/eb7accd78ea845078275b2ad5280a109/report-profile?fw_instance_id=8a996d43-75bd-48b4-b1b8-de0706b72b8f&offset=0&limit=10

Example Responses

Status code: 200

OK

{
  "data" : {
    "limit" : 10,
    "offset" : 0,
    "records" : [ {
      "profile_id" : "53a9d352-4b35-4703-801a-0dbcfc306fc5",
      "name" : "test",
      "category" : "custom",
      "status" : 1,
      "report_id" : "2ff069b3-1ef8-4a6e-9aaf-d7308eeba826",
      "last_time" : 1749814939598
    } ],
    "total" : 1
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "Parameter error."
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: Security report.