更新时间:2026-01-29 GMT+08:00
分享

创建安全报告 - CreateReport

功能介绍

创建安全报告

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Region

String

区域ID

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

report_name

String

报告名称

report_period

String

报告周期 weekly, daily, annual, monthly

report_range

report_range object

数据范围

language

String

语言

notification_task

String

通知任务id

layout_id

String

布局id

title

String

邮件标题

to

String

收件人邮箱

cc

String

抄送人邮箱

content

String

邮件内容

report_file_type

String

报告类型,支持图片、pdf、html

frequency

String

报告发送频率,daily,monthly,weekly

binding_wizard

String

报告页面内容

timezone

String

信息

report_rule_infos

Array of ReportRuleRequest objects

报告发送规则

表4 report_range

参数

是否必选

参数类型

描述

start

String

起始时间

end

String

终止时间

表5 ReportRuleRequest

参数

是否必选

参数类型

描述

rule

String

报告发送任务cron表达式

rule_end

String

报告发送任务启动截止时间

start_time

start_time object

报告统计周期的开始时间

end_time

end_time object

报告统计周期的结束时间

表6 start_time

参数

是否必选

参数类型

描述

day

Integer

报告统计周期的日期,前一天为-1,当天为0

week

Integer

报告统计周期的日期,前一周为-1,本周为0

month

Integer

报告统计周期的日期,上一月为-1,本月为0

time

String

报告统计周期的开始,具体时间,时分秒格式

表7 end_time

参数

是否必选

参数类型

描述

day

Integer

报告统计周期的日期,前一天为-1,当天为0

week

Integer

报告统计周期的日期,前一周为-1,本周为0

month

Integer

报告统计周期的日期,上一月为-1,本月为0

time

String

报告统计周期的结束,具体时间,时分秒格式

响应参数

状态码:200

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表9 响应Body参数

参数

参数类型

描述

-

String

响应示例

状态码:400

表10 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表11 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

创建报告请求体

{
  "layout_id" : "b240d19f-7bdb-39cd-bfc2-0d4b86d8747f",
  "report_period" : "weekly",
  "notification_task" : "b6940c3beee4413381be3f257ab6fb2d",
  "language" : "zh-CN",
  "report_name" : "q6YSAc1KBy",
  "binding_wizard" : "{\"binding_buttons\":[],\"boa_version\":\"v4\",\"create_time\":\"2025-11-20T10:51:40Z+0800\",\"creator_id\":\"b40b54b1f27a4224aa0c95ede5b5a46a\",\"creator_name\":\"l00644738\",\"workspace_id\":\"75645d0a-93b8-4a7f-a77c-e97009389445\"}",
  "report_range" : {
    "start" : "1662900406226",
    "end" : "1662900406226"
  }
}

响应示例

状态码:200

请求成功

"success"

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
48
49
50
51
52
53
54
55
56
57
58
59
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.secmaster.v1.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v1.*;
import com.huaweicloud.sdk.secmaster.v1.model.*;


public class CreateReportSolution {

    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);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateReportRequest request = new CreateReportRequest();
        request.withWorkspaceId("{workspace_id}");
        CreateReportRequestBody body = new CreateReportRequestBody();
        CreateReportRequestBodyReportRange reportRangebody = new CreateReportRequestBodyReportRange();
        reportRangebody.withStart("1662900406226")
            .withEnd("1662900406226");
        body.withLayoutId("b240d19f-7bdb-39cd-bfc2-0d4b86d8747f");
        body.withNotificationTask("b6940c3beee4413381be3f257ab6fb2d");
        body.withLanguage("zh-CN");
        body.withReportRange(reportRangebody);
        body.withReportPeriod(CreateReportRequestBody.ReportPeriodEnum.fromValue("weekly"));
        body.withReportName("q6YSAc1KBy");
        request.withBody(body);
        try {
            CreateReportResponse response = client.createReport(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
32
33
34
35
36
37
38
39
40
41
42
43
44
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v1 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 = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateReportRequest()
        request.workspace_id = "{workspace_id}"
        reportRangebody = CreateReportRequestBodyReportRange(
            start="1662900406226",
            end="1662900406226"
        )
        request.body = CreateReportRequestBody(
            layout_id="b240d19f-7bdb-39cd-bfc2-0d4b86d8747f",
            notification_task="b6940c3beee4413381be3f257ab6fb2d",
            language="zh-CN",
            report_range=reportRangebody,
            report_period="weekly",
            report_name="q6YSAc1KBy"
        )
        response = client.create_report(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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/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 := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateReportRequest{}
	request.WorkspaceId = "{workspace_id}"
	reportRangebody := &model.CreateReportRequestBodyReportRange{
		Start: "1662900406226",
		End: "1662900406226",
	}
	notificationTaskCreateReportRequestBody:= "b6940c3beee4413381be3f257ab6fb2d"
	request.Body = &model.CreateReportRequestBody{
		LayoutId: "b240d19f-7bdb-39cd-bfc2-0d4b86d8747f",
		NotificationTask: &notificationTaskCreateReportRequestBody,
		Language: "zh-CN",
		ReportRange: reportRangebody,
		ReportPeriod: model.GetCreateReportRequestBodyReportPeriodEnum().WEEKLY,
		ReportName: "q6YSAc1KBy",
	}
	response, err := client.CreateReport(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功

400

请求失败

错误码

请参见错误码

相关文档