Querying the Security Report Subscription List

Function

This API is used to query the security report subscription list.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	Yes	String	Definition Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps. Constraints N/A Range all_granted_eps: all enterprise projects. Default Value all_granted_eps
report_name	No	String	Definition Report template name. Constraints N/A Range Enter a maximum of 256 characters. Only letters, digits, underscores (_), hyphens (-), periods (.), and colons (:) are allowed. Default Value N/A
report_category	No	String	Definition Report type. Constraints N/A Range daily_report: daily security reports weekly_report: weekly security reports monthly_report: monthly security reports custom_report: custom security reports Default Value N/A
report_status	No	String	Definition Status. Constraints N/A Range opened: enabled closed: disabled Default Value N/A
offset	No	Integer	Definition Start position of the pagination query. This parameter specifies from which record you want to retrieve (counting starts from 0). Constraints N/A Range N/A Default Value 0
limit	No	Integer	Definition Number of records returned on each page of a paginated query. This parameter specifies how many records you want to retrieve each time. Constraints N/A Range N/A Default Value 1000

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer
items	Array of SecurityReportSubscriptionSummaryResponse objects

**Table 5** SecurityReportSubscriptionSummaryResponse
Parameter	Type	Description
subscription_id	String	Definition subscription ID. Range N/A
report_id	String	Definition Report ID. Range N/A
report_name	String	Definition Report template name. Range Enter a maximum of 256 characters. Only letters, digits, underscores (_), hyphens (-), periods (.), and colons (:) are allowed.
sending_period	String	Definition Time range for sending reports. Range morning: 00:00-06:00 noon: 06:00-12:00 afternoon: 12:00-18:00 evening: 18:00-24:00
report_category	String	Definition Report type. Range daily_report: daily security reports. weekly_report: weekly security reports monthly_report: monthly security reports custom_report: custom security reports
report_status	String	Definition Status. Range opened: enabled closed: disabled
is_all_enterprise_project	Boolean	Definition Whether all enterprise projects are included. Range true: all enterprise projects false: not all enterprise projects
enterprise_project_id	String	Definition ID of the enterprise project included in the current report. Range N/A
template_eps_id	String	Definition Enterprise project the generated report belongs to. Range N/A
is_report_created	Boolean	Definition Report status. Range true: generated false: not generated
latest_create_time	Long	Definition Time the report was generated. Range 13-bit millisecond timestamp.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.
details	Array of IAM5ErrorDetails objects	The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

**Table 7** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.
details	Array of IAM5ErrorDetails objects	The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

**Table 9** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.
details	Array of IAM5ErrorDetails objects	The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

**Table 11** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Example Requests

The following example shows how to query the security report subscription list of all enterprise projects. The project ID is project_id.

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

Example Responses

Status code: 200

{
  "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 Sample Code

The SDK sample code is as follows.

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

          

        

      
     

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

          

        

      
     

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

          

        

      
     