Querying the Monthly Operations Report List

Function

This API is used to query the monthly operations report list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/operational-report/reports

**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. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
data_list	Array of OperationSummaryInfo objects	Definition Operation report list Range Minimum value: 0; maximum value: 10000
total_num	Integer	Definition Total number. Range Minimum value: 0; maximum value: 10000

**Table 4** OperationSummaryInfo
Parameter	Type	Description
hss_visit_days	Integer	Definition Number of days when a user accesses HSS Range Minimum value: 0; maximum value: 365
workload_beat_rate	Float	Definition The percentage of users whose vulnerability or alarm handling performance is lower than the current user's performance. (The higher percentage is displayed.) Range Minimum value: 0; maximum value: 1
user_name	String	Definition Username Range Length: 0 to 128 characters
current_month_start	Long	Definition Timestamp at the beginning of the current month. Range Minimum value: 0; maximum value: 9223372036854775807
current_month_end	Long	Definition Timestamp at the end of the current month. Range Minimum value: 0; maximum value: 9223372036854775807
handled_security_event_num	Long	Definition Number of handled security events. Range Minimum value: 0; maximum value: 2147483647
total_workload_beat_rate	Float	Definition The percentage of users whose security issue handling performance is lower than the current user's performance. Range Minimum value: 0; maximum value: 1
title	String	Definition Title Range vul-fix-master: Master of Vulnerability Management vul-fix-expert: Vulnerability Virtuoso baseline-handle: Master of Secure Configurations malware-file: Antivirus Pioneer ransomware-event: Ransomware Fighter web-tamper-event: Website Guardian
report_id	String	Definition Time string. Range Length: 0 to 32 characters
current_month	Integer	Definition Current month. Range Minimum value: 1; maximum value: 12
work	String	Definition Handled security issue type. (The type with the highest percentage of users whose performance is lower than the current user's performance is displayed.) Range -vul-fix: vulnerability fixing baseline-handle: baseline handling event-handle: intrusion handling
create_time	Long	Definition Report generation timestamp. Range Minimum value: 0; maximum value: 9223372036854775807

Example Requests

Query the monthly operations report list of a user.

GET https://{endpoint}/v5/{project_id}/operational-report/reports

Example Responses

Status code: 200

Monthly operations report list

{
  "data_list" : [ {
    "hss_visit_days" : 31,
    "workload_beat_rate" : 0.99,
    "user_name" : "scc_hss_g00840938_01",
    "current_month_start" : 1753977600000,
    "current_month_end" : 1756655999999,
    "handled_security_event_num" : 2025,
    "total_workload_beat_rate" : 0.974359,
    "title" : "malware-file",
    "report_id" : "2025-08",
    "current_month" : 8,
    "work" : "event-handle",
    "create_time" : 1756659606563
  } ],
  "total_num" : 15
}

Status Codes

Status Code	Description
200	Monthly operations report list

Error Codes

See Error Codes.

Parent Topic: Dashboard

Previous topic: Querying the Details of a Monthly Operations Report

Next topic: Querying the Information in the News and Promotions Area of a Monthly Operations Report

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot