Batch Deleting Alarm Notifications
Function
This API is used to batch delete alarm notifications.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/waf/alert/batch-delete
| 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 contains 32 characters. Only letters and digits are supported. Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| enterpriseProjectId | Yes | String | Definition Enterprise project ID. Constraints N/A Range N/A Default Value N/A |
| X-Auth-Token | No | String | Definition User token, which is used for identity authentication. You can obtain the token by calling the IAM API for obtaining a user token. Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Language | Yes | String | Language. The default value is en-us. zh-cn: Chinese; en-us: English. |
| Content-Type | Yes | String | Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| alert_notice_configs | Yes | Array of DeleteAlertNoticeConfigBody objects | Definition IDs of the alarms to be deleted. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| alert_notice_configs | Array of AlertNoticeConfig objects | Definition Alarm notification configuration list. Constraints N/A Range N/A Default Value N/A |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Alarm ID, which uniquely identifies an alarm notification configuration. Constraints N/A Range N/A Default Value N/A |
| enabled | Boolean | Definition Whether to enable the alarm notification configuration. Constraints N/A Range N/A Default Value N/A |
| topic_urn | String | Definition Notification template, which is associated with the SMN topic URN used to send alarm notifications. 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 |
| sendfreq | Integer | Definition Notification frequency, which controls the interval at which alarm notifications are sent. Constraints N/A Range N/A Default Value N/A |
| local | String | Definition Region, which specifies the language or region-related configuration of alarm notifications. Constraints N/A Range N/A Default Value N/A |
| times | Integer | Definition Notification frequency, which works with sendfreq to control the alarm sending frequency. Constraints N/A Range N/A Default Value N/A |
| name | String | Definition Alarm name, which is used to identify the name of the alarm notification configuration. Constraints N/A Range N/A Default Value N/A |
| notice_class | String | Definition Alarm type, which is used to distinguish alarms in different scenarios, such as protection rule triggering and resource exceptions. Constraints N/A Range N/A Default Value N/A |
| nearly_expired_time | Long | Definition Number of days in advance for expiration notifications. Constraints N/A Range N/A Default Value N/A |
| is_all_enterprise_project | Boolean | Definition Whether the alarm configuration is applicable to all enterprise projects. Constraints N/A Range N/A Default Value N/A |
| description | String | Definition Description of the alarm notification configuration. Constraints N/A Range N/A Default Value N/A |
| prefer_html | Boolean | Reserved parameter, which can be ignored. |
| threat | Array of strings | Alarm event type. |
Status code: 400
| 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. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error codes of the downstream service. |
| error_msg | String | Error messages of the downstream service. |
Status code: 401
| 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. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error codes of the downstream service. |
| error_msg | String | Error messages of the downstream service. |
Status code: 500
| 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. |
Example Requests
Batch delete alarm notifications.
POST https://{endpoint}/v2/{project_id}/waf/alert/batch-delete?enterprise_project_id=0
{
"alert_notice_configs" : [ {
"id" : "alert_notice_configs_id"
} ]
} Example Responses
Status code: 200
Request succeeded.
{
"alert_notice_configs" : [ {
"id" : "alert_notice_configs_id"
} ]
} SDK Sample Code
The SDK sample code is as follows.
Batch delete alarm notifications.
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 48 49 50 51 52 53 54 55 56 57 | 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.*; import java.util.List; import java.util.ArrayList; public class BatchDeleteAlertNoticeConfigSolution { 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(); BatchDeleteAlertNoticeConfigRequest request = new BatchDeleteAlertNoticeConfigRequest(); BatchDeleteAlertNoticeConfigBody body = new BatchDeleteAlertNoticeConfigBody(); List<DeleteAlertNoticeConfigBody> listbodyAlertNoticeConfigs = new ArrayList<>(); listbodyAlertNoticeConfigs.add( new DeleteAlertNoticeConfigBody() .withId("alert_notice_configs_id") ); body.withAlertNoticeConfigs(listbodyAlertNoticeConfigs); request.withBody(body); try { BatchDeleteAlertNoticeConfigResponse response = client.batchDeleteAlertNoticeConfig(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()); } } } |
Batch delete alarm notifications.
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 | # 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 = BatchDeleteAlertNoticeConfigRequest() listAlertNoticeConfigsbody = [ DeleteAlertNoticeConfigBody( id="alert_notice_configs_id" ) ] request.body = BatchDeleteAlertNoticeConfigBody( alert_notice_configs=listAlertNoticeConfigsbody ) response = client.batch_delete_alert_notice_config(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Batch delete alarm notifications.
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 48 49 50 51 52 53 54 55 56 57 58 | 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.BatchDeleteAlertNoticeConfigRequest{} idAlertNoticeConfigs:= "alert_notice_configs_id" var listAlertNoticeConfigsbody = []model.DeleteAlertNoticeConfigBody{ { Id: &idAlertNoticeConfigs, }, } request.Body = &model.BatchDeleteAlertNoticeConfigBody{ AlertNoticeConfigs: listAlertNoticeConfigsbody, } response, err := client.BatchDeleteAlertNoticeConfig(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 | Request succeeded. |
| 400 | Request failed. |
| 401 | The token does not have required permissions. |
| 500 | Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot