Configuring SMN Alarm Notification

Function

This API is used to query details about sensitive information options.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/waf/tag/antileakage/map

**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 N/A Default Value ''

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
lang	Yes	String	Definition Language. Constraints N/A Range N/A Default Value N/A

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 for obtaining a user token (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
leakagemap	leakagemap object	Definition Content type and return code of sensitive information Constraints N/A Range N/A Default Value N/A
locale	locale object	Definition Description of each type in the sensitive information option. Constraints N/A Range N/A Default Value N/A

**Table 5** leakagemap
Parameter	Type	Description
sensitive	Array of strings	Definition Content type of sensitive information. Constraints N/A Range N/A Default Value N/A
code	Array of strings	Definition Return code of sensitive information. Constraints N/A Range N/A Default Value N/A

**Table 6** locale
Parameter	Type	Description
code	String	Definition Response code interception, which is used to capture and process specific HTTP response codes. Constraints N/A Range N/A Default Value N/A
id_card	String	Definition ID card number, which is the unique code for identifying an individual. Constraints N/A Range N/A Default Value N/A
sensitive	String	Definition Sensitive information filtering, which is used to detect and process sensitive information. Constraints N/A Range N/A Default Value N/A
400	String	Definition The client request has syntax errors and cannot be recognized by the server. Constraints N/A Range N/A Default Value N/A
phone	String	Definition Phone number, which is used for contact. Constraints N/A Range N/A Default Value N/A
401	String	Definition Unauthorized. The request is unauthorized. Identity authentication is required. Constraints N/A Range N/A Default Value N/A
500	String	Definition Internal server error. The server encounters an unexpected error. Constraints N/A Range N/A Default Value N/A
402	String	Definition Payment is required. The request can continue only after payment is made. Constraints N/A Range N/A Default Value N/A
501	String	Definition The server does not support the functionality required to fulfill the request. Constraints N/A Range N/A Default Value N/A
403	String	Definition "Forbidden." The server understands the request but refuses to process it. Constraints N/A Range N/A Default Value N/A
502	String	Definition Error gateway. The server functions as a gateway or proxy and receives an invalid response from the upstream server. Constraints N/A Range N/A Default Value N/A
404	String	Definition The requested resource does not exist. Constraints N/A Range N/A Default Value N/A
503	String	Definition The service is unavailable. The server cannot process the request. Constraints N/A Range N/A Default Value N/A
405	String	Definition The request method is not allowed. Constraints N/A Range N/A Default Value N/A
504	String	Definition The gateway times out. The server functions as a gateway or proxy but does not receive requests from the upstream server in time. Constraints N/A Range N/A Default Value N/A
507	String	Definition Insufficient storage. The server cannot store the content required to complete the request. Constraints N/A Range N/A Default Value N/A
email	String	Definition Email address, which is used for electronic communication. Constraints N/A Range N/A Default Value N/A

Status code: 400

**Table 7** 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 8** 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 9** 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 10** 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 11** 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 12** IAM5ErrorDetails
Parameter	Type	Description
error_code	String	Error codes of the downstream service.
error_msg	String	Error messages of the downstream service.

Example Requests

GET https://{Endpoint}/v1/{project_id}/waf/tag/antileakage/map?lang=cn&enterprise_project_id=0

Example Responses

Status code: 200

{
  "leakagemap" : {
    "sensitive" : [ "id_card", "phone", "email" ],
    "code" : [ "400", "401", "402", "403", "404", "405", "500", "501", "502", "503", "504", "507" ]
  },
  "locale" : {
    "code" : "Response code interception",
    "id_card" : "ID card number",
    "sensitive" : "Sensitive information filtering",
    "400" : "400",
    "phone" : "Phone number",
    "401" : "401",
    "500" : "500",
    "402" : "402",
    "501" : "501",
    "403" : "403",
    "502" : "502",
    "404" : "404",
    "503" : "503",
    "405" : "405",
    "504" : "504",
    "507" : "507",
    "email" : "Email"
  }
}

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

    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();
        ConfirmPolicyAntileakageMapRequest request = new ConfirmPolicyAntileakageMapRequest();
        try {
            ConfirmPolicyAntileakageMapResponse response = client.confirmPolicyAntileakageMap(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 = ConfirmPolicyAntileakageMapRequest()
        response = client.confirm_policy_antileakage_map(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.ConfirmPolicyAntileakageMapRequest{}
	response, err := client.ConfirmPolicyAntileakageMap(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     