Creating an Alarm Subscription
Function
This API is used to create an alarm subscription.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
dws:alarm:createSubscription
Write
-
-
dws:alarmSub:create
-
URI
POST /v2/{project_id}/alarm-subs
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | Definition Subscribed alarm name. Range N/A |
| enable | No | Integer | Definition Whether to enable subscription. Range N/A |
| alarm_level | No | String | Definition Alarm severity. Range N/A |
| notification_target | Yes | String | Definition Message topic address. Range N/A |
| notification_target_name | Yes | String | Definition Message topic name. Range N/A |
| notification_target_type | Yes | String | Definition: Message topic type Range: |
| time_zone | Yes | String | Definition Time zone. Range N/A |
| cluster_id | No | String | Definition Cluster ID. Range N/A |
| alarm_detail | No | String | Definition Fine-grained alarm details. The alarm ID and alarm severity are separated by colons (:), and alarms are separated by commas (,). If this field is not empty, the alarm_level field must be left empty. Range N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Alarm subscription ID. Range N/A |
| name | String | Definition Subscribed alarm name. Range N/A |
| enable | Integer | Definition Whether to enable subscription. Range N/A |
| alarm_level | String | Definition Alarm severity. Range N/A |
| project_id | String | Definition Project ID. Range N/A |
| name_space | String | Definition Service to which the alarm belongs. Range N/A |
| notification_target | String | Definition Message topic address. Range N/A |
| notification_target_name | String | Definition Message topic name. Range N/A |
| notification_target_type | String | Definition: Message topic type Range: |
| language | String | Definition Language. Range N/A |
| time_zone | String | Definition Time zone. Range N/A |
| cluster_id | String | Definition Cluster ID. Range N/A |
| alarm_details | Array of AlarmSubDetailResopnse objects | Definition Details about all subscribed alarms. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Alarm configuration ID. Range N/A. |
| alarm_id | String | Definition Alarm definition ID. Range N/A. |
| alarm_name | String | Definition Alarm name. Range N/A. |
| name_space | String | Definition Service. Range N/A |
| alarm_level | String | Definition Alarm severity. Range N/A. |
Example Requests
Create an alarm subscription (Subscription name: dws-test-12. Cluster ID: 52e42b4f-90de-40c2-91f6-31d7728f6a32. SMN topic name: dws-test-nodelete. Topic address: urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete).
post https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs
{
"name" : "dws-test-12",
"enable" : 1,
"alarm_level" : "urgent,important,minor",
"notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
"notification_target_name" : "dws-test-nodelete",
"notification_target_type" : "SMN",
"time_zone" : "GMT+08:00",
"cluster_id" : "52e42b4f-90de-40c2-91f6-31d7728f6a32"
} Example Responses
Status code: 200
Alarm subscription created.
{
"id" : "273ce506-dad8-411c-92f9-be5004739b40",
"name" : "dws-test-12",
"enable" : 1,
"language" : "zh-cn",
"alarm_level" : "urgent,important,minor",
"project_id" : "4cf650fd46704908aa071b4df2453e1e",
"name_space" : "dws",
"notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
"notification_target_name" : "dws-test-nodelete",
"notification_target_type" : "SMN",
"time_zone" : "GMT+08:00",
"cluster_id" : "52e42b4f-90de-40c2-91f6-31d7728f6a32",
"alarm_details" : [ {
"id" : "011ceecb-4c09-47b7-8b19-d3ebd03f1f67",
"alarm_id" : "DWS_2000000031",
"alarm_name" : "Active Session Usage in a DWS Cluster Exceeded Threshold",
"name_space" : "dws",
"alarm_level" : "important"
}, {
"id" : "2471e04b-b972-47d3-adbb-5500ddbb8f95",
"alarm_id" : "DWS_2500000001",
"alarm_name" : "Schema Usage of the DWS Cluster Exceeds the Threshold",
"name_space" : "dws",
"alarm_level" : "important"
} ]
} SDK Sample Code
The SDK sample code is as follows.
Create an alarm subscription (Subscription name: dws-test-12. Cluster ID: 52e42b4f-90de-40c2-91f6-31d7728f6a32. SMN topic name: dws-test-nodelete. Topic address: urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete).
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.dws.v2.region.DwsRegion; import com.huaweicloud.sdk.dws.v2.*; import com.huaweicloud.sdk.dws.v2.model.*; public class CreateAlarmSubSolution { 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); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("<YOUR REGION>")) .build(); CreateAlarmSubRequest request = new CreateAlarmSubRequest(); AlarmSubRequest body = new AlarmSubRequest(); body.withClusterId("52e42b4f-90de-40c2-91f6-31d7728f6a32"); body.withTimeZone("GMT+08:00"); body.withNotificationTargetType("SMN"); body.withNotificationTargetName("dws-test-nodelete"); body.withNotificationTarget("urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete"); body.withAlarmLevel("urgent,important,minor"); body.withEnable(1); body.withName("dws-test-12"); request.withBody(body); try { CreateAlarmSubResponse response = client.createAlarmSub(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()); } } } |
Create an alarm subscription (Subscription name: dws-test-12. Cluster ID: 52e42b4f-90de-40c2-91f6-31d7728f6a32. SMN topic name: dws-test-nodelete. Topic address: urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete).
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdws.v2.region.dws_region import DwsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdws.v2 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 = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateAlarmSubRequest() request.body = AlarmSubRequest( cluster_id="52e42b4f-90de-40c2-91f6-31d7728f6a32", time_zone="GMT+08:00", notification_target_type="SMN", notification_target_name="dws-test-nodelete", notification_target="urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", alarm_level="urgent,important,minor", enable=1, name="dws-test-12" ) response = client.create_alarm_sub(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create an alarm subscription (Subscription name: dws-test-12. Cluster ID: 52e42b4f-90de-40c2-91f6-31d7728f6a32. SMN topic name: dws-test-nodelete. Topic address: urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete).
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 59 60 61 62 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/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 := dws.DwsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dws.NewDwsClient(hcClient) request := &model.CreateAlarmSubRequest{} clusterIdAlarmSubRequest:= "52e42b4f-90de-40c2-91f6-31d7728f6a32" alarmLevelAlarmSubRequest:= "urgent,important,minor" enableAlarmSubRequest:= int32(1) request.Body = &model.AlarmSubRequest{ ClusterId: &clusterIdAlarmSubRequest, TimeZone: "GMT+08:00", NotificationTargetType: "SMN", NotificationTargetName: "dws-test-nodelete", NotificationTarget: "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", AlarmLevel: &alarmLevelAlarmSubRequest, Enable: &enableAlarmSubRequest, Name: "dws-test-12", } response, err := client.CreateAlarmSub(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 | Alarm subscription created. |
| 400 | Request error. |
| 401 | Authentication failed. |
| 403 | You do not have required permissions. |
| 404 | No resources found. |
| 500 | Internal server error. |
| 503 | Service unavailable. |
What is your overall rating for this page?
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.
For any further questions, feel free to contact us through the chatbot.
Chatbot