# 查询安全报告订阅 - ShowSecurityReportSubscription #### 功能介绍 查询安全报告订阅 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-waf/waf_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-waf/waf_02_0119.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | waf:securityReportSubscription:get | Read | - | g:EnterpriseProjectId | - | - | #### URI GET /v1/{project_id}/waf/security-report/subscriptions/{subscription_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | subscription_id | 是 | String | **参数解释：** 需要查询的订阅id，从"查询安全报告订阅列表"中获取 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | project_id | 是 | String | **参数解释：** 项目ID，对应控制台用户名-\>我的凭证-\>项目列表-\>项目ID。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 租户token | | Content-Type | 是 | String | **参数解释：** 内容类型 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** application/json;charset=utf8 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | subscription_id | String | **参数解释：** 订阅ID，唯一标识当前安全报告订阅。 **取值范围：** 不涉及 | | report_id | String | **参数解释：** 报告ID，关联当前订阅的最新安全报告唯一标识。 **取值范围：** 不涉及 | | sending_period | String | **参数解释：** 发送时间段，标识报告的预设发送时间（如morning表示早晨时段）。 **取值范围：** - morning : 00:00\~06:00 - noon : 06:00\~12:00 - afternoon : 12:00\~18:00 - evening : 12:00\~18:00 | | report_name | String | **参数解释：** 报告名称，当前安全报告订阅的报告名称。 **取值范围：** 不涉及 | | report_category | String | **参数解释：** 报告类别，设置订阅的报告类型（如daily_report表示安全日报）。 **取值范围：** - daily_report : 日报 - weekly_report ： 周报 - monthly_report ： 月报 - custom_report ： 自定义 | | report_status | String | **参数解释：** 报告开启状态 **取值范围：** - opened：已开启 - closed：已关闭 | | topic_urn | String | **参数解释：** 报告接收方式使用消息主题类型时需要填该参数。 查询可使用的主题，通过 云日志服务的"查询SMN主题"接口，返回体中的"topic_urn"字段 **取值范围：** 不涉及 | | subscription_type | String | **参数解释：** 订阅类型，接收安全报告的订阅方式（如slient表示静默订阅）。 **取值范围：** - smn_topic : 消息主题 - silent ： 静默 - message_center ： 消息中心 | | report_content_subscription | [report_content_subscription] object | **参数解释：** 报告内容订阅，配置订阅报告包含的具体统计模块启用状态。 **取值范围：** 不涉及 | | stat_period | [stat_period] object | **参数解释：** 统计周期，订阅报告的默认统计时间范围配置。 **取值范围：** 不涉及 | | is_all_enterprise_project | Boolean | **参数解释：** 是否是所有企业项目，标识订阅是否适用于当前租户的所有企业项目（true表示适用，false表示仅适用指定项目）。 **取值范围：** 仅支持true、false两个布尔值 | | enterprise_project_id | String | **参数解释：** 企业项目ID，订阅关联的企业项目唯一标识（is_all_enterprise_project为false时生效）。 **取值范围：** 不涉及 | | template_eps_id | String | **参数解释：** 模板企业项目ID，订阅关联的模板企业项目唯一标识。 **取值范围：** 不涉及 | | is_report_created | Boolean | **参数解释：** 是否已生成报告，标识当前订阅是否已生成过安全报告（true表示已生成，false表示未生成）。 **取值范围：** 仅支持true、false两个布尔值 | | latest_create_time | Long | **参数解释：** 最近生成时间，最近一次生成安全报告的时间戳（毫秒级）。 **取值范围：** 不涉及 | 表4report_content_subscription | 参数 | 参数类型 | 描述 | |:---|:---|:---| | overview_statistics_enable | Boolean | **参数解释：** 是否启用总览统计内容（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | group_by_day_enable | Boolean | **参数解释：** 是否启用按天分组统计（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | request_statistics_enable | Boolean | **参数解释：** 是否启用请求次数统计内容（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | qps_statistics_enable | Boolean | **参数解释：** 是否启用QPS统计内容（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | bandwidth_statistics_enable | Boolean | **参数解释：** 是否启用带宽统计内容（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | response_code_statistics_enable | Boolean | **参数解释：** 是否启用响应码统计内容（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | attack_type_distribution_enable | Boolean | **参数解释：** 是否启用攻击类型分布统计（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | top_attacked_domains_enable | Boolean | **参数解释：** 是否启用TOP被攻击域名统计（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | top_attack_source_ips_enable | Boolean | **参数解释：** 是否启用TOP攻击源IP统计（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | top_attacked_urls_enable | Boolean | **参数解释：** 是否启用TOP被攻击URL统计（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | top_attack_source_locations_enable | Boolean | **参数解释：** 是否启用TOP攻击源地理位置统计（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | | top_error_pages_enable | Boolean | **参数解释：** 是否启用TOP异常页面统计（true表示启用，false表示禁用）。 **取值范围：** 仅支持true、false两个布尔值 | 表5stat_period | 参数 | 参数类型 | 描述 | |:---|:---|:---| | begin_time | Long | **参数解释：** 开始时间，订阅报告统计周期的起始时间戳（毫秒级）。 **取值范围：** 不涉及 | | end_time | Long | **参数解释：** 结束时间，订阅报告统计周期的终止时间戳（毫秒级）。 **取值范围：** 不涉及 | **状态码：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鉴权错误时才会返回此字段。 | 表7IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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鉴权错误时才会返回此字段。 | 表9IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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鉴权错误时才会返回此字段。 | 表11IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | #### 请求示例 无 #### 响应示例 **状态码：200** ``` { "subscription_id" : "subscription_id_e4dc839e3374", "report_id" : "report_id_e091acbf3882", "report_name" : "report_name_fb1d7ca750d9", "sending_period" : "sending_period_7bd7af9f982b", "report_category" : "report_category_e7fc39714728", "report_status" : "report_status_3e4032a9b8c1", "topic_urn" : "topic_urn_3bdad7ad545b", "subscription_type" : "subscription_type_407196b359fc", "report_content_subscription" : { "overview_statistics_enable" : false, "group_by_day_enable" : false, "request_statistics_enable" : false, "qps_statistics_enable" : false, "bandwidth_statistics_enable" : false, "response_code_statistics_enable" : false, "attack_type_distribution_enable" : false, "top_attacked_domains_enable" : false, "top_attack_source_ips_enable" : false, "top_attacked_urls_enable" : false, "top_attack_source_locations_enable" : false, "top_error_pages_enable" : false }, "stat_period" : { "begin_time" : 0, "end_time" : 0 }, "is_all_enterprise_project" : false, "enterprise_project_id" : "enterprise_project_id_a3689dd280f8", "template_eps_id" : "template_eps_id_6ad12cb48938", "is_report_created" : false, "latest_create_time" : 0 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ShowSecurityReportSubscriptionSolution { 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("")) .build(); ShowSecurityReportSubscriptionRequest request = new ShowSecurityReportSubscriptionRequest(); request.withSubscriptionId("{subscription_id}"); try { ShowSecurityReportSubscriptionResponse response = client.showSecurityReportSubscription(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ShowSecurityReportSubscriptionRequest() request.subscription_id = "{subscription_id}" response = client.show_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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := waf.WafClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := waf.NewWafClient(hcClient) request := &model.ShowSecurityReportSubscriptionRequest{} request.SubscriptionId = "{subscription_id}" response, err := client.ShowSecurityReportSubscription(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WAF/sdk?api=ShowSecurityReportSubscription)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 报告订阅响应 | | 400 | 请求失败 | | 401 | token权限不足 | | 500 | 服务器内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-waf/ErrorCode.html)。