Creating a Notification Policy
Function
This API is used to create a notification policy.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/notifications/topics/{topic_urn}/notify-policy
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. For details about how to obtain the project ID, see Obtaining the Project ID. |
topic_urn |
Yes |
String |
Specifies the resource identifier of the topic, which is unique. To obtain the resource identifier, see Querying Topics. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
protocol |
Yes |
String |
Specifies the notification policy type. Only the voice notification policies are supported. |
polling |
Yes |
Array of PollingPolicyRequest objects |
Specifies the subscription endpoint in a polling notification policy. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique request ID. |
id |
String |
Specifies the notification policy ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique ID of a request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique ID of a request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique ID of a request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique ID of a request. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Example Requests
Creating a polling notification policy.
POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2/notify-policy { "protocol" : "callnotify", "polling" : [ { "order" : 1, "subscription_urns" : [ "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f", "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222" ] }, { "order" : 2, "subscription_urns" : [ "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f", "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222" ] } ] }
Example Responses
Status code: 201
Notification policy created.
{ "request_id" : "f6832d5dd17f4090b0e29c6f9a026b17", "id" : "7824d9c2f4e94fdfabd9fcdd4da0d564" }
SDK Sample Code
The SDK sample code is as follows.
Creating a polling notification policy.
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 70 71 |
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.smn.v2.region.SmnRegion; import com.huaweicloud.sdk.smn.v2.*; import com.huaweicloud.sdk.smn.v2.model.*; import java.util.List; import java.util.ArrayList; public class CreateNotifyPolicySolution { 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); SmnClient client = SmnClient.newBuilder() .withCredential(auth) .withRegion(SmnRegion.valueOf("<YOUR REGION>")) .build(); CreateNotifyPolicyRequest request = new CreateNotifyPolicyRequest(); request.withTopicUrn("{topic_urn}"); NotifyPolicyRequestBody body = new NotifyPolicyRequestBody(); List<String> listPollingSubscriptionUrns = new ArrayList<>(); listPollingSubscriptionUrns.add("urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f"); listPollingSubscriptionUrns.add("urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222"); List<String> listPollingSubscriptionUrns1 = new ArrayList<>(); listPollingSubscriptionUrns1.add("urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f"); listPollingSubscriptionUrns1.add("urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222"); List<PollingPolicyRequest> listbodyPolling = new ArrayList<>(); listbodyPolling.add( new PollingPolicyRequest() .withOrder(1) .withSubscriptionUrns(listPollingSubscriptionUrns1) ); listbodyPolling.add( new PollingPolicyRequest() .withOrder(2) .withSubscriptionUrns(listPollingSubscriptionUrns) ); body.withPolling(listbodyPolling); body.withProtocol(NotifyPolicyRequestBody.ProtocolEnum.fromValue("callnotify")); request.withBody(body); try { CreateNotifyPolicyResponse response = client.createNotifyPolicy(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()); } } } |
Creating a polling notification policy.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksmn.v2.region.smn_region import SmnRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksmn.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 = SmnClient.new_builder() \ .with_credentials(credentials) \ .with_region(SmnRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateNotifyPolicyRequest() request.topic_urn = "{topic_urn}" listSubscriptionUrnsPolling = [ "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f", "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222" ] listSubscriptionUrnsPolling1 = [ "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f", "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222" ] listPollingbody = [ PollingPolicyRequest( order=1, subscription_urns=listSubscriptionUrnsPolling1 ), PollingPolicyRequest( order=2, subscription_urns=listSubscriptionUrnsPolling ) ] request.body = NotifyPolicyRequestBody( polling=listPollingbody, protocol="callnotify" ) response = client.create_notify_policy(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creating a polling notification policy.
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 main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" smn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := smn.NewSmnClient( smn.SmnClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateNotifyPolicyRequest{} request.TopicUrn = "{topic_urn}" var listSubscriptionUrnsPolling = []string{ "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f", "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222", } var listSubscriptionUrnsPolling1 = []string{ "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f", "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222", } var listPollingbody = []model.PollingPolicyRequest{ { Order: int32(1), SubscriptionUrns: listSubscriptionUrnsPolling1, }, { Order: int32(2), SubscriptionUrns: listSubscriptionUrnsPolling, }, } request.Body = &model.NotifyPolicyRequestBody{ Polling: listPollingbody, Protocol: model.GetNotifyPolicyRequestBodyProtocolEnum().CALLNOTIFY, } response, err := client.CreateNotifyPolicy(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.
Creating a polling notification policy.
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 70 71 |
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.smn.v2.region.SmnRegion; import com.huaweicloud.sdk.smn.v2.*; import com.huaweicloud.sdk.smn.v2.model.*; import java.util.List; import java.util.ArrayList; public class CreateNotifyPolicySolution { 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); SmnClient client = SmnClient.newBuilder() .withCredential(auth) .withRegion(SmnRegion.valueOf("<YOUR REGION>")) .build(); CreateNotifyPolicyRequest request = new CreateNotifyPolicyRequest(); request.withTopicUrn("{topic_urn}"); NotifyPolicyRequestBody body = new NotifyPolicyRequestBody(); List<String> listPollingSubscriptionUrns = new ArrayList<>(); listPollingSubscriptionUrns.add("urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f"); listPollingSubscriptionUrns.add("urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222"); List<String> listPollingSubscriptionUrns1 = new ArrayList<>(); listPollingSubscriptionUrns1.add("urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f"); listPollingSubscriptionUrns1.add("urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222"); List<PollingPolicyRequest> listbodyPolling = new ArrayList<>(); listbodyPolling.add( new PollingPolicyRequest() .withOrder(1) .withSubscriptionUrns(listPollingSubscriptionUrns1) ); listbodyPolling.add( new PollingPolicyRequest() .withOrder(2) .withSubscriptionUrns(listPollingSubscriptionUrns) ); body.withPolling(listbodyPolling); body.withProtocol(NotifyPolicyRequestBody.ProtocolEnum.fromValue("callnotify")); request.withBody(body); try { CreateNotifyPolicyResponse response = client.createNotifyPolicy(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()); } } } |
Creating a polling notification policy.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksmn.v2.region.smn_region import SmnRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksmn.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 = SmnClient.new_builder() \ .with_credentials(credentials) \ .with_region(SmnRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateNotifyPolicyRequest() request.topic_urn = "{topic_urn}" listSubscriptionUrnsPolling = [ "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f", "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222" ] listSubscriptionUrnsPolling1 = [ "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f", "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222" ] listPollingbody = [ PollingPolicyRequest( order=1, subscription_urns=listSubscriptionUrnsPolling1 ), PollingPolicyRequest( order=2, subscription_urns=listSubscriptionUrnsPolling ) ] request.body = NotifyPolicyRequestBody( polling=listPollingbody, protocol="callnotify" ) response = client.create_notify_policy(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creating a polling notification policy.
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 main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" smn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := smn.NewSmnClient( smn.SmnClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateNotifyPolicyRequest{} request.TopicUrn = "{topic_urn}" var listSubscriptionUrnsPolling = []string{ "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f", "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222", } var listSubscriptionUrnsPolling1 = []string{ "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b521f", "urn:smn:regionId:240489644ad14ace8e022869d34411a4:eee:45c05e14762c478aa2ef6b16153b5222", } var listPollingbody = []model.PollingPolicyRequest{ { Order: int32(1), SubscriptionUrns: listSubscriptionUrnsPolling1, }, { Order: int32(2), SubscriptionUrns: listSubscriptionUrnsPolling, }, } request.Body = &model.NotifyPolicyRequestBody{ Polling: listPollingbody, Protocol: model.GetNotifyPolicyRequestBodyProtocolEnum().CALLNOTIFY, } response, err := client.CreateNotifyPolicy(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 |
---|---|
201 |
Notification policy created. |
400 |
Bad Request |
403 |
Unauthorized |
404 |
Not Found |
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