Creating an Event Subscription
Function
This API is used to create an event 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:event:createSubscription
Write
-
-
dws:eventSub:create
-
URI
POST /v2/{project_id}/event-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 Event subscription name. Range N/A |
| source_type | No | String | Definition: Event source type Range: |
| source_id | No | String | Definition Event source ID. Range N/A |
| category | No | String | Definition Event category. Range management, monitor, security, or system alarm. |
| severity | No | String | Definition Event severity. Range The value can be normal or warning. |
| tag | No | String | Definition Event tag. Range N/A |
| enable | No | Integer | Definition Whether to enable subscription. Range 1: enabled; 0: disabled. |
| notification_target | Yes | String | Definition Message notification 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 | No | String | Definition Time zone. Range N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Subscription ID. Range N/A |
| name | String | Definition Subscription name. Range N/A |
| source_type | String | Definition: Event source type Range: |
| source_id | String | Definition Event source ID. Range N/A |
| category | String | Definition: Event Category. Range: |
| severity | String | Definition Event severity. Range N/A |
| tag | String | Definition Event tag. Range N/A |
| enable | Integer | Definition Whether to enable subscription. Range 1: enabled; 0: disabled. |
| project_id | String | Definition Project ID. Range N/A |
| name_space | String | Definition Service. Range N/A |
| notification_target | String | Definition Address for the message notification topic. Range N/A |
| notification_target_name | String | Definition Message notification topic. 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 |
Example Requests
Create an event subscription (Subscription name dws-test-66. Event severity: normal,warning. Message topic dws-test-nodelete. Address: urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete)
post https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/event-subs
{
"severity" : "normal",
"source_id" : "",
"source_type" : "cluster",
"tag" : "",
"category" : "management",
"enable" : 1,
"name" : "dws-test-66",
"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"
} Example Responses
Status code: 200
Event subscription created.
{
"id" : "41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b",
"name" : "dws-test-66",
"category" : "management",
"severity" : "normal",
"enable" : 1,
"language" : "zh-cn",
"source_type" : "cluster",
"tag" : "",
"source_id" : "",
"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"
} SDK Sample Code
The SDK sample code is as follows.
Create an event subscription (Subscription name dws-test-66. Event severity: normal,warning. Message topic dws-test-nodelete. 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 | 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 CreateEventSubSolution { 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(); CreateEventSubRequest request = new CreateEventSubRequest(); EventSubRequest body = new EventSubRequest(); 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.withEnable(1); body.withTag(""); body.withSeverity("normal"); body.withCategory("management"); body.withSourceId(""); body.withSourceType("cluster"); body.withName("dws-test-66"); request.withBody(body); try { CreateEventSubResponse response = client.createEventSub(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 event subscription (Subscription name dws-test-66. Event severity: normal,warning. Message topic dws-test-nodelete. 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 | # 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 = CreateEventSubRequest() request.body = EventSubRequest( 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", enable=1, tag="", severity="normal", category="management", source_id="", source_type="cluster", name="dws-test-66" ) response = client.create_event_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 event subscription (Subscription name dws-test-66. Event severity: normal,warning. Message topic dws-test-nodelete. 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 63 64 65 66 67 68 69 | 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.CreateEventSubRequest{} timeZoneEventSubRequest:= "GMT+08:00" enableEventSubRequest:= int32(1) tagEventSubRequest:= "" severityEventSubRequest:= "normal" categoryEventSubRequest:= "management" sourceIdEventSubRequest:= "" sourceTypeEventSubRequest:= "cluster" request.Body = &model.EventSubRequest{ TimeZone: &timeZoneEventSubRequest, NotificationTargetType: "SMN", NotificationTargetName: "dws-test-nodelete", NotificationTarget: "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", Enable: &enableEventSubRequest, Tag: &tagEventSubRequest, Severity: &severityEventSubRequest, Category: &categoryEventSubRequest, SourceId: &sourceIdEventSubRequest, SourceType: &sourceTypeEventSubRequest, Name: "dws-test-66", } response, err := client.CreateEventSub(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 | Event 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