Creating an Event Subscription
Function
This API is used to add a subscribed event.
Call Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/event-subs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the ID, see Obtaining Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Event subscription name |
source_type |
No |
String |
The following event source types are supported:
|
source_id |
No |
String |
Event source ID |
category |
No |
String |
The following event types are supported:
Enumerated value: Use commas (,) to separate multiple enumerated values. |
severity |
No |
String |
The event severity can be normal or warning. |
tag |
No |
String |
Tag |
enable |
No |
Integer |
Whether to enable subscription
|
notification_target |
Yes |
String |
Message notification address |
notification_target_name |
Yes |
String |
Message notification topic name |
notification_target_type |
Yes |
String |
The message notification type can only be SMN. |
time_zone |
No |
String |
Time zone |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Subscription ID |
name |
String |
Subscription name |
source_type |
String |
Event source type |
source_id |
String |
Event source ID |
category |
String |
Event type |
severity |
String |
Event severity |
tag |
String |
Tag |
enable |
Integer |
Whether to enable subscription
|
project_id |
String |
Project ID |
name_space |
String |
Service |
notification_target |
String |
Address for the message notification topic |
notification_target_name |
String |
Message notification topic |
notification_target_type |
String |
Message notification type |
language |
String |
Language |
time_zone |
String |
Time zone |
Example Request
To enable the "normal" and "warning" event subscription named zrf-test-66 and select the message topic dws-test-nodelete whose address is urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete:
https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/event-subs { "severity" : "normal,warning", "source_id" : "", "source_type" : "", "tag" : "", "category" : "", "enable" : 1, "name" : "zrf-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 Response
Status code: 200
{ "id" : "41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b", "name" : "zrf-test-66", "category" : "", "severity" : "normal,warning", "tag" : "", "enable" : 1, "language" : "zh-cn", "source_type" : "", "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 sample code is as follows:
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 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("cn-north-4")) .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,warning"); body.withCategory(""); body.withSourceId(""); body.withSourceType(""); body.withName("zrf-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()); } } } |
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 |
# coding: utf-8 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("cn-north-4")) \ .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,warning", category="", source_id="", source_type="", name="zrf-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) |
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dws.NewDwsClient( dws.DwsClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). WithCredential(auth). Build()) request := &model.CreateEventSubRequest{} timeZoneEventSubRequest:= "GMT+08:00" enableEventSubRequest:= int32(1) tagEventSubRequest:= "" severityEventSubRequest:= "normal,warning" categoryEventSubRequest:= "" sourceIdEventSubRequest:= "" sourceTypeEventSubRequest:= "" 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: "zrf-test-66", } response, err := client.CreateEventSub(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.
Status Code
Status Code |
Description |
---|---|
200 |
The event subscription is created successfully. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
You do not have required permissions. |
404 |
No resources found. |
500 |
Internal server error. |
503 |
The service was unavailable. |
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