文档首页/ Web应用防火墙 WAF/ API参考/ API/ 安全报告/ 查询安全报告订阅列表
更新时间:2025-09-09 GMT+08:00

查询安全报告订阅列表

功能介绍

查询安全报告订阅列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/waf/security-report/subscriptions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制:

不涉及

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。仅支持查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。

约束限制:

不涉及

取值范围:

  • all_granted_eps:所有企业项目

默认取值:

all_granted_eps

report_name

String

参数解释:

报告模板名称

约束限制:

不涉及

取值范围:

只能由中文、字母、数字和括号内所列符号(_-.::)组成,且不能超过256个字符长度。

默认取值:

不涉及

report_category

String

参数解释:

报告类型

约束限制:

不涉及

取值范围:

daily_report:安全日报

weekly_report:安全周报

monthly_report:安全月报

custom_report:自定义报告

默认取值:

不涉及

report_status

String

参数解释:

开启状态

约束限制:

不涉及

取值范围:

opened:已开启

closed:已关闭

默认取值:

不涉及

offset

Integer

参数解释:

分页查询的起始位置,表示从第几条记录开始返回(从0开始计数)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0

limit

Integer

参数解释:

分页查询的单页返回数量,控制每次请求返回的记录条数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

返回的总数

取值范围:

不涉及

items

Array of SecurityReportSubscriptionSummaryResponse objects

参数解释:

订阅的安全报告项列表

取值范围:

不涉及

表5 SecurityReportSubscriptionSummaryResponse

参数

参数类型

描述

subscription_id

String

参数解释:

订阅ID

取值范围:

不涉及

report_id

String

参数解释:

报告ID

取值范围:

不涉及

report_name

String

参数解释:

报告模板名称

取值范围:

只能由中文、字母、数字和括号内所列符号(_-.::)组成,且不能超过256个字符长度。

sending_period

String

参数解释:

发送时间段

取值范围:

  • morning:00:00~06:00

  • noon:06:00~12:00

  • afternoon:12:00~18:00

  • evening:18:00~24:00

report_category

String

参数解释:

报告类型

取值范围:

  • daily_report:安全日报

  • weekly_report:安全周报

  • monthly_report:安全月报

  • custom_report:自定义报告

report_status

String

参数解释:

开启状态

取值范围:

  • opened:已开启

  • closed:已关闭

is_all_enterprise_project

Boolean

参数解释:

是否是所有企业项目

取值范围:

  • true:是所有企业项目

  • false:不是所有企业项目

enterprise_project_id

String

参数解释:

企业项目ID,当前报告统计的企业项目范围

取值范围:

不涉及

template_eps_id

String

参数解释:

报告所属项目,生成的报告所归属的企业项目

取值范围:

不涉及

is_report_created

Boolean

参数解释:

报告生成状态

取值范围:

  • true:已生成

  • false:暂未生成

latest_create_time

Long

参数解释:

报告生成时间

取值范围:

13位毫秒时间戳

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表7 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表9 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

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

details

Array of IAM5ErrorDetails objects

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

表11 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

查询项目id为project_id,所有企业项目下的安全报告订阅列表。

GET https://{endpoint}/v1/{project_id}/waf/security-report/subscriptions?enterprise_project_id=all_granted_eps

响应示例

状态码:200

OK

{
  "total" : 1,
  "items" : [ {
    "subscription_id" : "25e9444bb9634aaca0d0258964d254b3",
    "report_id" : "76200fad90d84e19be8015f9e956fbe3",
    "report_name" : "test",
    "sending_period" : "morning",
    "report_category" : "monthly_report",
    "report_status" : "opened",
    "is_all_enterprise_project" : true,
    "enterprise_project_id" : "all_granted_eps",
    "template_eps_id" : 0,
    "is_report_created" : true,
    "latest_create_time" : 1741197940369
  } ]
}

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


public class ListSecurityReportSubscriptionsSolution {

    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();
        ListSecurityReportSubscriptionsRequest request = new ListSecurityReportSubscriptionsRequest();
        try {
            ListSecurityReportSubscriptionsResponse response = client.listSecurityReportSubscriptions(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 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 = ListSecurityReportSubscriptionsRequest()
        response = client.list_security_report_subscriptions(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"
    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.ListSecurityReportSubscriptionsRequest{}
	response, err := client.ListSecurityReportSubscriptions(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码