Querying the Monthly Operations Report List
Function
This API is used to query the monthly operations report list.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/operational-report/reports
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Parameter description: Number of records displayed on each page. Constraints: N/A Options: 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
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 |
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
|
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
|
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 }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListMonthlyOperationReportsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListMonthlyOperationReportsRequest request = new ListMonthlyOperationReportsRequest(); try { ListMonthlyOperationReportsResponse response = client.listMonthlyOperationReports(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListMonthlyOperationReportsRequest() response = client.list_monthly_operation_reports(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListMonthlyOperationReportsRequest{} response, err := client.ListMonthlyOperationReports(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Monthly operations report list |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot