Deleting a Security Report Subscription

Function

This API is used to delete a security report subscription.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
subscription_id	Yes	String	Definition ID of the subscription to be deleted. You can obtain the ID by calling the API for querying security report subscriptions. Constraints N/A Range N/A Default Value N/A
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 contains 32 characters. Only letters and digits are supported. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the 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 3** Response body parameters
Parameter	Type	Description
subscription_id	String	Definition Subscription ID, which uniquely identifies the current security report subscription. Constraints N/A Range N/A Default Value N/A
sending_period	String	Definition Preset time frame for sending the report. For example, morning indicates the security report will be sent in the morning. Constraints N/A Range morning: 00:00 to 06:00 noon: 06:00 to 12:00 afternoon: 12:00 to 18:00 evening: 12:00 to 18:00 Default Value N/A
report_name	String	Definition Report name, which is the name of the security report to be subscribed to. Constraints N/A Range N/A Default Value N/A
report_category	String	Definition Report type you want to subscribe to; for example, daily_report indicates the daily security report. Constraints N/A Range daily_report: daily report weekly_report: weekly report monthly_report: monthly report custom_report: custom report Default Value N/A
topic_urn	String	Definition This parameter is required if security reports are received through message topics. To query the available topics, you can call the CloudLogService API used for querying SMN topics and find the topics in the topic_urn field in the response body. Constraints N/A Range N/A Default Value N/A
subscription_type	String	Definition The subscription method of receiving the security report. For example, silent indicates silent subscription. Constraints N/A Range smn_topic: message topic silent: silent message_center: message center Default Value N/A
report_content_subscription	report_content_subscription object	Definition Report content subscription, which is used to configure the enabling status of a specific statistics module contained in the subscription report. Constraints N/A Range N/A Default Value N/A
stat_period	stat_period object	Definition Statistical period, which is the default statistical time range of the subscription report. Constraints N/A Range N/A Default Value N/A
is_all_enterprise_project	Boolean	Definition Whether the subscription is applicable to all enterprise projects of the current tenant. (true: yes; false: no). Constraints N/A Range Only true and false are supported. Default Value false
enterprise_project_id	String	Definition Enterprise project ID, which uniquely identifies the enterprise project associated with the subscription. This parameter is valid only when is_all_enterprise_project is set to false. Constraints N/A Range N/A Default Value N/A

**Table 4** report_content_subscription
Parameter	Type	Description
overview_statistics_enable	Boolean	Definition Whether to enable the overview statistics (true: yes; false: no). Constraints N/A Range Only true and false are supported. Default Value true
group_by_day_enable	Boolean	Definition Whether to enable the daily statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true
request_statistics_enable	Boolean	Definition Whether to enable the request count statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true
qps_statistics_enable	Boolean	Definition Whether to enable the QPS statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true
bandwidth_statistics_enable	Boolean	Definition Whether to enable the bandwidth statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true
response_code_statistics_enable	Boolean	Definition Whether to enable the response code statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true
attack_type_distribution_enable	Boolean	Definition Whether to enable the attack type distribution statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true
top_attacked_domains_enable	Boolean	Definition Whether to enable the top attacked domain name statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true
top_attack_source_ips_enable	Boolean	Definition Whether to enable the top attacked source IP address statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true
top_attacked_urls_enable	Boolean	Definition Whether to enable the top attacked URL statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true
top_attack_source_locations_enable	Boolean	Definition Whether to enable the top attacked source geographical location statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true
top_abnormal_urls_enable	Boolean	Definition Whether to enable the top abnormal URL statistics (true: enabled; false: disabled). Constraints N/A Range Only true and false are supported. Default Value true

**Table 5** stat_period
Parameter	Type	Description
begin_time	Long	Definition Start time, which is the start timestamp (in milliseconds) of the subscription report statistics period. Constraints N/A Range N/A Default Value N/A
end_time	Long	Definition End time, which is the end timestamp (in milliseconds) of the subscription report statistics period. Constraints N/A Range N/A Default Value N/A

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

None

Example Responses

None

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 DeleteSecurityReportSubscriptionSolution {

    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();
        DeleteSecurityReportSubscriptionRequest request = new DeleteSecurityReportSubscriptionRequest();
        request.withSubscriptionId("{subscription_id}");
        try {
            DeleteSecurityReportSubscriptionResponse response = client.deleteSecurityReportSubscription(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 = DeleteSecurityReportSubscriptionRequest()
        request.subscription_id = "{subscription_id}"
        response = client.delete_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)
 
 
  

     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("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := waf.NewWafClient(hcClient)

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

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code	Description
200	OK
400	Request failed.
401	The token does not have required permissions.
500	Internal server error.

Error Codes

See Error Codes.

Parent Topic: Managing Security Reports

Previous topic: Modifying Security Report Subscription

Next topic: Managing Asynchronous Tasks

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot