文档首页/ Web应用防火墙 WAF/ API参考/ API/ waf-security-report-controller/ 修改安全报告的订阅
更新时间：2025-09-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改安全报告的订阅

功能介绍

修改安全报告的订阅

调用方法

请参见如何调用API。

URI

PUT /v1/{project_id}/waf/security-report/subscriptions/{subscription_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

用户项目id，对应控制台用户名->我的凭证->项目列表->项目ID，用于标识租户所属项目。

约束限制：

不涉及

取值范围：

长度32-64字符

默认取值：

不涉及

subscription_id

是

String

参数解释：

订阅ID，唯一标识待修改的安全报告订阅，从安全报告订阅列表接口获取。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

租户token，用于身份验证，通过调用IAM服务获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

长度32-4096字符

默认取值：

不涉及

Content-Type

是

String

参数解释：

内容类型，指定请求体的数据格式。

约束限制：

不涉及

取值范围：

长度32-64字符

默认取值：

application/json;charset=utf8
表3 请求Body参数

参数

是否必选

参数类型

描述

sending_period

是

String

参数解释：

报告发送的时间段

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

report_name

是

String

参数解释：

报告名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

report_category

是

String

参数解释：

报告类别

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

topic_urn

否

String

参数解释：

主题urn

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

display_name

否

String

参数解释：

主题的显示名

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

subscription_type

是

String

参数解释：

订阅类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

report_content_subscription

是

report_content_subscription object

参数解释：

报告内容订阅，配置订阅报告包含的具体统计模块启用状态。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

stat_period

否

stat_period object

参数解释：

统计周期

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

report_status

否

String

参数解释：

报告开启状态

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表4 report_content_subscription

参数

是否必选

参数类型

描述

overview_statistics_enable

否

Boolean

参数解释：

是否启用总览统计内容（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

group_by_day_enable

否

Boolean

参数解释：

是否启用按天分组统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

request_statistics_enable

否

Boolean

参数解释：

是否启用请求次数统计内容（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

qps_statistics_enable

否

Boolean

参数解释：

是否启用QPS统计内容（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

bandwidth_statistics_enable

否

Boolean

参数解释：

是否启用带宽统计内容（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

response_code_statistics_enable

否

Boolean

参数解释：

是否启用响应码统计内容（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

attack_type_distribution_enable

否

Boolean

参数解释：

是否启用攻击类型分布统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

top_attacked_domains_enable

否

Boolean

参数解释：

是否启用TOP被攻击域名统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

top_attack_source_ips_enable

否

Boolean

参数解释：

是否启用TOP攻击源IP统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

top_attacked_urls_enable

否

Boolean

参数解释：

是否启用TOP被攻击URL统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

top_attack_source_locations_enable

否

Boolean

参数解释：

是否启用TOP攻击源地理位置统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

top_abnormal_urls_enable

否

Boolean

参数解释：

是否启用TOP异常URL统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true
表5 stat_period

参数

是否必选

参数类型

描述

begin_time

否

Long

参数解释：

开始时间，统计周期的起始时间点（毫秒级时间戳）

格式要求：

符合Unix时间戳规范，精确到毫秒

取值范围：

1970-01-01 00:00:00 UTC至今的时间戳

end_time

否

Long

参数解释：

结束时间，统计周期的终止时间点（毫秒级时间戳）

格式要求：

符合Unix时间戳规范，精确到毫秒

取值范围：

大于begin_time且在1970-01-01 00:00:00 UTC至今的时间戳

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

subscription_id

String

参数解释：

订阅ID，唯一标识当前安全报告订阅。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

sending_period

String

参数解释：

发送时间段，标识报告的预设发送时间（如morning表示早晨时段）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

report_name

String

参数解释：

报告名称，当前安全报告订阅的报告名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

report_category

String

参数解释：

报告类别，标识订阅的报告类型（如daily_report表示安全日报）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

topic_urn

String

参数解释：

主题urn，关联订阅报告发送的SMN主题唯一标识。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

subscription_type

String

参数解释：

订阅类型，标识安全报告的订阅方式（如slient表示静默订阅）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

report_content_subscription

report_content_subscription object

参数解释：

报告内容订阅，配置订阅报告包含的具体统计模块启用状态。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

stat_period

stat_period object

参数解释：

统计周期，订阅报告的默认统计时间范围配置。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

is_all_enterprise_project

Boolean

参数解释：

是否是所有企业项目，标识订阅是否适用于当前租户的所有企业项目（true表示适用，false表示仅适用指定项目）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

false

enterprise_project_id

String

参数解释：

企业项目ID，订阅关联的企业项目唯一标识（is_all_enterprise_project为false时生效）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表7 report_content_subscription

参数

参数类型

描述

overview_statistics_enable

Boolean

参数解释：

是否启用总览统计内容（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

group_by_day_enable

Boolean

参数解释：

是否启用按天分组统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

request_statistics_enable

Boolean

参数解释：

是否启用请求次数统计内容（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

qps_statistics_enable

Boolean

参数解释：

是否启用QPS统计内容（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

bandwidth_statistics_enable

Boolean

参数解释：

是否启用带宽统计内容（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

response_code_statistics_enable

Boolean

参数解释：

是否启用响应码统计内容（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

attack_type_distribution_enable

Boolean

参数解释：

是否启用攻击类型分布统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

top_attacked_domains_enable

Boolean

参数解释：

是否启用TOP被攻击域名统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

top_attack_source_ips_enable

Boolean

参数解释：

是否启用TOP攻击源IP统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

top_attacked_urls_enable

Boolean

参数解释：

是否启用TOP被攻击URL统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

top_attack_source_locations_enable

Boolean

参数解释：

是否启用TOP攻击源地理位置统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true

top_abnormal_urls_enable

Boolean

参数解释：

是否启用TOP异常URL统计（true表示启用，false表示禁用）。

约束限制：

不涉及

取值范围：

仅支持true、false两个布尔值

默认取值：

true
表8 stat_period

参数

参数类型

描述

begin_time

Long

参数解释：

开始时间，订阅报告统计周期的起始时间戳（毫秒级）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

end_time

Long

参数解释：

结束时间，订阅报告统计周期的终止时间戳（毫秒级）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码：401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表12 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表14 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

无

响应示例

无

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
 
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class UpdateSecurityReportSubscriptionSolution {

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

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateSecurityReportSubscriptionRequest request = new UpdateSecurityReportSubscriptionRequest();
        request.withSubscriptionId("{subscription_id}");
        UpdateSecurityReportSubscriptionRequestBody body = new UpdateSecurityReportSubscriptionRequestBody();
        request.withBody(body);
        try {
            UpdateSecurityReportSubscriptionResponse response = client.updateSecurityReportSubscription(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
 
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.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 = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateSecurityReportSubscriptionRequest()
        request.subscription_id = "{subscription_id}"
        request.body = UpdateSecurityReportSubscriptionRequestBody(
        )
        response = client.update_security_report_subscription(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
 
package main

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

    request := &model.UpdateSecurityReportSubscriptionRequest{}
	request.SubscriptionId = "{subscription_id}"
	request.Body = &model.UpdateSecurityReportSubscriptionRequestBody{
	}
	response, err := client.UpdateSecurityReportSubscription(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： waf-security-report-controller

相关文档