查询月度运营报告列表
功能介绍
查询月度运营报告列表
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/operational-report/reports
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data_list |
Array of OperationSummaryInfo objects |
参数解释: 运营报告列表 取值范围: 最小值0,最大值10000 |
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0,最大值10000 |
参数 |
参数类型 |
描述 |
---|---|---|
hss_visit_days |
Integer |
参数解释: 用户访问HSS天数 取值范围: 最小值0,最大值365 |
workload_beat_rate |
Float |
参数解释: 某个工作超过的用户百分比(目前只有漏洞或告警,哪个打败的用户占比高,显示哪个) 取值范围: 最小值0,最大值1 |
user_name |
String |
参数解释: 用户名 取值范围: 字符长度0-128位 |
current_month_start |
Long |
参数解释: 当前月初时间戳 取值范围: 最小值0,最大值9223372036854775807 |
current_month_end |
Long |
参数解释: 当前月末时间戳 取值范围: 最小值0,最大值9223372036854775807 |
handled_security_event_num |
Long |
参数解释: 处置的安全事件条数 取值范围: 最小值0,最大值2147483647 |
total_workload_beat_rate |
Float |
参数解释: 工作量打败的用户百分比 取值范围: 最小值0,最大值1 |
title |
String |
参数解释: 称号 取值范围: -vul-fix-master: 补洞大师。 -vul-fix-expert: 漏洞修复小能手。 -baseline-handle: 风险配置处置高手。 -malware-file: 防病毒先锋。 -ransomware-event: 防勒索达人。 -web-tamper-event: 网站守卫。 |
report_id |
String |
参数解释: 时间字符串 取值范围: 字符长度0-32位 |
current_month |
Integer |
参数解释: 当前月份 取值范围: 最小值1,最大值12 |
work |
String |
参数解释: 工作(哪个打败的用户占比高,显示哪个) 取值范围: -vul-fix: 漏洞修复 -baseline-handle: 基线处置 -event-handle: 处置入侵事件 |
create_time |
Long |
参数解释: 报告生成时间戳 取值范围: 最小值0,最大值9223372036854775807 |
请求示例
查询租户的月度运营报告列表
GET https://{endpoint}/v5/{project_id}/operational-report/reports
响应示例
状态码:200
月度运营报告列表
{ "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代码示例
SDK代码示例如下。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
月度运营报告列表 |
错误码
请参见错误码。