Simple Message Notification
-Simple Message Notification (SMN) is a reliable and flexible large-scale message notification service. It enables you to efficiently send messages to various endpoints, such as phone numbers, and email addresses,
-SMN offers a publish/subscribe model to achieve one-to-multiple message subscriptions and notifications in a variety of message types. SMN involves two roles: publisher and subscriber. A publisher publishes messages to a topic, and SMN then delivers the messages to subscribers in the topic. The subscribers can be email addresses, phone numbers, message queues, and URLs.
-A topic is a collection of messages and a logical access point, through which the publisher and the subscriber can interact with each other. Each topic has a unique topic name. The topic creator can configure topic policies to grant other users or cloud services permissions to perform certain operations to a topic, for example, querying subscriptions or publishing messages.
+Simple Message Notification (SMN) is a reliable and flexible large-scale message notification service. It enables you to efficiently send messages to various endpoints, such as phone numbers and email addresses.
+SMN offers a publish/subscribe model to achieve one-to-multiple message subscriptions and notifications in a variety of message types. SMN involves two roles: publisher and subscriber. A publisher publishes messages to a topic, and SMN then delivers the messages to subscribers in the topic. The subscribers can be email addresses, phone numbers, and URLs.
+A topic is a collection of messages and a logical access point, through which the publisher and the subscriber can interact with each other. Each topic has a unique name. The topic creator can configure topic policies to grant other users or cloud services permissions to perform certain operations to a topic, for example, querying subscriptions or publishing messages.
Message Template Management
-Scenarios
Message templates contain fixed and changeable content and can be used to create and send messages more quickly. When you use a template to publish a message, you can specify values for different variables in the template.
+Scenarios
Message templates contain fixed and changeable content and can be used to create messages more quickly. When you use a template to publish a message, you need to specify values for different variables in the template.
Message templates are identified by name, but you can create different templates with the same name as long as they are configured for different protocols. All template messages must include a Default template or they cannot be sent out. The Default template is used anytime a template has not been configured for a given protocol, but as long as there is a template for the protocol, then any subscriber who selected that protocol when they subscribed will receive a message using the corresponding template.
This section describes how to publish messages using a template.
To Create a Message Template
- Log in to the management console.
- Click
on the upper left to select the desired region and project. - Under Application, select Simple Message Notification.
The SMN console is displayed.
- - In the navigation pane, choose Message Templates.
- In the upper right corner, click Create Message Template.
The Create Message Template dialog box is displayed.
-Figure 1 Create Message Template+
Creating a Message Template
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane on the left, choose Message Templates.
- In the upper right corner, click Create Message Template.
The Create Message Template dialog box is displayed.
+Figure 1 Create Message Template - Specify the template name, protocol, and content.
-
Table 1 Parameters required for creating a message template Parameter
Template Name
Template name, which:
-- Contains only letters, digits, hyphens (-), and underscores (_), and must start with a letter or digit.
- Can contain 1 to 64 bytes.
- Cannot be modified once the template is created.
- Contains only letters, digits, hyphens (-), and underscores (_) and must start with a letter or digit.
- Can contain 1 to 64 characters.
- Cannot be modified once the template is created.
Protocol
Endpoint protocol of the template, which cannot be changed once the template is created
-The protocol can be Default, SMS, HTTP, HTTPS, DMS, or Email.
+The protocol can be Default, SMS, HTTP, HTTPS, Email, or FunctionGraph (function).
If you do not specify a protocol, Default is used.
Content
Template content
-You can use variables as placeholders. Before you send messages using the template, SMN replaces the variables with the message content you specify. A variable can contain up to 21 characters and must start with a letter or digit. It can contain letters, digits, hyphens (-), underscores (_), and periods (.).
+Use {xxx} as the placeholder to create a template. When you use this template to publish messages, replace {xxx} with specific content. xxx must start with a letter or digit and can contain up to 21 characters, including only letters, digits, hyphens (-), periods (.), and underscores (_).
The message template must meet the following requirements:
-- The template supports plain text only.
- The template content cannot be left blank and cannot exceed 256 KB.
- The template can contain up to 256 variables in total, but that includes redundant variables. For unique variables, there can be no more than 90.
- When you send messages using a template, the message content you specify for each variable cannot exceed 1 KB.
- The template supports plain text only.
- The template content cannot be left blank and its size cannot exceed 256 KB.
- The template can contain up to 256 variables in total, but that includes redundant variables. For unique variables, there can be no more than 90.
- When you publish messages using a template, the message content you specify for each variable cannot exceed 1 KB.
For example, the template information is as follows:-- Template Name: tem_001
- Protocol: Default
- Content: The Arts and Crafts Exposition will be held from {startdate} through {enddate}. We sincerely invite you to join us.Figure 2 Create Message Template-
For example, the template information is as follows:- Template Name: tem_001
- Protocol: Default
- Content: The Arts and Crafts Exposition will be held from {startdate} through {enddate}. We sincerely invite you to join us.
- Click OK.
The template you created is displayed in the template list.
+To search for a template, enter the template name in the upper right corner of the message template list and click
or press Enter.To Modify a Template
- Locate the template to be modified in the template list.
- Click Modify under Operation to change its content.
-Modifying a Template
- On the Message Templates page, locate the template to be modified in the template list.
- Click Modify in the Operation column to change its content.
- - \ No newline at end of file diff --git a/docs/smn/umn/en-us_topic_0043394891.html b/docs/smn/umn/en-us_topic_0043394891.html index b72f278a4..872f14346 100644 --- a/docs/smn/umn/en-us_topic_0043394891.html +++ b/docs/smn/umn/en-us_topic_0043394891.html @@ -1,11 +1,11 @@To Delete a Template
- Locate the template to be deleted in the template list.
- Click Delete under Operation.
Deleting a Template
- On the Message Templates page, locate the template to be deleted in the template list.
- Click Delete in the Operation column.
Basic Mode
-The topic creator has the right to configure topic policies. Using topic policies, you can specify which users and cloud services can perform which topic operations, for example, querying topic details and publishing messages. Topic creators always have permissions over a topic even if they grant topic permissions to other users.
-Configuring Topic Policies in Basic Mode
- Log in to the management console.
- Click
on the upper left to select the desired region and project. - Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
-- Locate a topic, click More under Operation, and select Configure Topic Policy.
- In the Configure Topic Policy dialog box, configure the topic policy in basic mode.
The basic mode simply specifies which users or cloud services have permissions to publish messages to a topic. For details, see Table 1.
+Only users under the same account as the topic creator have the permissions to publish messages through the topic. Using topic policies, you can specify which usersor cloud services can perform what topic operations, for example, querying topic details and publishing messages. Topic creators always have permissions over a topic even if they grant topic permissions to other users.
+Configuring Topic Policies in Basic Mode
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
+ - Locate a topic, click More under Operation, and select Configure Topic Policy.
Alternatively, click a topic name. In the upper right corner of the displayed page, click Configure Topic Policy.
+ - In the Configure Topic Policy dialog box, configure the topic policy in basic mode.
The basic mode simply specifies which usersor cloud services have permissions to publish messages to the topic. For details, see Table 1.
Table 1 Description for configuring topic policies in basic mode Item
Topic creator
Only the topic creator has the permission to publish messages to the topic.
+Only users under the same account as the topic creator have the permissions to publish messages through the topic.
All users
@@ -29,9 +29,10 @@Specified user domains
Only specified users have the permission to publish messages to the topic. Users are specified in the following format: urn:csp:iam::domainId:root.
-You only need to enter the domain ID and click OK. The system completes all other required information for you. SMN does not limit the number of IDs you enter, but the total size of a topic policy cannot exceed 30 KB.
-To obtain your domain ID, log in to the SMN console. In the upper right corner, hover the mouse over your login account, and select My Credentials from the drop-down list.
+Only specified users have the permission to publish messages to the topic. Users are specified in the format urn:csp:iam::domainId:root.
+You only need to enter the domain ID and click OK. The system completes all other required information for you. SMN does not limit the number of IDs you enter, but the total size of a topic policy cannot exceed 30 KB.
+To obtain your domain ID, log in to the SMN console. In the upper right corner, hover the mouse over your login account and select My Credentials from the drop-down list.
+Enter one account ID or URN for each one line.
Services that can publish messages to this topic
@@ -40,7 +41,7 @@The services that can publish messages to a topic vary in different regions.
The selected cloud services have operation permissions of the topic.
-NOTE:By default, Cloud Eye and Anti-DDoS have the permission to publish messages to topics created by all users. For details about how to use SMN in other cloud services, see user guides of the related services.
+NOTE:By default, Cloud Eye and Anti-DDoS have the permissions to publish messages to topics created by all users. For details about how to use SMN in other cloud services, see user guides of the related services.
- Modifying the Display Name of a Topic
-
- Adding Tags to a Topic
+- Adding, Modifying, or Deleting a Topic Tag
- Configuring Topic Policies
diff --git a/docs/smn/umn/en-us_topic_0043961401.html b/docs/smn/umn/en-us_topic_0043961401.html index 7644bc132..b5ae62433 100644 --- a/docs/smn/umn/en-us_topic_0043961401.html +++ b/docs/smn/umn/en-us_topic_0043961401.html @@ -3,10 +3,9 @@
Creating a Topic
- - \ No newline at end of file diff --git a/docs/smn/umn/en-us_topic_0043961402.html b/docs/smn/umn/en-us_topic_0043961402.html index 83555fa6a..399ce3144 100644 --- a/docs/smn/umn/en-us_topic_0043961402.html +++ b/docs/smn/umn/en-us_topic_0043961402.html @@ -1,22 +1,64 @@-Scenarios
A topic is a specified event to publish messages and subscribe to notifications. It serves as a message sending channel, where publishers and subscribers can interact with each other.
To Create a Topic
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
-- In the upper right corner, click Create Topic.Figure 1 Create Topic+
Creating a Topic
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
+ - In the upper right corner, click Create Topic.Figure 1 Create Topic
- Enter a topic name and display name.
Table 1 Parameter descriptions Parameter
Topic Name
Topic name, which:
-- Contains only letters, digits, hyphens (-), and underscores (_), and must start with a letter or digit.
- Contain 1 to 255 characters.
- Must be unique and cannot be modified once the topic is created.
- Contains only letters, digits, hyphens (-), and underscores (_) and must start with a letter or digit.
- Contains 1 to 255 characters.
- Must be unique and cannot be modified once the topic is created.
Display Name
Message sender name, which must be fewer than 192 characters.
-NOTE:After you specify a display name, the sender in email messages will be presented as Display name<username@example.com>. Otherwise, the sender will be username@example.com.
+Message sender name, which can contain up to 192 bytes
+NOTE:After you specify a display name, the sender in email messages will be presented as Display name<noreply@otc.t-systems.com>. Otherwise, the sender will be noreply@otc.t-systems.com.
Tag
A tag is a key-value pair. Tags identify cloud resources so that you can easily categorize and search for your resources.
-- A key can contain up to 36 characters. A value can contain up to 43 characters. Both Key and Value can contain only digits, letters, hyphens (-), at signs (@), and underscores (_).
- You can add up to 10 tags for each topic.
- A key can contain up to 36 characters. A value can contain up to 43 characters. Both Key and Value can contain only digits, letters, hyphens (-), at signs (@), and underscores (_).
- You can add up to 20 tags for each topic.
- Click OK.
The topic you created is displayed in the topic list. The system generates a topic URN, which is the unique resource identifier of the topic and cannot be changed.
- - Click the name of the topic to view its details, including the URN, display name, and subscriptions.
To search for a topic, filter topics by project or enter the topic name in the upper right corner of the topic list. Then click
+
or press Enter. Alternatively, click Search by Tag above the upper right corner of the topic list and search for a topic by tag key and value.- Click the name of the topic to view its details, including the topic URN, display name, tags, and subscriptions.
@@ -46,10 +46,3 @@Adding a Subscription to a Topic
-Scenarios
To deliver messages published to a topic to subscription endpoints, you must add the endpoints to the topic.
++Scenarios
To deliver messages published to a topic to endpoints, you must add the subscription endpoints to the topic.
+Adding a Subscription
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
+ - Locate the topic that you want to add a subscription to. In the Operation column, click Add Subscription.
Alternatively, click a topic name. In the upper right corner of the displayed page, click Add Subscription.
+The Add Subscription dialog box is displayed.
+Figure 1 Add Subscription+
- Specify the subscription protocol and endpoints.
+-
Table 1 Parameters for adding a subscription Parameter
+Description
+Topic Name
+Specifies the name of the topic to which messages are published.
+Protocol
+Specifies the protocol over which messages are sent. Possible values are SMS, HTTP, HTTPS, FunctionGraph (function), and Email.
+Endpoint
+Specifies the subscription endpoint. You can add up to 10 SMS, email, HTTP, or HTTPS endpoints, one in each line.
+- SMS: Enter one or more valid phone numbers.
A phone number must be preceded by a plus sign (+) and a country code.
+Examples:
++4900000000
++4900000001
++4900000002
++4900000003
+ - Email: Enter one or more valid email addresses.
Examples:
+username@example.com
+username2@example.com
+ - HTTP: Enter one or more public network URLs.
Example:
+http://example.com/notification/action
+ - HTTPS: Enter one or more public network URLs.
Example:
+https://example.com/notification/action
+ - FunctionGraph (function): Click
to select a function and specify its version.
Version
+This parameter is only available if FunctionGraph (function) is selected for Protocol. Select the version for the function.
+Description
+Specifies the remarks of the subscription.
+- - \ No newline at end of file diff --git a/docs/smn/umn/en-us_topic_0043961403.html b/docs/smn/umn/en-us_topic_0043961403.html index 65f6ac0a7..7c9d3ddf1 100644 --- a/docs/smn/umn/en-us_topic_0043961403.html +++ b/docs/smn/umn/en-us_topic_0043961403.html @@ -5,39 +5,39 @@To Add a Subscription
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
-- Locate the topic that you want to add a subscription to. In the Operation column, choose More > Add Subscription.
The Add Subscription dialog box is displayed.
-Figure 1 Add Subscription-
- Specify the subscription protocol and endpoints. You can enter 10 endpoints at most, each on a separate line.
- Email
Enter a valid email address, for example, username@example.com.
-Subscribers will receive a subscription confirmation email valid in 48 hours and must confirm the subscription to receive messages published to the topic.
- - HTTP/HTTPS
Enter a public network URL, for example, http://example.com/notification/action. HTTP/HTTPS subscribers must confirm their subscriptions. For details about HTTP/HTTPS messages, see Introduction.
- - SMS
Enter a valid mobile number preceded by a plus sign (+) and a country code .Example: +4900000000
-Subscribers will receive a subscription confirmation message valid in 48 hours and must confirm the subscription to receive messages published to the topic.
- - DMS
Subscription endpoints are message queues. This type of subscriptions does not require confirmation. Click
-
to select subscription endpoints. When you select DMS queues, grant the ProduceMessages permission to SMN in the queue policy. For details, see section "Managing Queue Policies" in the Distributed Message Service User Guide.
- Email
- Click OK.
The subscription you added is displayed in the subscription list.
-
@@ -27,10 +69,3 @@- To prevent malicious users from attacking subscription endpoints, SMN limits the number of confirmation messages that can be sent to an endpoint within a specified period of time. For details, see Control over Subscription Confirmation Traffic.
- SMN does not check whether subscription endpoints exist when you add subscriptions. However, subscribers will not receive notification messages until they confirm their subscriptions.
- After you add a subscription, SMN sends a confirmation message to the subscription endpoint. The message contains a link for confirming the subscription. The subscription confirmation link is valid within 48 hours. Confirm the subscription on your mobile phone, mailbox, or other endpoints in time.
- To prevent malicious users from attacking subscription endpoints, SMN limits the number of confirmation messages that can be sent to an endpoint within a specified period. For details, see Traffic Control over Subscription Confirmation.
- SMN does not check whether subscription endpoints exist when you add subscriptions.
- After you add a subscription or request subscription confirmation, SMN will send a confirmation message to the endpoints, and the link in the confirmation message will be valid for 48 hours.
- Subscription confirmation messages will be counted as messages sent and will be billed.
- SMS: Enter one or more valid phone numbers.
-Prerequisites
Subscribers in the topic must have confirmed the subscription, or they will not be able to receive any messages.
To Publish a Text Message
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
-- In the topic list, locate the topic that you need to publish a message to and click Publish Message under Operation.
- Configure the required parameters based on Table 1.The topic name is provided by default and cannot be changed. -
Table 1 Parameter descriptions Parameter
+@@ -47,10 +47,3 @@ - - \ No newline at end of file diff --git a/docs/smn/umn/en-us_topic_0044170758.html b/docs/smn/umn/en-us_topic_0044170758.html index 1a032d073..26081b518 100644 --- a/docs/smn/umn/en-us_topic_0044170758.html +++ b/docs/smn/umn/en-us_topic_0044170758.html @@ -5,7 +5,8 @@Procedure
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
+ - In the topic list, locate the topic that you need to publish a message to and click Publish Message in the Operation column.
Alternatively, locate the topic and click its name. In the upper right corner of the displayed topic details page, click Publish Message.
+ - Configure the required parameters based on Table 1.The topic name is provided by default and cannot be changed. +-
Table 1 Parameters required for publishing a message Parameter
Description
+Description
Subject
+Subject
(Optional) The message subject must be less than 512 bytes.
+(Optional) Specifies the message subject, which must be fewer than 512 bytes.
Message Format
+Message Format
The message format can be Text, JSON, or Template. In this context, select Text.
-- Text: common text message
- JSON: JSON message
- Template: template message. For details, see Message Template Management
Specifies in which format a message is published. You can select only one message format each time you publish a message.
+- Text: common text message
- JSON: JSON message
- Template: template message. For details, see Message Template Management.
Message
+Message
This is the message content, which cannot be left blank nor exceed 256 KB.
+Specifies the message content. The message content cannot be left blank and its size cannot exceed 256 KB.
Figure 1 shows an example text message. +Figure 1 shows an example text message.-- Click OK.
SMN delivers your message to all subscription endpoints. For details about the messages received by each endpoint, see Messages of Different Protocols.
+- Click OK.
SMN delivers your message to all subscription endpoints. For details about the messages received by each endpoint, see Messages Using Different Protocols.
After you publish a message to a topic, SMN will deliver the message to all confirmed subscription endpoints in the topic.
For SMS endpoints, if an SMS message is oversized, the system divides it into multiple parts when sending it to subscribers. However, you must note that SMN only sends the first two parts of the SMS message and does not send any additional parts. You are charged based on the actual number of messages sent to the subscribers.
-You must ensure that firewall policies of the HTTP or HTTPS endpoints allow SMN to send messages over the Internet. An SMN HTTP or HTTPS message consists of a message header and body. For details, see HTTP/HTTPS Message Format.
+You must ensure that firewall policies of the HTTP or HTTPS endpoints allow SMN to send messages over the Internet. An SMN HTTP or HTTPS message consists of a message header and body. For details, see HTTP or HTTPS Message Format..
+If FunctionGraph (function) is used to receive messages, the message contains message attributes, subject, content, and topic URN. For details, see Messages Using Different Protocols.
diff --git a/docs/smn/umn/en-us_topic_0044170767.html b/docs/smn/umn/en-us_topic_0044170767.html index 5a4812239..41f6a1aa0 100644 --- a/docs/smn/umn/en-us_topic_0044170767.html +++ b/docs/smn/umn/en-us_topic_0044170767.html @@ -1,22 +1,45 @@Publishing a JSON Message
-- - \ No newline at end of file diff --git a/docs/smn/umn/en-us_topic_0044170770.html b/docs/smn/umn/en-us_topic_0044170770.html index bec5e4762..404a099ee 100644 --- a/docs/smn/umn/en-us_topic_0044170770.html +++ b/docs/smn/umn/en-us_topic_0044170770.html @@ -2,33 +2,31 @@Scenarios
In a JSON message, you can specify different message content for different protocols, including SMS, email, DMS, HTTP, and HTTPS.
+Scenarios
In a JSON message, you can specify different message content for different protocols, including SMS, email, FunctionGraph (function), HTTP, and HTTPS.
-Prerequisites
Subscribers in the topic must have confirmed the subscription, or they will not be able to receive any messages.
@@ -26,10 +49,3 @@To Publish a JSON Message
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
-- In the topic list, locate the topic that you need to publish a message to and click Publish Message under Operation.
- Configure the required parameters.
The topic name is provided by default and cannot be changed.
-Configure the required parameters based on Table 1.
-Select JSON for Message Format.
-Manually type the JSON message in the Message box or click Generate JSON Message to generate it automatically. The total size of a JSON message cannot exceed 256 KB.
-- If you choose to manually type the JSON message, see JSON Message Format for detailed requirements.
- If you choose to automatically generate the JSON message, proceed with steps 7 through 10.
- Click Generate JSON Message.
- Enter your message content, for example, This is a default message., in the Message box and select the desired message protocols.
The size of a JSON message varies depending on the protocol combinations. As you type in the message content, the system will calculate the number of bytes you have entered, the size of the JSON message, and how many bytes are left. The total size of a JSON message includes braces, quotation marks, spaces, line breaks, and message content. For details about how to calculate the size of a JSON message, see Calculation on the JSON Message Size in JSON Message Format.
-Figure 1 Generate JSON Message-
- Click OK. Figure 2 JSON message-
- Modify the message content for each protocol so that different messages are sent to endpoints of different protocols. The system generates JSON-formatted content that includes a default message and message for each protocol. When SMN fails to match any specific message protocol, it sends the default message. For detailed JSON message format, see JSON Message Format.
- Click OK.
SMN delivers your message to all subscription endpoints. For details about the messages received by each endpoint, see Messages of Different Protocols.
+Procedure
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
+ - In the topic list, locate the topic that you need to publish a message to and click Publish Message in the Operation column.
Alternatively, locate the topic and click its name. In the upper right corner of the displayed topic details page, click Publish Message.
+ - Configure parameters by referring to Table 1.
++
+Table 1 Parameters required for publishing a message Parameter
+Description
+Subject
+(Optional) Specifies the message subject, which must be fewer than 512 bytes.
+Message Format
+Specifies in which format a message is published. You can select only one message format each time you publish a message.
+- Text: common text message
- JSON: JSON message
- Template: template message. For details, see Message Template Management.
Message
+Specifies the message content. The message content cannot be left blank and its size cannot exceed 256 KB.
+Select JSON for Message Format. Then, manually type the JSON message in the Message box or click Generate JSON Message to generate it automatically.
+- If you choose to manually type the JSON message, see JSON Message Format.
- If you choose to automatically generate the JSON message, proceed with steps 7 through 10.
- Click Generate JSON Message.
- Enter your message content, for example, This is a default message., in the Message box and select the desired message protocols.
The size of a JSON message varies depending on the protocol combinations. As you type in the message content, the system will calculate the number of bytes you have entered, the size of the JSON message, and how many bytes are left. The total size of a JSON message includes braces, quotation marks, spaces, line breaks, and message content. For details, see Figure 1.For details about how to calculate the size of a JSON message, see Calculation on the Size of a JSON Message in JSON Message Format.
+ + - Click OK.Figure 2 JSON message+
- Modify the message content for each protocol so that different messages are sent to endpoints of different protocols. The system generates JSON-formatted content that includes a default message and content for each protocol. When SMN fails to match any specific message protocol, it sends the default message. For details, see JSON Message Format.
- Click OK.
SMN delivers your message to all subscription endpoints. For details about the messages received by each endpoint, see Messages Using Different Protocols.
Publishing a Template Message
Scenarios
Message templates contain fixed message content. If you need to send the same or similar messages multiple times, you can create a message template for quick message sending.
-You can create different templates for different protocols using the same template name so that each type of subscribers can receive customized messages. Templates contain variables as the placeholders to represent changeable content that you can replace with your own message content. Note that you must create a template whose Protocol is Default, or the system will not allow you to publish messages using this template name.
-When you are creating messages using a template, select a template name. The system will list all variables in the following protocol sequence: default, SMS, email, DMS, HTTP, and HTTPS. The same variables are listed only once even if they are used in multiple protocols, and the protocols they support are listed after each variable. Specify content for each variable in the message template, and SMN replaces them with the content you entered. If you do not enter any content for a variable, the system will treat it as empty when sending messages.
-SMN tries to match different types of subscribers to the template protocols. If there is no template for a specified protocol, SMN will use the default template to send messages to subscribers of that protocol.
+You can create different templates for different protocols using the same template name so that each type of subscribers can receive customized messages. Templates contain variables as the placeholders to represent changeable content that you can replace with your own message content. Note that you must create a template whose Protocol is Default, or the system will prevent you from publishing messages using this template name.
+When you are creating messages using a template, select a template name. The system will list all variables in the following protocol sequence: Default, SMS, Email, FunctionGraph (function), HTTP, and HTTPS. The same variables are listed only once even if they are used in multiple protocols, and the protocols they support are listed after each variable. Specify content for each variable in the message template, and SMN replaces them with the content you entered. If you do not enter any content for a variable, the system will treat it as empty when sending messages. SMN tries to match different types of subscribers to the template protocols. If there is no template for a specified protocol, SMN will use the default template to send messages to subscribers of that protocol.
This section describes how to publish messages using a template. For more details about message templates, see Message Template Management.
-Prerequisites
Subscribers in the topic must have confirmed the subscription, or they will not be able to receive any messages.
To Create a Message Template
- Log in to the management console.
- Click
on the upper left to select the desired region and project. - Under Application, select Simple Message Notification.
The SMN console is displayed.
- - -
- In the upper right corner, click Create Message Template. For details, see To Create a Message Template in Message Template Management.For example, the template information is as follows:
- Template Name: tem_001
- Protocol: Default
- Content: The Arts and Crafts Exposition will be held from {startdate} through {enddate}. We sincerely invite you to join us.Figure 1 Create Message Template-
-Creating a Message Template
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane on the left, choose Message Templates.
The Topics page is displayed.
+ - In the upper right corner, click Create Message Template. For details, see Creating a Message Template in Message Template Management.For example, the template information is as follows:+
- Template Name: tem_001
- Protocol: Default
- Content: The Arts and Crafts Exposition will be held from {startdate} through {enddate}. We sincerely invite you to join us.
- Click OK.Figure 1 Create Message Template
To Publish a Template Message
- Log in to the management console.
- Click
on the upper left to select the desired region and project. - Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
-- In the topic list, locate the topic that you need to publish a message to and click Publish Message under Operation.
- Configure the required parameters.
The topic name is provided by default and cannot be changed.
-Select Template for Message Format. Then, manually type the template content in the Message box or click Generate Template Message to generate it automatically. The template message content cannot exceed 256 KB.
+- - \ No newline at end of file diff --git a/docs/smn/umn/index.html b/docs/smn/umn/index.html deleted file mode 100644 index 0f173ac8e..000000000 --- a/docs/smn/umn/index.html +++ /dev/null @@ -1,12 +0,0 @@ - - -Publishing a Template Message
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
+ - In the topic list, locate the topic that you need to publish a message to and click Publish Message in the Operation column.
Alternatively, locate the topic and click its name. In the upper right corner of the displayed topic details page, click Publish Message.
+ - Configure the required parameters. (The topic name is provided by default and cannot be changed. Subject is optional.)
Select Template for Message Format. Then, manually type the template content in the Message box or click Generate Template Message to generate it automatically. The message content cannot be left blank and its size cannot exceed 256 KB.
- If you choose to manually type the template message, see Template Message Format for detailed requirements.
- If you choose to automatically generate the template message, proceed with 7 through 10.
- Click Generate Template Message.
- Select a template name, for example, tem_001, and enter values for the variables.The system replaces the variables with the message content you specified. The protocols configured in the template are displayed after each variable. Only the Default protocol is specified in tem_001, as shown in Figure 2. Therefore, all confirmed subscribers in the topic will receive the message content in the default template. +
- Click Generate Template Message.
- Select a template name, for example, tem_001. Enter values for the variables.
The system replaces the variables with the message content you specified. The protocols configured in the template are displayed after each variable. Only the Default protocol is specified in tem_001, as shown in Figure 2. Therefore, all confirmed subscribers in the topic will receive the message content in the default template.-- Click the Preview tab to preview the message.
In this example, the message generated is "The Arts and Crafts Exposition will be held from February 10 through February 21. We sincerely invite you to join us."@@ -38,10 +36,3 @@Figure 3 Previewing the template message+
- Click the Preview tab and click Message Preview to preview the message.
In this example, the message generated is The Arts and Crafts Exposition will be held from February 10 through February 21. We sincerely invite you to join us..-Figure 3 Previewing the template message- Click OK.
The message that is generated contains the template name and variables.Figure 4 Template message example+
- Click OK.
The message that is generated contains the template name and variables.-Figure 4 Template message example- Click OK.
SMN delivers your message to all subscription endpoints. For details about messages for different protocols, see Messages of Different Protocols.
+- Click OK.
SMN delivers your message to all subscription endpoints. For details about messages for different protocols, see Messages Using Different Protocols.
What Are the Advantages of SMN?
--SMN has the following advantages:
-- It does not require many development and maintenance resources, reducing your message notification costs.
- It is highly reliable and scalable.
- It can be quickly deployed and is easy to use.
-- diff --git a/docs/smn/umn/public_sys-resources/icon-arrowdn.gif b/docs/smn/umn/public_sys-resources/icon-arrowdn.gif index 84eec9be2..379428032 100644 Binary files a/docs/smn/umn/public_sys-resources/icon-arrowdn.gif and b/docs/smn/umn/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/smn/umn/public_sys-resources/icon-arrowrt.gif b/docs/smn/umn/public_sys-resources/icon-arrowrt.gif index 39583d168..6aaaa11c2 100644 Binary files a/docs/smn/umn/public_sys-resources/icon-arrowrt.gif and b/docs/smn/umn/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/smn/umn/public_sys-resources/imageclose.gif b/docs/smn/umn/public_sys-resources/imageclose.gif deleted file mode 100644 index 3a3344af4..000000000 Binary files a/docs/smn/umn/public_sys-resources/imageclose.gif and /dev/null differ diff --git a/docs/smn/umn/public_sys-resources/imageclosehover.gif b/docs/smn/umn/public_sys-resources/imageclosehover.gif deleted file mode 100644 index 8699d5e36..000000000 Binary files a/docs/smn/umn/public_sys-resources/imageclosehover.gif and /dev/null differ diff --git a/docs/smn/umn/public_sys-resources/imagemax.gif b/docs/smn/umn/public_sys-resources/imagemax.gif deleted file mode 100644 index 99c07dc25..000000000 Binary files a/docs/smn/umn/public_sys-resources/imagemax.gif and /dev/null differ diff --git a/docs/smn/umn/public_sys-resources/imagemaxhover.gif b/docs/smn/umn/public_sys-resources/imagemaxhover.gif deleted file mode 100644 index d01d77d6e..000000000 Binary files a/docs/smn/umn/public_sys-resources/imagemaxhover.gif and /dev/null differ diff --git a/docs/smn/umn/public_sys-resources/macFFBgHack.png b/docs/smn/umn/public_sys-resources/macFFBgHack.png deleted file mode 100644 index ec811470c..000000000 Binary files a/docs/smn/umn/public_sys-resources/macFFBgHack.png and /dev/null differ diff --git a/docs/smn/umn/smn_faq_0001.html b/docs/smn/umn/smn_faq_0001.html index 72d2a7206..672d40995 100644 --- a/docs/smn/umn/smn_faq_0001.html +++ b/docs/smn/umn/smn_faq_0001.html @@ -4,45 +4,23 @@--Parent topic: FAQs-diff --git a/docs/smn/umn/smn_faq_0003.html b/docs/smn/umn/smn_faq_0003.html index e3478b444..5e58a8f69 100644 --- a/docs/smn/umn/smn_faq_0003.html +++ b/docs/smn/umn/smn_faq_0003.html @@ -1,9 +1,9 @@ --
-
- What Are the Advantages of SMN?
-
- - Which Protocols Does SMN Support?
+ - What Protocols Does SMN Support?
- What Are the Requirements for an SMN Topic Name?
- - How Many Topics Can a User Create?
-
- - How Many Subscriptions Can Be Added to a Topic?
-
- - How Many Messages Can Be Published to a Topic?
-
- - How Many Message Templates Can a User Create?
-
- - What Are the Limitations on SMS Messages?
-
- - Does a Topic Support Subscriptions over Multiple Transmission Protocols?
-
- - Can a Topic Creator Change Subscription Protocols in a Topic?
-
- - Can I Change a Subscription Endpoint in a Topic?
-
- - Can I Delete a Published Message?
+ - What Are Most Frequently Asked Questions About Creating, Subscribing to, and Publishing a Topic in SMN?
- Does SMN Ensure That Messages Are Received by Subscription Endpoints?
- - Will a Subscriber Receive the Same Message Multiple Times?
- - Why Do Subscribers Fail to Receive Messages After I Publish Messages to a Topic?
- - What Are the Restrictions on SMS Messaging?
+ - What Are the Restrictions and Limitations on SMS Messaging?
- - What Can I Do When Images in an Email Message Cannot Be Displayed?
+ - What Can I Do When Pictures in an Email Message Cannot Be Displayed?
- Does SMN Always Use the Same Phone Number or Sender Name to Send SMS Messages?
- - How Do I Obtain a User's Domain ID?
-
- - Why Do I Fail to Publish Messages to a DMS Message Queue?
+ - How Do I Obtain My Account ID?
Which Protocols Does SMN Support?
-SMN supports the following protocols: email, SMS, DMS, HTTP, and HTTPS.
+What Protocols Does SMN Support?
+SMN supports the following protocols:
- Email: Messages are sent to subscribers' email addresses by email.
- SMS: Messages are sent to subscribers' phone numbers by SMS message.
- HTTP or HTTPS: Messages are sent to subscription URLs by HTTP or HTTPS request. SMN only supports public network URLs and public IP addresses.
- DMS: Messages are sent to queues.
- HTTP or HTTPS: Messages are sent to subscription URLs by HTTP or HTTPS request. SMN only supports public network URLs and public IP addresses.
- FunctionGraph (function): Messages are used as payload to call functions.
diff --git a/docs/smn/umn/smn_faq_0006.html b/docs/smn/umn/smn_faq_0006.html index 84ef3ceec..de70ff265 100644 --- a/docs/smn/umn/smn_faq_0006.html +++ b/docs/smn/umn/smn_faq_0006.html @@ -1,7 +1,24 @@ -How Many Topics Can a User Create?
-By default, one user can create 3,000 topics.
+What Are Most Frequently Asked Questions About Creating, Subscribing to, and Publishing a Topic in SMN?
++How Many Topics Can I Create?
By default, you can create 3,000 topics.
++How Many Subscriptions Can Be Added to a Topic?
By default, 10,000 subscriptions can be added to a topic.
++How Many Messages Can Be Published to a Topic?
There is no limit on the number of messages that can be published to a topic.
++How Many Message Templates Can I Create?
By default, you can create 100 message templates.
++Can I Add Subscriptions Using Multiple Protocols to a Topic?
Yes. A topic supports HTTP, HTTPS, FunctionGraph (function), email, and SMS subscriptions.
++Can a Topic Creator Change Subscription Protocols in a Topic?
No. A topic creator cannot change subscription protocols after subscriptions are added to the topic.
++Can I Change a Subscription Endpoint for a Topic?
No. You cannot change a subscription endpoint once it is added to a topic. If needed, you can delete the endpoint and add a new one.
++Can I Delete a Published Message?
No. You cannot delete a message once it is published.
+Will a Subscriber Receive the Same Message Multiple Times?
A subscriber will only receive a message once. SMN re-sends a message only when there is a network or device failure.
+diff --git a/docs/smn/umn/smn_faq_0007.html b/docs/smn/umn/smn_faq_0007.html deleted file mode 100644 index 37d178281..000000000 --- a/docs/smn/umn/smn_faq_0007.html +++ /dev/null @@ -1,11 +0,0 @@ - - -How Many Subscriptions Can Be Added to a Topic?
--By default, 10,000 subscriptions can be added to a topic.
--- diff --git a/docs/smn/umn/smn_faq_0008.html b/docs/smn/umn/smn_faq_0008.html deleted file mode 100644 index a387ed321..000000000 --- a/docs/smn/umn/smn_faq_0008.html +++ /dev/null @@ -1,11 +0,0 @@ - - ---Parent topic: FAQs-How Many Messages Can Be Published to a Topic?
--There is no limit on the number of messages that can be published to a topic.
--- diff --git a/docs/smn/umn/smn_faq_0009.html b/docs/smn/umn/smn_faq_0009.html deleted file mode 100644 index bb7934f38..000000000 --- a/docs/smn/umn/smn_faq_0009.html +++ /dev/null @@ -1,13 +0,0 @@ - - ---Parent topic: FAQs-What Are the Limitations on SMS Messages?
--If the content of an SMS message consists of only ASCII characters, it will be encoded using GSM. In this case, each SMS message can contain up to 254 characters.
-If the content includes non-ASCII characters, it will be encoded using UCS-2, and each SMS message can contain up to 127 characters.
-If an SMS message is oversized, SMN will split it into multiple parts but only send the first two parts to subscribers.
--- diff --git a/docs/smn/umn/smn_faq_0010.html b/docs/smn/umn/smn_faq_0010.html deleted file mode 100644 index 62194545b..000000000 --- a/docs/smn/umn/smn_faq_0010.html +++ /dev/null @@ -1,11 +0,0 @@ - - ---Parent topic: FAQs-Does a Topic Support Subscriptions over Multiple Transmission Protocols?
--Yes. A topic supports HTTP, HTTPS, email, DMS, and SMS subscriptions.
--- diff --git a/docs/smn/umn/smn_faq_0011.html b/docs/smn/umn/smn_faq_0011.html deleted file mode 100644 index 6c6deaadd..000000000 --- a/docs/smn/umn/smn_faq_0011.html +++ /dev/null @@ -1,11 +0,0 @@ - - ---Parent topic: FAQs-Can a Topic Creator Change Subscription Protocols in a Topic?
--No. A topic creator cannot change subscription protocols after subscriptions are added to the topic.
--- diff --git a/docs/smn/umn/smn_faq_0012.html b/docs/smn/umn/smn_faq_0012.html deleted file mode 100644 index d2a273f58..000000000 --- a/docs/smn/umn/smn_faq_0012.html +++ /dev/null @@ -1,11 +0,0 @@ - - ---Parent topic: FAQs-Can I Change a Subscription Endpoint in a Topic?
--No. You cannot change a subscription endpoint once it is added to a topic. If necessary, you can delete the endpoint and add a new one.
--- diff --git a/docs/smn/umn/smn_faq_0013.html b/docs/smn/umn/smn_faq_0013.html deleted file mode 100644 index ebd1dd955..000000000 --- a/docs/smn/umn/smn_faq_0013.html +++ /dev/null @@ -1,11 +0,0 @@ - - ---Parent topic: FAQs-Can I Delete a Published Message?
--No. A message cannot be deleted once it is published.
--- diff --git a/docs/smn/umn/smn_faq_0014.html b/docs/smn/umn/smn_faq_0014.html index 94cae87ce..93e70ebbd 100644 --- a/docs/smn/umn/smn_faq_0014.html +++ b/docs/smn/umn/smn_faq_0014.html @@ -1,9 +1,10 @@--Parent topic: FAQs-Does SMN Ensure That Messages Are Received by Subscription Endpoints?
-If a subscription endpoint is reachable, it will receive all messages delivered by SMN.
-If an endpoint is unreachable, SMN saves the undelivered message in a message queue and tries to deliver it six more times. If the message still fails to be delivered, SMN discards it and does not inform the publisher that the message delivery has failed.
-The interval for re-sending an undelivered message varies depending on the length of the message queue. Usually, an undelivered message is processed within several hours. If a queue has too many undelivered messages, those messages will be processed within a day.
+SMN pushes messages to subscription endpoints asynchronously, which does not ensure the timeliness of message delivery. If your service requires quasi-real-time message delivery, exercise caution whether to use SMN.
+If a subscription endpoint is accessible, it will receive all messages delivered by SMN.
+If an endpoint is inaccessible, SMN saves the undelivered message in a message queue and tries to deliver it six more times. If the message still fails to be delivered, SMN discards it and does not send the information to the publisher that the message delivery failed.
+The interval for re-sending an undelivered message varies depending on the length of the message queue.
diff --git a/docs/smn/umn/smn_faq_0015.html b/docs/smn/umn/smn_faq_0015.html deleted file mode 100644 index 43ea9aa45..000000000 --- a/docs/smn/umn/smn_faq_0015.html +++ /dev/null @@ -1,11 +0,0 @@ - - -Will a Subscriber Receive the Same Message Multiple Times?
--A subscriber will only receive a message once. SMN re-sends a message only when there is a network or device failure.
--- diff --git a/docs/smn/umn/smn_faq_0016.html b/docs/smn/umn/smn_faq_0016.html index c1210c90c..8291d5885 100644 --- a/docs/smn/umn/smn_faq_0016.html +++ b/docs/smn/umn/smn_faq_0016.html @@ -1,12 +1,9 @@--Parent topic: FAQs-Why Do Subscribers Fail to Receive Messages After I Publish Messages to a Topic?
-If you have verified that the subscription endpoints are normal, the most possible reason is that the subscribers have not confirmed their subscriptions or the message has been blocked.
+If you have verified that the subscription endpoints are normal, the most possible reason is that the subscribers have not confirmed their subscriptions or the confirmation messages and messages published have been blocked.
Check whether the message is blocked and processed as a junk message.
If the problem persists, contact technical support.
-SMS Message
- If the subscribers fail to receive the confirmation message, check whether the message has been blocked.
- If the subscribers fail to receive the notification message, check whether they have confirmed the subscription or whether the message has been blocked.
If the problem persists, contact technical support.
-diff --git a/docs/smn/umn/smn_faq_0017.html b/docs/smn/umn/smn_faq_0017.html index 19adc40a4..7ab5e68b0 100644 --- a/docs/smn/umn/smn_faq_0017.html +++ b/docs/smn/umn/smn_faq_0017.html @@ -1,8 +1,32 @@ -What Are the Restrictions on SMS Messaging?
+What Are the Restrictions and Limitations on SMS Messaging?
You can send at most 60 SMS messages to a single phone number within one hour and 200 within 12 hours.
This limit is applicable only to SMS messaging. There is no limit on the number of messages you can publish to a topic.
+If an SMS message contains more than 1,000 characters, the SMS message cannot be sent to the SMS endpoint.
+The following table describes the rules for calculating the number of characters in an SMS message.
+ +
+Character Counting Rule
+Remarks
+SMSs in English:
+ +- If an SMS contains 158 English characters, it is counted as one SMS. If an SMS contains 164 (153 + 11) characters, it is counted as two SMSs. If an SMS contains 320 (153 + 153 + 14) characters, it is counted as three SMSs.
- For example, if an SMS template contains variable ${NUM_8} set to 123456, that variable is counted as six characters.
SMSs in other languages:
+ +diff --git a/docs/smn/umn/smn_faq_0018.html b/docs/smn/umn/smn_faq_0018.html deleted file mode 100644 index 4ceb0f696..000000000 --- a/docs/smn/umn/smn_faq_0018.html +++ /dev/null @@ -1,11 +0,0 @@ - - -How Many Message Templates Can a User Create?
--By default, one user can create 100 message templates.
--- diff --git a/docs/smn/umn/smn_faq_0019.html b/docs/smn/umn/smn_faq_0019.html index d1bde0dff..1688b344d 100644 --- a/docs/smn/umn/smn_faq_0019.html +++ b/docs/smn/umn/smn_faq_0019.html @@ -1,7 +1,15 @@ ---Parent topic: FAQs-What Can I Do When Images in an Email Message Cannot Be Displayed?
-To protect users' privacy, some email clients do not automatically download images from the Internet. If images in an email cannot be displayed, you need to enable automatic image download.
+What Can I Do When Pictures in an Email Message Cannot Be Displayed?
+To protect your privacy, some mailboxes do not automatically download pictures from the Internet by default. If pictures in an email cannot be displayed, you need to enable automatic picture download.
+The following uses Outlook 2019 as an example to describe how to enable automatic picture download. Procedures are as follows:
+- Open Outlook and click File in the upper left corner.
- Click Options.
The Options page is displayed.
+ - Click Trust Center and Settings.
The Trust Center page is displayed.
+
+
- On the Automatic Download tab, deselect Don't download pictures automatically in standard HTML email messages or RSS items and click OK.
+
For other types of mailboxes, search for How Do I Enable Automatic Picture Download through your browser.
+diff --git a/docs/smn/umn/smn_faq_0021.html b/docs/smn/umn/smn_faq_0021.html index 97cbe57ec..89b7c1509 100644 --- a/docs/smn/umn/smn_faq_0021.html +++ b/docs/smn/umn/smn_faq_0021.html @@ -1,8 +1,8 @@ -How Do I Obtain a User's Domain ID?
+How Do I Obtain My Account ID?
-- Log in to the management console.
- Point to the username on the upper right and click My Credentials.
- Obtain the user's domain ID.
- Log in to the management console.
- Point to the username on the upper right and click My Credentials.
- Obtain the user's account ID.
diff --git a/docs/smn/umn/smn_faq_0022.html b/docs/smn/umn/smn_faq_0022.html deleted file mode 100644 index 8948541ce..000000000 --- a/docs/smn/umn/smn_faq_0022.html +++ /dev/null @@ -1,16 +0,0 @@ - - -Why Do I Fail to Publish Messages to a DMS Message Queue?
--Check whether required permissions of the DMS message queue are granted to SMN.
-- If no, perform the following operations to grant permissions.
- If yes, but you still cannot push messages, the failure may be caused by unstable network connection or other reasons. Contact customer service to address the issue.
- Log in to the management console.
- Click
on the upper left to select the desired region and project. - Under Application, select Simple Message Notification.
The SMN console is displayed.
- - In the queue list, locate the required queue and click its name. -
- On the Policy Management tab, click Create Queue Policy.
Set Permission to Allow, Policy Type to Service-based, and Service to SMN. Specify the action as needed.
- - Click OK.
-- diff --git a/docs/smn/umn/smn_pd_20000.html b/docs/smn/umn/smn_pd_20000.html index d278c43db..bfb0bb4c0 100644 --- a/docs/smn/umn/smn_pd_20000.html +++ b/docs/smn/umn/smn_pd_20000.html @@ -12,6 +12,8 @@--Parent topic: FAQs-- Accessing and Using SMN
+
- Permissions
+- SMN and Other Services
- Concepts
diff --git a/docs/smn/umn/smn_pd_22000.html b/docs/smn/umn/smn_pd_22000.html index 6fe5793e7..6f8ec7774 100644 --- a/docs/smn/umn/smn_pd_22000.html +++ b/docs/smn/umn/smn_pd_22000.html @@ -1,8 +1,8 @@Application Scenarios
-- System notifications
After events or alarms are triggered, SMN can send notifications to specified users by email, SMS message, or HTTP/HTTPS message. For example, Cloud Trace Service (CTS) detects key cloud service operations and uses SMN to notify you and other users.
- - Integrating with cloud services
SMN can function as a message middleware to connect cloud services, reducing system complexity and improving efficiency. For example, Cloud Eye does not have to be integrated with Object Storage Service (OBS) to interact with each other. Instead, they are connected by SMN. Therefore, faults in one service will not affect the other.
+diff --git a/docs/smn/umn/smn_pd_23000.html b/docs/smn/umn/smn_pd_23000.html index e51bd8837..49bbc7d32 100644 --- a/docs/smn/umn/smn_pd_23000.html +++ b/docs/smn/umn/smn_pd_23000.html @@ -13,9 +13,9 @@- System notifications
After events or alarms are triggered, SMN can send notifications to specified users by email, SMS message, FunctionGraph (function), or HTTP/HTTPS message. For example, Cloud Trace Service (CTS) detects key cloud service operations and uses SMN to notify you and other users.
+ - Integrating with cloud services
SMN can function as a message middleware to directly connect cloud services, improving service efficiency. For example, Cloud Eye does not have to be integrated with Object Storage Service (OBS) to interact with each other. Instead, they can be connected by SMN, so faults in one service will not affect the other.
- Off-peak traffic control
If there is a discrepancy between processing capabilities of the upstream and downstream systems, SMN can cache data to reduce downstream pressure to reduce breakdowns, enhance availability, and mitigate complexity in the system.
- System notifications
Simplicity
SMN provides three basic APIs to create topics, add subscriptions, and publish messages and can be quickly integrated with your services. It enables you to send messages in substantial quantity and do not require highly skilled development.
+SMN provides three basic APIs to create topics, add subscriptions, and publish messages. SMN can be quickly integrated with your services. It enables you to send messages in substantial quantity and do not require highly skilled development.
A self-developed messaging system is expensive and takes long time to be integrated with your services. Its APIs are complicated and hard to use.
+A self-developed messaging system is expensive and takes long time to be integrated with your services. Its APIs are complex and hard to use.
Stability and reliability
@@ -25,16 +25,16 @@A traditional messaging system cannot achieve the stability and reliability required by critical services and does not provide measures to ensure service continuity.
Multiple messaging types
+Multiple message types
You publish a message once, and SMN delivers it to endpoints in various message types.
You need to develop separate messaging systems in multiple types to send SMS message, email, HTTP, or HTTPS notifications.
+You need to develop separate messaging systems in multiple types to send SMS message, FunctionGraph (function), email, HTTP, or HTTPS notifications.
Security
SMN isolates data based on topics and does not allow any unauthorized users to access message queues, thereby protecting your service data.
+SMN isolates data based on topics and prevents any unauthorized users from accessing message queues, thereby protecting your service data.
Service data is potentially exposed to unauthorized access due to lack of effective protection mechanisms.
SMN and Other Services
SMN can be interconnected with other cloud services to provide them with messaging capabilities so that these services can send notifications to tenants or their message processing systems. For details about how to use SMN in other cloud services, see user guides of the related services.
-- Cloud Eye
After an alarm rule is configured, Cloud Eye can use SMN to send alarm information to specified users.
- - Anti-DDoS
Anti-DDoS uses SMN to notify users by email or SMS message once a DDoS attack occurs.
- - Cloud Trace Service (CTS)
CTS can be integrated with SMN to notify users of critical operation events. SMN also uses CTS to record service resource operations.
- - Object Storage Service (OBS)
OBS uses SMN to send OBS bucket events to applications for processing.
- - Distributed Message Service (DMS)
Cloud service events or application messages in SMN can be saved in DMS message queues.
+The following are examples of some services using SMN.
+- Cloud Eye
After an alarm rule is configured, Cloud Eye can use SMN to send alarm notifications to specific users.
+ - Anti-DDoS
Anti-DDoS uses SMN to notify users by email or SMS message once a DDoS attack occurs.
+ - CTS
CTS can be integrated with SMN to notify users of key events. SMN also uses CTS to record service resource operations.
+ - OBS
OBS uses SMN to send OBS bucket events to applications for processing.
- Cloud Eye
diff --git a/docs/smn/umn/smn_pd_25000.html b/docs/smn/umn/smn_pd_25000.html index ecff3c7c6..e987442d4 100644 --- a/docs/smn/umn/smn_pd_25000.html +++ b/docs/smn/umn/smn_pd_25000.html @@ -1,9 +1,9 @@Accessing and Using SMN
-The cloud platform provides a web-based management console and HTTPS-based APIs through which you can access the SMN service.
-- Management console
The management console is a web user interface for you to manage your computing, storage, and other cloud resources. You can log in the management console and select Simple Message Notification on the homepage to switch to the SMN console.
- - API calling
If you want to integrate SMN into a third-party system for secondary development, you can access SMN using APIs. For details, see Simple Message Notification API Reference.
+You can access the SMN service using a web-based management console and HTTPS-based APIs.
+- Management console
The management console is a web user interface for you to manage your computing, storage, and other cloud resources. You can log in the management console and select Simple Message Notification on the homepage to switch to the SMN console.
+ - APIs
If you want to integrate SMN into a third-party system for secondary development, you can access SMN using APIs. For details, see Simple Message Notification API Reference.
diff --git a/docs/smn/umn/smn_pd_28000.html b/docs/smn/umn/smn_pd_28000.html index 7011d6fb6..60a008bf9 100644 --- a/docs/smn/umn/smn_pd_28000.html +++ b/docs/smn/umn/smn_pd_28000.html @@ -3,25 +3,25 @@Concepts
-Project
Projects are used to group and isolate OpenStack resources, including compute, storage, and network resources. A project can be either a department or a project team. Multiple projects can be created in one account.
Protocol
A protocol is a message type. SMN supports the following protocols: SMS, DMS, Email, HTTP, and HTTPS.
+-Protocol
A protocol is a message type. SMN supports the following protocols: SMS, FunctionGraph (function), Email, HTTP, and HTTPS.
Publisher
A publisher sends messages to a topic.
+-Publisher
A publisher publishes messages to a topic.
Subscriber
A subscriber receives messages delivered from a topic.
+Subscriber
A subscriber receives messages published to a topic.
When adding a subscription, you can choose protocols as required:
-- For the Email protocol, the endpoint can be one or more email addresses.
- For the SMS protocol, the endpoint can be one or more phone numbers.
- For the HTTP or HTTPS protocol, the endpoint can be one or more URLs.
- For the DMS protocol, the endpoint can be one or more message queues.
- Email: The endpoint can be one or more email addresses.
- SMS: The endpoint can be one or more phone numbers.
- HTTP or HTTPS: The endpoint can be one or more URLs.
- FunctionGraph (function): The endpoint can be one function.
Topic
A topic is a specified event to publish messages and subscribe to notifications. It can be used to isolate messages. A topic serves as a message sending channel, where publishers and subscribers can interact with each other.
URN
Uniform Resource Names (URNs) are used to identify SMN resources.
-- Topic URN
After a topic is created, SMN generates a topic URN composed of the service name, region name, project ID, and topic name to uniquely identify the topic, for example, urn:smn:region:cffe4fc4c9a54219b60dbaf7b586e132:Mytopic. When you call an API to create a topic, a topic URN will be returned. The URN will be used whenever a publisher or subscriber performs operations relating to the topic.
- - Subscription URN
After a user subscribes to a topic, SMN will generate a URN for the subscription composed of the service name, region name, project ID, and topic name, for example, urn:smn:region:cffe4fc4c9a54219b60dbaf7b586e132:Mytopic:5293b436967f450abc51e0c36347b27a. The URN is displayed on the Subscriptions page for subscribers to confirm and cancel a subscription.
+- Topic URN
After a topic is created, SMN generates a topic URN composed of the service name, region name, project ID, and topic name to uniquely identify the topic, for example, urn:smn:region:cffe4fc4c9a54219b60dbaf7b586e132:Mytopic. When you call an API to create a topic, a topic URN will be returned. The topic URN will be used whenever a publisher or subscriber performs operations relating to the topic.
+ - Subscription URN
After a user subscribes to a topic, SMN will generate a subscription URN composed of the service name, region name, project ID, topic name, and subscription ID, for example, urn:smn:region:cffe4fc4c9a54219b60dbaf7b586e132:Mytopic:5293b436967f450abc51e0c36347b27a. The URN is displayed on the Subscriptions page for subscribers to confirm or cancel a subscription.
- Topic URN
Message Template
Message templates contain fixed and changeable content and can be used to send messages quickly. Changeable content is represented with variables. When you publish template messages, the system replaces the variables with the message content you specify.
Template Variable
A message template contains fixed and changeable content. Changeable content is represented with variables. You can specify values for variables when publishing messages using a template.
-For example, the template content is The Arts and Crafts Exposition will be held from {startdate} through {enddate}. We sincerely invite you to join us. In the content, {startdate} and {enddate} are variables.
+For example, the template content is The Arts and Crafts Exposition will be held from {startdate} through {enddate}. We sincerely invite you to join us.. In the content, {startdate} and {enddate} are variables.
diff --git a/docs/smn/umn/smn_qs_30000.html b/docs/smn/umn/smn_qs_30000.html deleted file mode 100644 index 3c1c435eb..000000000 --- a/docs/smn/umn/smn_qs_30000.html +++ /dev/null @@ -1,11 +0,0 @@ - - -Getting Started
- --- diff --git a/docs/smn/umn/smn_qs_30010.html b/docs/smn/umn/smn_qs_30010.html new file mode 100644 index 000000000..21d72e622 --- /dev/null +++ b/docs/smn/umn/smn_qs_30010.html @@ -0,0 +1,171 @@ + + +-
-
- Publishing a Message
-
-
Getting Started
++ diff --git a/docs/smn/umn/smn_ug_0004.html b/docs/smn/umn/smn_ug_0004.html deleted file mode 100644 index eccb0e780..000000000 --- a/docs/smn/umn/smn_ug_0004.html +++ /dev/null @@ -1,175 +0,0 @@ - - -After you learn the basic concepts in SMN, you can start to create a topic, add subscriptions to the topic, and publish messages on the SMN console or by calling RESTful APIs provided by SMN.
+Figure 1 shows the process to publish a message to a topic. +++Scenarios
To send similar messages repeatedly, create a message template which contains fixed and changeable content. Every time you send messages using the template, you only have to replace changeable content. For example, your organization holds expositions regularly and needs to notify relevant people of the time, you can create a message template containing date variables and other fixed content.
++Step 1. Create a Topic
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
+ - In the upper right corner, click Create Topic.Figure 2 Create Topic+
- Enter a topic name and display name.
++
+Table 1 Parameter descriptions Parameter
+Description
+Topic Name
+Topic name, which:
+- Contains only letters, digits, hyphens (-), and underscores (_) and must start with a letter or digit.
- Contains 1 to 255 characters.
- Must be unique and cannot be modified once the topic is created.
Display Name
+Message sender name, which can contain up to 192 bytes
+NOTE:+After you specify a display name, the sender in email messages will be presented as Display name<noreply@otc.t-systems.com>. Otherwise, the sender will be noreply@otc.t-systems.com.
+Tag
+A tag is a key-value pair. Tags identify cloud resources so that you can easily categorize and search for your resources.
+- A key can contain up to 36 characters. A value can contain up to 43 characters. Both Key and Value can contain only digits, letters, hyphens (-), at signs (@), and underscores (_).
- You can add up to 20 tags for each topic.
- Click OK.
The topic you created is displayed in the topic list. The system generates a topic URN, which is the unique resource identifier of the topic and cannot be changed.
+To search for a topic, filter topics by project or enter the topic name in the upper right corner of the topic list. Then click
+ or press Enter. Alternatively, click Search by Tag above the upper right corner of the topic list and search for a topic by tag key and value. - Click the name of the topic to view its details, including the topic URN, display name, tags, and subscriptions.
+Step 2. Add a Subscription
- Log in to the management console.
- In the upper left corner of the page, click
and select the desired region and project. - Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane on the left, choose Subscriptions.
- In the upper right corner, click Add Subscription.
The Add Subscription dialog box is displayed.
+Figure 3 Add Subscription+
- Specify the required subscription information.
- Beside Topic Name, click Select Topic.
- Specify the subscription protocol and endpoints.
++
+Table 2 Parameters for adding a subscription Parameter
+Description
+Topic Name
+Specifies the name of the topic to which messages are published.
+Protocol
+Specifies the protocol over which messages are sent. Possible values are SMS, HTTP, HTTPS, FunctionGraph (function), and Email.
+Endpoint
+Specifies the subscription endpoint. You can add up to 10 SMS, email, HTTP, or HTTPS endpoints, one in each line.
+- SMS: Enter one or more valid phone numbers.
A phone number must be preceded by a plus sign (+) and a country code.
+Examples:
++4900000000
++4900000001
++4900000002
++4900000003
+ - Email: Enter one or more valid email addresses.
Examples:
+username@example.com
+username2@example.com
+ - HTTP: Enter one or more public network URLs.
Example:
+http://example.com/notification/action
+ - HTTPS: Enter one or more public network URLs.
Example:
+https://example.com/notification/action
+ - FunctionGraph (function): Click to select a function and specify its version.
Version
+This parameter is only available if FunctionGraph (function) is selected for Protocol. Select the version for the function.
+Description
+Specifies the remarks of the subscription.
+ - SMS: Enter one or more valid phone numbers.
- Click OK.
The subscription you added is displayed in the subscription list.
+To search for a subscription, you can filter subscriptions by protocol or subscription status in the upper right corner of the subscription list. You can also enter a subscription endpoint and click
+
or press Enter.+ - To prevent malicious users from attacking subscription endpoints, SMN limits the number of confirmation messages that can be sent to an endpoint within a specified period. For details, see Traffic Control over Subscription Confirmation.
- SMN does not check whether subscription endpoints exist when you add subscriptions.
- After you add a subscription or request subscription confirmation, SMN will send a confirmation message to the endpoints, and the link in the confirmation message will be valid for 48 hours.
- Subscription confirmation messages will be counted as messages sent and will be billed.
+Step 3. Create a Message Template
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane on the left, choose Message Templates.
- In the upper right corner, click Create Message Template.
The Create Message Template dialog box is displayed.
+Figure 4 Create Message Template+ - Specify the template name, protocol, and content.
++
+Table 3 Parameters required for creating a message template Parameter
+Description
+Template Name
+Template name, which:
+- Contains only letters, digits, hyphens (-), and underscores (_) and must start with a letter or digit.
- Can contain 1 to 64 characters.
- Cannot be modified once the template is created.
Protocol
+Endpoint protocol of the template, which cannot be changed once the template is created
+The protocol can be Default, SMS, HTTP, HTTPS, Email, or FunctionGraph (function).
+If you do not specify a protocol, Default is used.
+Content
+Template content
+Use {xxx} as the placeholder to create a template. When you use this template to publish messages, replace {xxx} with specific content. xxx must start with a letter or digit and can contain up to 21 characters, including only letters, digits, hyphens (-), periods (.), and underscores (_).
+The message template must meet the following requirements:
+- The template supports plain text only.
- The template content cannot be left blank and its size cannot exceed 256 KB.
- The template can contain up to 256 variables in total, but that includes redundant variables. For unique variables, there can be no more than 90.
- When you publish messages using a template, the message content you specify for each variable cannot exceed 1 KB.
For example, the template information is as follows:+- Template Name: tem_001
- Protocol: Default
- Content: The Arts and Crafts Exposition will be held from {startdate} through {enddate}. We sincerely invite you to join us.
- Click OK.
The template you created is displayed in the template list.
+To search for a template, enter the template name in the upper right corner of the message template list and click
+ or press Enter.
+Step 4. Publish a Template Message
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
+ - In the topic list, locate the topic that you need to publish a message to and click Publish Message in the Operation column.
Alternatively, locate the topic and click its name. In the upper right corner of the displayed topic details page, click Publish Message.
+ - Configure the required parameters. (The topic name is provided by default and cannot be changed. Subject is optional.)
Select Template for Message Format. Then, manually type the template content in the Message box or click Generate Template Message to generate it automatically. The message content cannot be left blank and its size cannot exceed 256 KB.
+- If you choose to manually type the template message, see Template Message Format for detailed requirements.
- If you choose to automatically generate the template message, proceed with 7 through 10.
- Click Generate Template Message.
- Select a template name, for example, tem_001. Enter values for the variables.The system replaces the variables with the message content you specified. The protocols configured in the template are displayed after each variable. Only the Default protocol is specified in tem_001, as shown in Figure 5. Therefore, all confirmed subscribers in the topic will receive the message content in the default template. ++
- Click the Preview tab and click Message Preview to preview the message.In this example, the message generated is The Arts and Crafts Exposition will be held from February 10 through February 21. We sincerely invite you to join us..+Figure 6 Previewing the template message+
- Click OK.The message that is generated contains the template name and variables.+Figure 7 Template message example+
- Click OK.
SMN delivers your message to all subscription endpoints. For details about messages for different protocols, see Messages Using Different Protocols.
+
+Step 5. Receive the Message
Subscription endpoints of different protocols receive different messages.+ +- Email
Subscription endpoints are email addresses.
+Email messages contain the message subject, content, and a link to unsubscribe.
+Figure 8 Email message+
- HTTP/HTTPS
Subscription endpoints are public network URLs. For details, see HTTP/HTTPS Messages.
+ - SMS
Subscription endpoints are phone numbers.
+SMS messages contain only the message content.
+ - FunctionGraph (function)
Subscription endpoints are functions. To view messages received, see Using an SMN Trigger in FunctionGraph User Guide.
+
Publishing a Message
--After you learn the basic concepts in SMN, you can start to create a topic, add subscriptions to the topic, and publish messages on the SMN console or by calling RESTful APIs provided by SMN.
-Figure 1 shows the process to publish a message to a topic.
- --Scenarios
To send similar messages repeatedly, create a message template which contains fixed and changeable content. Every time you send messages using the template, you only have to replace changeable content. For example, your organization holds expositions regularly and needs to notify relevant people of the dates, you can create a message template containing date variables and other fixed content.
--Step 1. Create a Topic
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
-- In the upper right corner, click Create Topic.Figure 2 Create Topic-
- Enter a topic name and display name.
--
-Table 1 Parameter descriptions Parameter
-Description
-Topic Name
-Topic name, which:
-- Contains only letters, digits, hyphens (-), and underscores (_), and must start with a letter or digit.
- Contain 1 to 255 characters.
- Must be unique and cannot be modified once the topic is created.
Display Name
-Message sender name, which must be fewer than 192 characters.
-NOTE:-After you specify a display name, the sender in email messages will be presented as Display name<username@example.com>. Otherwise, the sender will be username@example.com.
-Tag
-A tag is a key-value pair. Tags identify cloud resources so that you can easily categorize and search for your resources.
-- A key can contain up to 36 characters. A value can contain up to 43 characters. Both Key and Value can contain only digits, letters, hyphens (-), at signs (@), and underscores (_).
- You can add up to 10 tags for each topic.
- Click OK.
The topic you created is displayed in the topic list. The system generates a topic URN, which is the unique resource identifier of the topic and cannot be changed.
- - Click the name of the topic to view its details, including the URN, display name, and subscriptions.
-Step 2. Add a Subscription
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- - -
- In the upper right corner, click Add Subscription.
The Add Subscription dialog box is displayed.
-Figure 3 Add Subscription- - Specify the required subscription information.
- Click beside the Topic Name box to select a topic.
- Specify the subscription protocol and endpoints.
--
-Table 2 Parameter descriptions Parameter
-Description
-Topic Name
-Name of the topic to be subscribed to
-Protocol
-Protocol that the subscription endpoints support. The available protocols are SMS, Email, HTTP, and HTTPS.
-Endpoint
-Subscription endpoint. You can enter up to 10 SMS, email, HTTP, or HTTPS endpoints, one in each line.
-- SMS: Enter one or more valid phone numbers.
The phone number is preceded by a plus sign (+) and a country code.
-Example:
-+4900000000
-+4900000001
-+4900000002
-+4900000003
- - Email: Enter one or more valid email addresses.
Example:
-username@example.com
-username2@example.com
- - HTTP: Enter one or more public network URLs.
Example:
-http://example.com/notification/action
- - HTTPS: Enter one or more public network URLs.
Example:
-https://example.com/notification/action
- - DMS: Click to select a message queue. Ensure that the queue policy grants the ProduceMessages permission to SMN. For details, see section "Managing Queue Policies" in the Distributed Message Service User Guide.
- SMS: Enter one or more valid phone numbers.
- Click
- Click OK.
The subscription you added is displayed in the subscription list.
-- - To prevent malicious users from attacking subscription endpoints, SMN limits the number of confirmation messages that can be sent to an endpoint within a specified period of time. For details, see Control over Subscription Confirmation Traffic.
- SMN does not check whether subscription endpoints exist when you add subscriptions. However, subscribers will not receive notification messages until they confirm their subscriptions.
- After you add a subscription, SMN sends a confirmation message to the subscription endpoint. The message contains a link for confirming the subscription. The subscription confirmation link is valid within 48 hours. Confirm the subscription on your mobile phone, mailbox, or other endpoints in time.
-Step 3. Create a Message Template
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- - In the navigation pane, choose Message Templates.
- In the upper right corner, click Create Message Template.
The Create Message Template dialog box is displayed.
-Figure 4 Create Message Template- - Specify the template name, protocol, and content.
--
-Table 3 Parameters required for creating a message template Parameter
-Description
-Template Name
-Template name, which:
-- Contains only letters, digits, hyphens (-), and underscores (_), and must start with a letter or digit.
- Can contain 1 to 64 bytes.
- Cannot be modified once the template is created.
Protocol
-Endpoint protocol of the template, which cannot be changed once the template is created
-The protocol can be Default, SMS, HTTP, HTTPS, DMS, or Email.
-If you do not specify a protocol, Default is used.
-Content
-Template content
-You can use variables as placeholders. Before you send messages using the template, SMN replaces the variables with the message content you specify. A variable can contain up to 21 characters and must start with a letter or digit. It can contain letters, digits, hyphens (-), underscores (_), and periods (.).
-The message template must meet the following requirements:
-- The template supports plain text only.
- The template content cannot be left blank and cannot exceed 256 KB.
- The template can contain up to 256 variables in total, but that includes redundant variables. For unique variables, there can be no more than 90.
- When you send messages using a template, the message content you specify for each variable cannot exceed 1 KB.
For example, the template information is as follows:-- Template Name: tem_001
- Protocol: Default
- Content: The Arts and Crafts Exposition will be held from {startdate} through {enddate}. We sincerely invite you to join us.Figure 5 Create Message Template-
- Click OK.
The template you created is displayed in the template list.
-
-Step 4. Publish a Template Message
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
-- In the topic list, locate the topic that you need to publish a message to and click Publish Message under Operation.
- Configure the required parameters.
The topic name is provided by default and cannot be changed.
-Select Template for Message Format. Then, manually type the template content in the Message box or click Generate Template Message to generate it automatically. The template message content cannot exceed 256 KB.
-- If you choose to manually type the template message, see Template Message Format for detailed requirements.
- If you choose to automatically generate the template message, proceed with 7 through 10.
- Click Generate Template Message.
- Select a template name, for example, tem_001, and enter values for the variables.The system replaces the variables with the message content you specified. The protocols configured in the template are displayed after each variable. Only the Default protocol is specified in tem_001, as shown in Figure 6. Therefore, all confirmed subscribers in the topic will receive the message content in the default template. --
- Click the Preview tab to preview the message.In this example, the message generated is "The Arts and Crafts Exposition will be held from February 10 through February 21. We sincerely invite you to join us."-Figure 7 Previewing the template message-
- Click OK.The message that is generated contains the template name and variables.-Figure 8 Template message example-
- Click OK.
SMN delivers your message to all subscription endpoints. For details about messages for different protocols, see Messages of Different Protocols.
-
-Step 5. Receive the Message
Subscription endpoints of different protocols receive different messages.- -- Email
Subscription endpoints are email addresses.
-Email messages contain the message subject, content, and a link to unsubscribe.
-Figure 9 Email message- - HTTP/HTTPS
Subscription endpoints are public network URLs. For details, see section "HTTP/HTTPS Messages" in Simple Message Notification User Guide.
- - SMS
Subscription endpoints are phone numbers.
-SMS messages contain only the message content.
- - DMS
Subscription endpoints are message queues.
-Message content is not displayed in message queues. You can access the DMS console and check the number of messages in a queue. After you publish a message to the message queue, the number in that queue will increase.
-
-- - - \ No newline at end of file diff --git a/docs/smn/umn/smn_ug_0006.html b/docs/smn/umn/smn_ug_0006.html index 1b099f238..eeeddbedb 100644 --- a/docs/smn/umn/smn_ug_0006.html +++ b/docs/smn/umn/smn_ug_0006.html @@ -1,31 +1,28 @@ ---Parent topic: Getting Started-Adding Tags to a Topic
+Adding, Modifying, or Deleting a Topic Tag
-Scenarios
Tags consist of keys and values. They identify cloud resources so that you can easily categorize and search for your resources.- A tag key can have multiple values.
- Tag keys for the same resource must be unique.
Adding Tags to a Topic
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
+Adding Tags to a Topic
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
- Click the topic name. -
- Click the Tags tab.
- Click Add Tag and specify tag keys and values.Figure 1 Add Tag-
- - \ No newline at end of file diff --git a/docs/smn/umn/smn_ug_0008.html b/docs/smn/umn/smn_ug_0008.html index 5ca3175d5..60eab4669 100644 --- a/docs/smn/umn/smn_ug_0008.html +++ b/docs/smn/umn/smn_ug_0008.html @@ -1,15 +1,14 @@ -- A key can contain up to 36 characters. A value can contain up to 43 characters. Both Key and Value can contain only digits, letters, hyphens (-), at signs (@), and underscores (_).
- You can add up to 10 tags for each topic.
- Click the Tags tab.
- Click Add Tag and specify tag keys and values.
Figure 1 Add Tag+ - A key can contain up to 36 characters. A value can contain up to 43 characters. Both Key and Value can contain only digits, letters, hyphens (-), at signs (@), and underscores (_).
- You can add up to 20 tags for each topic.
- Click OK.
The tags you added are displayed in the list.
Modifying Tags of a Topic
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
+-Modifying a Topic Tag
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
- Click the topic name. -
- Click the Tags tab.
- Click Edit under Operation to modify the tag value.Figure 2 Edit Tag+
- Click the Tags tab.
- Click Edit under Operation to modify the tag value.Figure 2 Edit Tag
- Click OK.
@@ -35,10 +32,3 @@Deleting Tags of a Topic
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
+Deleting a Topic Tag
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
- Click the topic name. -
- Click the Tags tab.
- Click Delete under Operation and click Yes in the confirmation box.Figure 3 Delete Tag+
- Click the Tags tab.
- Click Delete in the Operation column and click OK in the confirmation dialog box.Figure 3 Delete Tag
Adding a Subscription
-Scenarios
To deliver messages published to a topic to endpoints, you must add the subscription endpoints to the topic. Endpoints can be email addresses, phone numbers, message queues, and HTTP/HTTPS URLs. After you add endpoints to the topic and the subscribers confirm the subscription, they are able to receive messages published to the topic.
-You can add multiple subscriptions to each topic. This section describes how to add subscriptions to a topic you created or a topic that you have been granted permissions to and how to delete subscriptions.
+-Scenarios
To enable an endpoint to receive messages published to a topic, you must subscribe the endpoint to the topic. The endpoint can be a phone number, email address, function, or an HTTP/HTTPS URL. After you subscribe an endpoint to a topic and the subscription is confirmed, the endpoint can receive messages published to the topic.
+You can add multiple subscriptions to a topic. This section describes how to add a subscription to a topic you created or a topic that you have permissions for.
To Add a Subscription
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- - -
- In the upper right corner, click Add Subscription.
The Add Subscription dialog box is displayed.
-Figure 1 Add Subscription- - Specify the required subscription information.
- Click beside the Topic Name box to select a topic.
- Specify the subscription protocol and endpoints.
-
Table 1 Parameter descriptions Parameter
+Adding a Subscription
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane on the left, choose Subscriptions.
- In the upper right corner, click Add Subscription.
The Add Subscription dialog box is displayed.
+Figure 1 Add Subscription+ - Specify the required subscription information.
- Beside Topic Name, click Select Topic.
- Specify the subscription protocol and endpoints.
+
Table 1 Parameters for adding a subscription Parameter
Description
Topic Name
Name of the topic to be subscribed to
+Specifies the name of the topic to which messages are published.
Protocol
Protocol that the subscription endpoints support. The available protocols are SMS, Email, HTTP, and HTTPS.
+Specifies the protocol over which messages are sent. Possible values are SMS, HTTP, HTTPS, FunctionGraph (function), and Email.
Endpoint
Subscription endpoint. You can enter up to 10 SMS, email, HTTP, or HTTPS endpoints, one in each line.
-- SMS: Enter one or more valid phone numbers.
The phone number is preceded by a plus sign (+) and a country code.
-Example:
+Specifies the subscription endpoint. You can add up to 10 SMS, email, HTTP, or HTTPS endpoints, one in each line.
+- SMS: Enter one or more valid phone numbers.
A phone number must be preceded by a plus sign (+) and a country code.
+Examples:
+4900000000
+4900000001
+4900000002
+4900000003
- - Email: Enter one or more valid email addresses.
Example:
+ - Email: Enter one or more valid email addresses.
Examples:
username@example.com
username2@example.com
- HTTP: Enter one or more public network URLs.
Example:
http://example.com/notification/action
- HTTPS: Enter one or more public network URLs.
Example:
https://example.com/notification/action
- - DMS: Click to select a message queue. Ensure that the queue policy grants the ProduceMessages permission to SMN. For details, see section "Managing Queue Policies" in the Distributed Message Service User Guide.
- FunctionGraph (function): Click
+ to select a function and specify its version. - SMS: Enter one or more valid phone numbers.
Version
+This parameter is only available if FunctionGraph (function) is selected for Protocol. Select the version for the function.
+Description
+Specifies the remarks of the subscription.
- Click OK.
The subscription you added is displayed in the subscription list.
-- - \ No newline at end of file diff --git a/docs/smn/umn/smn_ug_0009.html b/docs/smn/umn/smn_ug_0009.html index 3686e300e..79a8eceab 100644 --- a/docs/smn/umn/smn_ug_0009.html +++ b/docs/smn/umn/smn_ug_0009.html @@ -1,11 +1,11 @@ @@ -60,10 +70,3 @@- To prevent malicious users from attacking subscription endpoints, SMN limits the number of confirmation messages that can be sent to an endpoint within a specified period of time. For details, see Control over Subscription Confirmation Traffic.
- SMN does not check whether subscription endpoints exist when you add subscriptions. However, subscribers will not receive notification messages until they confirm their subscriptions.
- After you add a subscription, SMN sends a confirmation message to the subscription endpoint. The message contains a link for confirming the subscription. The subscription confirmation link is valid within 48 hours. Confirm the subscription on your mobile phone, mailbox, or other endpoints in time.
To search for a subscription, you can filter subscriptions by protocol or subscription status in the upper right corner of the subscription list. You can also enter a subscription endpoint and click
+ or press Enter. - To prevent malicious users from attacking subscription endpoints, SMN limits the number of confirmation messages that can be sent to an endpoint within a specified period. For details, see Traffic Control over Subscription Confirmation.
- SMN does not check whether subscription endpoints exist when you add subscriptions.
- After you add a subscription or request subscription confirmation, SMN will send a confirmation message to the endpoints, and the link in the confirmation message will be valid for 48 hours.
- Subscription confirmation messages will be counted as messages sent and will be billed.
Requesting Subscription Confirmation
-Scenarios
If a subscriber does not receive the confirmation message, request confirmation again. You can send a subscription confirmation message to one or more subscription endpoints at a time. For details about how many confirmation messages you can send to one subscriber, see Control over Subscription Confirmation Traffic.
+-Scenarios
If a subscriber does not receive the confirmation message, request confirmation again. You can send a subscription confirmation message to one or more subscription endpoints at a time. For details, see Traffic Control over Subscription Confirmation.
To Request Subscription Confirmation
- Log in to the management console.
- Click
on the upper left to select the desired region and project. - Under Application, select Simple Message Notification.
The SMN console is displayed.
- - -
- In the subscription list, select one or more subscriptions whose status is Unconfirmed.
- Click Request Confirmation above the subscription list to send confirmation messages.
- The subscribers confirm their subscriptions. -
- To prevent malicious users from attacking subscription endpoints, SMN limits the number of confirmation messages that can be sent to an endpoint within a specified period of time. For details, see Control over Subscription Confirmation Traffic.
- SMN does not check whether subscription endpoints exist when you add subscriptions. However, subscribers will not receive notification messages until they confirm their subscriptions.
- After you add a subscription, SMN sends a confirmation message to the subscription endpoint. The message contains a link for confirming the subscription. The subscription confirmation link is valid within 48 hours. Confirm the subscription on your mobile phone, mailbox, or other endpoints in time.
diff --git a/docs/smn/umn/smn_ug_0010.html b/docs/smn/umn/smn_ug_0010.html index 55d928c93..cabc0562c 100644 --- a/docs/smn/umn/smn_ug_0010.html +++ b/docs/smn/umn/smn_ug_0010.html @@ -5,8 +5,8 @@Requesting Subscription Confirmation
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane on the left, choose Subscriptions.
- In the subscription list, select one or more subscriptions whose status is Unconfirmed.
- Click Request Confirmation above the subscription list and SMN will send confirmation requests.
Alternatively, click Request Confirmation in the Operation column, and SMN will send the confirmation request.
+ - The subscribers confirm their subscriptions.
- To prevent malicious users from attacking subscription endpoints, SMN limits the number of confirmation messages that can be sent to an endpoint within a specified period. For details, see Traffic Control over Subscription Confirmation.
- SMN does not check whether subscription endpoints exist when you add subscriptions. However, subscribers will not receive notification messages until they confirm their subscriptions.
- After you add a subscription and request subscription confirmation, SMN sends a message that contains a link for confirming the subscription to the subscription endpoint. The subscription confirmation link is valid within 48 hours. Confirm the subscription on your mobile phone, mailbox, or other endpoints in time.
- Subscription confirmation messages will be counted as messages sent and will be billed.
The subscription management capability of SMN is open to subscribers. You must keep your subscription links secure to avoid being unable to receiving notifications or receiving unexpected notifications.
To Cancel a Subscription
A subscriber can choose to cancel the subscription based on the protocol of the subscription endpoint:
-- SMS: SMN does not provide a link to unsubscribe in SMS notification messages because of the message length limit. To cancel an SMS subscription, the subscriber needs to access the link provided in the subscription confirmation message and cancels the subscription on the web page.
- Email: SMN encloses a link to unsubscribe in email notifications. The subscriber can cancel the subscription by clicking the link. After the subscriber has canceled the subscription, SMN re-sends a subscription confirmation email which is valid for 48 hours, so that the subscriber can re-subscribe to the topic if they clicked the link by mistake.
- HTTP/HTTPS: SMN provides a link to unsubscribe in the HTTP/HTTPS message body. The subscriber can cancel the subscription by clicking the link. After the subscriber has canceled the subscription, the system returns 200 over HTTP and re-sends a subscription confirmation message which is valid for 48 hours, in case the subscriber has clicked the link by mistake. For details about the HTTP/HTTPS message header and body, see Introduction.
Canceling a Subscription
A subscriber can choose to cancel the subscription based on the protocol of the subscription endpoint:
+- SMS: SMN does not provide a link to unsubscribe in an SMS notification message because of the message length limit. To cancel an SMS subscription, the subscriber needs to access the link provided in the subscription confirmation message and cancels the subscription on the web page.
- Email: SMN encloses a link to unsubscribe in an email notification. The subscriber can cancel the subscription by clicking the link. After the subscriber cancels the subscription, SMN re-sends a subscription confirmation email which is valid for 48 hours, so that the subscriber can re-subscribe to the topic if they clicked the link by mistake.
- HTTP/HTTPS: SMN sends a message that contains a link to cancel the subscription to a specified URL. The subscriber can cancel the subscription by accessing the link. After that, the system returns 200 over HTTPS and re-sends a subscription confirmation message which is valid for 48 hours to the URL, in case the subscriber has canceled the subscription by mistake. For details about the HTTP/HTTPS message header and body, see Introduction.
diff --git a/docs/smn/umn/smn_ug_0011.html b/docs/smn/umn/smn_ug_0011.html index 2b07bb983..c5e2ca2a8 100644 --- a/docs/smn/umn/smn_ug_0011.html +++ b/docs/smn/umn/smn_ug_0011.html @@ -3,11 +3,15 @@Deleting a Subscription
-Scenarios
If one or multiple subscription endpoints do not need to receive messages published to a topic, you can delete them.
To Delete Subscriptions
- Log in to the management console.
- Click
on the upper left to select the desired region and project. - Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
++Deleting a Subscription on the Topic Details Page
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
- Click the topic name. -
- In the Subscriptions area, view the subscriptions to the topic.
- Select one or more subscription endpoints and click Delete.
- In the displayed Delete Subscription dialog box, click OK.
- In the Subscriptions area, view the subscriptions to the topic.
- Select one or more subscriptions and click Delete at the top left of the list.
Alternatively, locate the subscription to be deleted and click Delete in the Operation column.
+- In the displayed Delete Subscription dialog box, click OK.
+Deleting a Subscription on the Subscription Page
- Log in to the management console.
- Click
on the upper left to select the desired region and project. - Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane on the left, choose Subscriptions.
- In the subscription list, select one or more subscriptions and click Delete above the subscription list.
Alternatively, locate the subscription to be deleted and click Delete in the Operation column.
+ - In the displayed Delete Subscription dialog box, click OK.
diff --git a/docs/smn/umn/smn_ug_0012.html b/docs/smn/umn/smn_ug_0012.html index dcd967834..6c0b59f9b 100644 --- a/docs/smn/umn/smn_ug_0012.html +++ b/docs/smn/umn/smn_ug_0012.html @@ -1,13 +1,13 @@ -Key SMN Operations Recorded by CTS
-After you enable CTS, whenever an SMN API is called, the operation is recorded in a log file, which is then dumped to a specified OBS bucket for storage based on time and data changes.
-However, if someone makes an API call to cancel a subscription without login, CTS will not record the operation. For example, if a subscriber clicks the link in an email notification to cancel the subscription, the Unsubscribe API is called, but CTS does not record the operation.
+SMN Operations Audited by CTS
+After you enable CTS, whenever an SMN API is called, the operation may be recorded in a log file, which is then dumped to a specified OBS bucket for storage based on time and data changes.
+However, if someone calls the SMN API to cancel a subscription without login, CTS will not record the operation. For example, if a subscriber clicks the link in an email to cancel the subscription, the API for unsubscribing is called, but CTS does not record the operation.
Table 1 lists the SMN operations that will be recorded by CTS.
Table 1 SMN operations recorded by CTS Operation
Resource
+Resource Type
Trace Name
Creating a topic
Topic
+topic
createTopic
Deleting a topic
Topic
+topic
deleteTopic
Updating a topic
Topic
+topic
updateTopic
Updating a topic policy
Topic
+topic
updateTopicAttribute
Deleting all topic policies
-Topic
-deleteTopicAttributes
-Deleting a specified topic policy
-Topic
-deleteTopicAttributeByName
-Adding a subscription
Subscription
+subscription
subscribe
Deleting a subscription
Subscription
+subscription
unsubscribe
+delsubscribe
Creating a message template
Message template
+message_template
createMessageTemplate
Creating message templates in batches
-Message template
-batchCreateMessageTemplate
-Modifying a message template
Message template
+message_template
updateMessageTemplate
Deleting a message template
Message template
+message_template
deleteMessageTemplate
Batch adding tags
+tag
+batchCreateTag
+Deleting a tag
+tag
+deleteTag
+diff --git a/docs/smn/umn/smn_ug_0013.html b/docs/smn/umn/smn_ug_0013.html index 6a90b15e8..12df987dd 100644 --- a/docs/smn/umn/smn_ug_0013.html +++ b/docs/smn/umn/smn_ug_0013.html @@ -1,85 +1,25 @@ --Parent topic: SMN Operation Recording+Parent topic: CTS AuditingCTS Traces
-Scenarios
After CTS is enabled, it starts recording operations on cloud resources. You can view the operation records of the last seven days on the management console.
-This topic describes how to query or export the last seven days of operation records on the CTS console.
+Querying SMN Real-Time Traces
+-Scenarios
After you enable CTS and the management tracker is created, CTS starts recording operations on cloud resources. Cloud Trace Service (CTS) stores operation records (traces) generated in the last seven days.
-Procedure
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Click Service List in the upper left corner. Under Management & Deployment, select Cloud Trace Service.
- In the left navigation pane, choose Trace List.
- Specify filters as needed. The following filters are available:Figure 1 Filters-
-- Trace Type, Trace Source, Resource Type, and Search By
Select the filter from the drop-down list.
-- When you select Trace name for Search By, you also need to select a specific trace name.
- When you select Resource ID for Search By, you also need to enter a resource ID.
- When you select Resource name for Search By, select or enter a specific resource name.
- Operator: Select a specific operator.
- Trace Status: Available options include All trace statuses, Normal, Warning, and Incident. You can select only one of them.
- Time range: You can query traces generated at any time range of the last seven days.
- Trace Type, Trace Source, Resource Type, and Search By
- Click
on the left of the required trace to expand its details. - Click View Trace.
CTS Log Entries
Each log entry consists of a trace in JSON format. A log entry indicates an SMN API request, including the requested operation, the date and time, operation parameters, and information about the user who sent the request. The user information is obtained from the Identity and Access Management (IAM) service.
-The following example shows CTS log entries for the CreateTopic, DeleteTopic, and UpdateTopic actions:{ - "time": "2017-02-15 14:21:50 GMT+08:00", - "user": "xxx", - "request": "xxx", - "response": "xxx", - "code": 200, - "service_type": "SMN", - "resource_type": "topic", - "resource_id": "topicUrn instance", - "source_ip": "127.0.0.1", - "trace_name": "createTopic", - "trace_rating": "normal", - "trace_type": "ApiCall", - "api_version": "2.0", - "project_id": "tenantId instance", - "record_time": "2017-02-15 14:21:50 GMT+08:00", - "trace_id": "xxx" -} - -{ - "time": "2017-02-15 14:12:15 GMT+08:00", - "user": "xxx", - "response": "xxx", - "code": 200, - "service_type": "SMN", - "resource_type": "topic", - "resource_id": "topicUrn instance", - "source_ip": "127.0.0.1", - "trace_name": "deleteTopic", - "trace_rating": "normal", - "trace_type": "ApiCall", - "api_version": "2.0", - "project_id": "tenantId instance", - "record_time": "2017-02-15 14:12:15 GMT+08:00", - "trace_id": "xxx" -} - -{ - "time": "2017-02-13 15:38:30 GMT+08:00", - "user": "xxx", - "request": "xxx", - "response": "xxx", - "code": 200, - "service_type": "SMN", - "resource_type": "topic", - "resource_id": "topicUrn instance", - "source_ip": "127.0.0.1", - "trace_name": "updateTopic", - "trace_rating": "normal", - "trace_type": "ApiCall", - "api_version": "2.0", - "project_id": "tenantId instance", - "record_time": "2017-02-13 15:38:30 GMT+08:00", - "trace_id": "xxx" -}+Viewing Real-Time Traces in the Trace List
- Log in to the management console.
- Click
in the upper left corner and choose Management & Deployment > Cloud Trace Service. The CTS console is displayed. - Choose Trace List in the navigation pane on the left.
- Set filters to search for your desired traces, as shown in Figure 1. The following filters are available.
++
- Trace Type, Trace Source, Resource Type, and Search By: Select a filter from the drop-down list.
- If you select Resource ID for Search By, specify a resource ID.
- If you select Trace name for Search By, specify a trace name.
- If you select Resource name for Search By, specify a resource name.
- Operator: Select a user.
- Trace Status: Select All trace statuses, Normal, Warning, or Incident.
- Time range: Select Last 1 hour, Last 1 day, or Last 1 week, or specify a custom time range within the last seven days.
- Trace Type, Trace Source, Resource Type, and Search By: Select a filter from the drop-down list.
- Click Query.
- On the Trace List page, you can also export and refresh the trace list.
- Click Export to export all traces in the query result as a CSV file. The file can contain up to 5,000 records.
- Click
to view the latest information about traces.
- Click
on the left of a trace to expand its details.
+
+ + + +
- Click View Trace in the Operation column. The trace details are displayed.
+
- For details about key fields in the trace structure, see Trace Structure and Example Traces in the CTS User Guide.
- - \ No newline at end of file diff --git a/docs/smn/umn/smn_ug_0030.html b/docs/smn/umn/smn_ug_0030.html deleted file mode 100644 index d396ba6e6..000000000 --- a/docs/smn/umn/smn_ug_0030.html +++ /dev/null @@ -1,12 +0,0 @@ - - --Parent topic: SMN Operation Recording+Parent topic: CTS AuditingIntroduction
--You can use Cloud Trace Service (CTS) to record information about SMN-related operations, including request content, source IP addresses, request senders, and when a request was sent, for future query, audit, and backtracking.
-CTS can record operations performed on the management console, performed by calling APIs, and triggered within the cloud system.
--- diff --git a/docs/smn/umn/smn_ug_0031.html b/docs/smn/umn/smn_ug_0031.html index 57338e660..1565ba2aa 100644 --- a/docs/smn/umn/smn_ug_0031.html +++ b/docs/smn/umn/smn_ug_0031.html @@ -6,7 +6,7 @@--Parent topic: SMN Operation Recording-- Introduction
- - HTTP/HTTPS Message Format
+ - HTTP or HTTPS Message Format
- Message Signature Verification
diff --git a/docs/smn/umn/smn_ug_0034.html b/docs/smn/umn/smn_ug_0034.html
new file mode 100644
index 000000000..32bf37bf8
--- /dev/null
+++ b/docs/smn/umn/smn_ug_0034.html
@@ -0,0 +1,329 @@
+
+
+ - Roles: a type of coarse-grained authorization mechanism that provides only a limited number of service-level roles When using roles to grant permissions, you need to also assign other roles on which the permissions depend to take effect. However, roles are not an ideal choice for fine-grained authorization and secure access control.
- Policies: a type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions This mechanism allows for more flexible policy-based authorization for secure access control. For example, you can grant SMN users only the permissions for managing a certain type of SMN resources. Most policies define permissions based on APIs. For the API actions supported by SMN, see section "Permissions Policies and Supported Actions" in the Simple Message Notification API Reference.
- smn:topic:list
- smn:tag:list
- smn:topic:list
- smn:tag:list
- Create IAM users for employees based on your enterprise's organizational structure. Each IAM user will have their own security credentials for accessing SMN resources.
- Grant only the permissions required for users to perform a specific task.
- Entrust an account or cloud service to perform efficient O&M on your SMN resources.
- Create a user group and assign permissions
Create a user group on the IAM console and assign the SMN ReadOnlyAccess permissions to the group.
+ - Create a user and add it to the user group.
Create a user on the IAM console and add the user to the group created in 1.
+ - Log in as the created user and verify the SMN ReadOnlyAccess permissions.
Log in to the SMN console by using the created user and verify that the user only has the SMN ReadOnlyAccess permissions.
+- Choose Service List > Simple Message Notification. On the SMN Topics page, click Create Topic in the upper right corner. If the topic cannot be created, the SMN ReadOnlyAccess policy has already taken effect.
- Choose any other service on the Service List page. If a message appears indicating that you have insufficient permissions to access the service, the SMN ReadOnlyAccess policy has already taken effect.
- Choose Service List > Simple Message Notification. On the Topics page, if you can view existing topics, the SMN ReadOnlyAccess policy has already taken effect.
- Visual editor: Select cloud services, actions, resources, and request conditions. This does not require knowledge of policy syntax.
- JSON: Create a JSON policy or edit an existing one.
- Example 1: Grant permissions to create a topic.
{ + "Version": "1.1", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "smn:topic:create" + ] + } + ] +}+ - Example 2: Grant permissions to deny topic deletion.
A policy with only "Deny" permissions must be used with other policies. If the permissions granted to an IAM user contain both "Allow" and "Deny", the "Deny" permissions take precedence over the "Allow" permissions.
+You can assign a system policy of SMN FullAccess and a custom policy of denying topic deletion to the user group which the user belongs to at the same time. Thus the user can perform all operations on SMN except deleting topics. The following is an example of a deny policy:
+{ + "Version": "1.1", + "Statement": [ + { + "Effect": "Deny", + "Action": [ + "smn:topic:delete" + ] + } + ] +}+ - Example 3: Create a custom policy containing multiple actions.
A custom policy can contain multiple actions that belong to any global or project-level services. The following is a custom policy containing multiple actions:
+{ + "Version": "1.1", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "smn:topic:create", + "smn:tag:create" + ] + }, + { + "Effect": "Allow", + "Action": [ + "elb:certificates:create", + "elb:whitelists:create", + "elb:pools:create", + "elb:members:create", + "elb:healthmonitors:create", + "elb:l7policies:create", + "elb:listeners:create", + "elb:loadbalancers:create" + ] + } + ] +}+ - Log in to the management console.
- Click on the upper left to select the desired region and project.
- Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
-- Locate the topic, click More under Operation, and select Modify Display Name. diff --git a/docs/smn/umn/smn_ug_47000.html b/docs/smn/umn/smn_ug_47000.html index 46eb9dc7c..841e83fcd 100644 --- a/docs/smn/umn/smn_ug_47000.html +++ b/docs/smn/umn/smn_ug_47000.html @@ -3,12 +3,12 @@
After you specify a display name, the sender in email messages will be presented as Display name<username@example.com>. Otherwise, the sender will be username@example.com.
+Modifying the Display Name of a Topic
- Log in to the management console.
- In the upper left corner of the page, click and select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
+ - Locate the topic, choose More > Modify Display Name in the Operation column. In the displayed Modify Display Name dialog box, enter a new display name.
Alternatively, locate the topic and click its name. In the Topic Details area, click
+
and enter a new display name.- After you specify a display name, the sender in email messages will be presented as Display name<noreply@otc.t-systems.com>. Otherwise, the sender will be noreply@otc.t-systems.com.
Enter a new display name.
- Click OK.
Publishing a Message to a Topic Granted to You
-Scenarios
If another user creates a topic and grants you permissions to publish messages, you can publish text or JSON messages to the topic.
- - \ No newline at end of file diff --git a/docs/smn/umn/smn_ug_48000.html b/docs/smn/umn/smn_ug_48000.html index 6bb471555..02cf6bfc1 100644 --- a/docs/smn/umn/smn_ug_48000.html +++ b/docs/smn/umn/smn_ug_48000.html @@ -1,10 +1,9 @@Prerequisites
You have obtained the URN of the topic granted to you. For details about obtaining the URN of a topic, see Creating a Topic.
+-Prerequisites
You have obtained the URN of the topic granted to you. For details about obtaining a topic URN, see Creating a Topic.
To Publish a Message to a Topic Granted to You
- Log in to the management console.
- Click
on the upper left to select the desired region and project. - Under Application, select Simple Message Notification.
The SMN console is displayed.
+@@ -19,10 +19,3 @@Procedure
- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
- On the Dashboard page, click Publish Message.
- Specify the topic URN, message subject, and message format and enter your message content.-
Clicking
beside Topic URN only enables you to select a topic you created, instead of a topic that you are granted permissions to.Figure 1 Publishing a message to a topic granted to you+
Figure 1 Publishing a message to a topic granted to youFor more details, see Publishing a Text Message and Publishing a JSON Message.
Deleting a Topic
-- Log in to the management console.
- Click
on the upper left to select the desired region and project. - Under Application, select Simple Message Notification.
The SMN console is displayed.
- In the navigation pane, choose Topics.
-The Topics page is displayed.
-- Locate a topic, click More under Operation, and select Delete.
diff --git a/docs/smn/umn/smn_ug_90000.html b/docs/smn/umn/smn_ug_90000.html index dd136cc51..7e7c3afca 100644 --- a/docs/smn/umn/smn_ug_90000.html +++ b/docs/smn/umn/smn_ug_90000.html @@ -1,14 +1,12 @@ -- Log in to the management console.
- Click on the upper left to select the desired region and project.
- Select Simple Message Notification under Application.
The SMN console is displayed.
+ - In the navigation pane, choose Topics.
The Topics page is displayed.
+ - Locate a topic, click More in the Operation column, and select Delete.
- In the displayed Delete Topic dialog box, click OK.
Deleting a topic deletes all its subscriptions.
SMN Operation Recording
+CTS Auditing
diff --git a/docs/smn/umn/smn_ug_a0000.html b/docs/smn/umn/smn_ug_a0000.html index baa60a370..cac35da8b 100644 --- a/docs/smn/umn/smn_ug_a0000.html +++ b/docs/smn/umn/smn_ug_a0000.html @@ -8,11 +8,9 @@- Template Message Format
-
- Messages of Different Protocols
+- Messages Using Different Protocols
-
- Control over Subscription Confirmation Traffic
-
-- Mappings Between SMN Actions and APIs
+- Traffic Control over Subscription Confirmation
- HTTP/HTTPS Messages
diff --git a/docs/smn/umn/smn_ug_a1000.html b/docs/smn/umn/smn_ug_a1000.html index f9a4b2fe3..5f3eddce3 100644 --- a/docs/smn/umn/smn_ug_a1000.html +++ b/docs/smn/umn/smn_ug_a1000.html @@ -1,27 +1,25 @@
JSON Message Format
-Description
The JSON format allows you to specify different message content for different subscription protocols, including Default, SMS, HTTP, HTTPS, DMS, and Email. The message content you specify will be sent to subscription endpoints using applicable protocols.
+-Description
The JSON format allows you to specify different message content for different subscription protocols, including Default, SMS, HTTP, HTTPS, FunctionGraph (function), and Email. The message content you specify will be sent to subscription endpoints using applicable protocols.
{ "default": "Dear Sir or Madam, this is a default message.", "email": "Dear Sir or Madam, this is an email message.", "http": "{'message':'Dear Sir or Madam, this is an HTTP message.'}", "https": "{'message':'Dear Sir or Madam, this is an HTTPS message.'}", "sms": "This is an SMS message." - - - "dms":"Dear Sir or Madam, this is a DMS message." + "functionstage": "Dear Sir or Madam, this is a functiongraph(function) message." }It is recommended that you specify general message content for all subscription types in the Default protocol and enter customized content for specific protocols.
-In the following example, you enter a shorter message for the SMS protocol because of the length limit on SMS messages. SMS subscribers in the topic receive the message "This is an SMS message.", while other types of subscribers (email, DMS, HTTP, and HTTPS) receive "Dear Sir or Madam, this is a default message."
+In the following example, you enter a shorter message for the SMS protocol because of the length limit on SMS messages. SMS subscribers in the topic receive the message "This is an SMS message.", while other types of subscribers (email, FunctionGraph (function), HTTP, and HTTPS) receive the one "Dear Sir or Madam, this is a default message."
{ "sms": "This is an SMS message.", "default": "Dear Sir or Madam, this is a default message." }Constraints
- The content must comply with JSON format requirements.
- You must configure the Default protocol in the JSON message.
- The total size of a JSON message cannot exceed 256 KB.
-Constraints
- The content must be in JSON format.
- You must configure the Default protocol in the JSON message.
- The size of a JSON message cannot exceed 256 KB.
Calculation on the JSON Message Size
The total size of a JSON message, including braces, quotation marks, spaces, line breaks, and message content, cannot exceed 256 KB. The size of a JSON message generated for each protocol may vary.
+Calculation on the Size of a JSON Message
The size of a JSON message, including braces, quotation marks, spaces, line breaks, protocols, and message content, cannot exceed 256 KB. The size of a JSON message generated for each protocol may vary.
For example, message content "This is a default message." contains 26 bytes.
The system automatically adds the Default protocol when generating a JSON message.
{ @@ -30,12 +28,12 @@ "protocol2": "This is a default message.", ... }-The total number of protocols is N, including the Default protocol and those you selected.
-The size of the message is calculated as follows:diff --git a/docs/smn/umn/smn_ug_a2000.html b/docs/smn/umn/smn_ug_a2000.html index 3d765cc27..184674ece 100644 --- a/docs/smn/umn/smn_ug_a2000.html +++ b/docs/smn/umn/smn_ug_a2000.html @@ -2,13 +2,15 @@- Three spaces in each of the N protocols: 3 x N = 3N bytes
- Four quotation marks in each of the N protocols: 4 x N = 4N bytes
- One colon in each of the N protocols: 1 x N = N bytes
- Message content "This is a default message." in each of the N protocols: 26 x N = 26N bytes
- Commas in (N – 1) protocols: 1 x (N – 1) = (N – 1) bytes
- Line breaks in (N + 1) protocols: 1 x (N + 1) = (N + 1) bytes
- Two braces: 2 bytes
- Protocol name default: 7 bytes
The total number of protocols is N, including the Default protocol and those you selected.
+The size of the message is calculated as follows:-- Three spaces in each of the N protocols: 3 x N = 3N bytes
- Four quotation marks in each of the N protocols: 4 x N = 4N bytes
- One colon in each of the N protocols: 1 x N = N bytes
- Message content "This is a default message." in each of the N protocols: 26 x N = 26N bytes
- Commas in (N – 1) protocols: 1 x (N – 1) = (N – 1) bytes
- Line breaks in (N + 1) protocols: 1 x (N + 1) = (N + 1) bytes
- Two braces: 2 bytes
- Protocol name Default: 7 bytes
Bytes of protocols you selected:- http: 4 bytes
- https: 5 bytes
- email: 5 bytes
- sms: 3 bytes
- dms: 3 bytes
Bytes of protocols you selected:-- HTTP: 4 bytes
- HTTPS: 5 bytes
- Email: 5 bytes
- SMS: 3 bytes
- FunctionStage: 13 bytes
Total size = 36N + 9 + Bytes of selected protocols
+Total size = 36N + 9 + Bytes of protocols you selected
For example, you selected the HTTP, HTTPS, and email protocols, and the message is as follows:
{ "default": "This is a default message.", @@ -43,8 +41,8 @@ "http": "This is a default message.", "https": "This is a default message." }-The system adds a Default protocol, and therefore the value of N is 4. The size of your JSON messages is:
-- Fixed length: 36 x 4 + 9 = 153 bytes
- http: 4 bytes
- https: 5 bytes
- email: 5 bytes
The system adds a Default protocol, and the value of N is 4. The size of this JSON message is:
+- Fixed length: 36 x 4 + 9 = 153 bytes
- http: 4 bytes
- https: 5 bytes
- email: 5 bytes
The total size is 167 bytes (153 + 4 + 5 + 5 = 167).
Template Message Format
Message templates are used to publish messages with fixed content and use variables as placeholders to represent content that you can change.
-The size of template content cannot exceed 256 KB. The following is an example of how to format a template when you manually type the template message content:
-"message_template_name":"confirm_message", -"tags":{ - "topic_urn":"urn:smn:regionId:xxxx:SMN_01" - }+The size of template message cannot exceed 256 KB. The following is an example of how to format a template when you manually type the template message content:
+{ + "message_template_name":"confirm_message", + "tags":{ + "topic_urn":"urn:smn:regionId:xxxx:SMN_01" + } +}-Table 1 Parameters in template message format Parameter
+Table 1 Parameters description and setting Parameter
Description
Messages of Different Protocols
-Messages delivered to endpoints using different protocols contain different content.
-- Email or HTTP/HTTPS endpoints will receive the message subject, content, and a link to unsubscribe.
- SMS endpoints receive only the message content.
- DMS messages contain the message subject, content, and topic URN. Table 1 describes parameters in DMS messages. The following is an example message:
{ - "message":[{ - "body":"{ - "event_version":"1.0", - "subject":"test", - "event_source":"smn", - "event_subscription_urn":"urn:smn:regionId:c5acb70716ec4d489213da33e06b15f6:smn_123:47cff941a17f435ea5f6091d3579664e", - "message_id":"174a38fb1ef24724bf8043954b7330c9", - "topic_urn":"urn:smn:regionId:c5acb70716ec4d489213da33e06b15f6:smn_123", - "type":"notification", - "message":"Hello", - "timestamp":"2017-10-24T09:37:02Z" - }" - ]} +Messages Using Different Protocols
+Message contents delivered to endpoints using different protocols may differ.
+- Email or HTTP/HTTPS endpoints will receive the message subject, content, and a link to unsubscribe.
- SMS endpoints receive only the message content.
- FunctionGraph (function) messages contain the message attributes, subject, content, and topic URN. Table 1 describes parameters in FunctionGraph (function) messages. The following is an example message:
{ + "record": [{ + "event_version": "1.0", + "smn": { + "message_attributes": "", + "subject": "Welcome", + "message_id": "e6fa59c6b3e0424c9c02cbed35b680e7", + "topic_urn": "urn:smn:regionId:66e0f4622d6f4e3fb2db2e495298a61a:smn_123", + "type": "notification", + "message": "Hello", + "timestamp": "2017-08-17T10:07:14Z" }, + "event_source": "smn", + "event_subscription_urn": "urn:cff:regionId:66e0f4622d6f4e3fb2db2e495298a61a:function:DEFAULT:mytest:latest" + }] }-Table 1 Parameters in a DMS message Parameter
+Table 1 Parameters in a FunctionGraph (function) message Parameter
Type
+Type
Description
+Description
message
+record
JSON object
+JSON object
Message list
+Message list
body
+event_version
String
+String
Message body
+Version
event_version
+message_attributes
String
+String
Version
+Message attributes
subject
+subject
String
+String
Message subject
+Message subject
event_source
+message_id
String
+String
Message source
+Message ID
event_subscription_urn
+topic_urn
String
+String
Subscription URN
+Topic URN
message_id
+type
String
+String
Message ID
+Message type
topic_urn
+message
String
+String
Topic URN
+Message content
type
+timestamp
String
+String
Message type
+Timestamp
message
+event_source
String
+String
Message content
+Message source
timestamp
+event_subscription_urn
String
+String
Timestamp
+Subscription URN
Control over Subscription Confirmation Traffic
-To prevent malicious users from harassing subscribers, there is a limit on the number of subscription confirmation messages a user can send to an individual subscriber within a specified period of time. Traffic control policies apply to confirmation requests issued both from the SMN console and by API calling. Traffic control policies for different subscription protocols are as follows:
-- Email: A user can send up to 20 confirmation messages within one hour or 40 within two days. If the user exceeds this threshold, SMN will not send any more confirmation messages to that email address in the next seven days. After the subscriber confirms the subscription, SMN clears the count in the traffic control policy.
- SMS: A user can send up to 10 confirmation messages within one hour or 20 within two days. If the user exceeds this threshold, SMN will not send any more confirmation messages to that phone number in the next seven days. After the subscriber confirms the subscription, SMN clears the count in the traffic control policy.
- HTTP/HTTPS: A user can send up to 200 confirmation messages within 10 minutes.
Traffic Control over Subscription Confirmation
+To prevent malicious users from harassing subscribers, SMN limits the number of subscription confirmation messages a user can send to an individual subscriber within a specified period of time. Traffic control policies apply to confirmation requests issued both from the SMN console and by API calling.
+Traffic control policies for different subscription protocols are as follows:
+- Email: Up to 20 subscription confirmation emails can be sent within one hour and up to 40 subscription confirmation emails can be sent within two days. If 20 subscription confirmation emails have been sent within one hour, SMN will not send subscription confirmation emails to the endpoint in the next hour. If 40 subscription confirmation emails have been sent within two days, no subscription confirmation email will be sent to the endpoint within the next seven days. If the subscriber confirms the subscription, SMN clears the count in the traffic control policy.
- SMS: Up to 10 subscription confirmation messages can be sent within one hour and up to 20 subscription confirmation messages can be sent within two days. If 10 subscription confirmation messages have been sent within one hour, SMN will not send subscription confirmation messages to the endpoint in the next hour. If 20 subscription confirmation messages have been sent within two days, no subscription confirmation message will be sent to the endpoint within the next seven days. After the subscriber confirms the subscription, SMN clears the count in the traffic control policy.
- HTTP or HTTPS: Up to 200 confirmation messages can be sent within 10 minutes.
The preceding limitations are for reference only and will be adjusted based on service requirements.
+diff --git a/docs/smn/umn/smn_ug_a6000.html b/docs/smn/umn/smn_ug_a6000.html deleted file mode 100644 index 509f2fcdf..000000000 --- a/docs/smn/umn/smn_ug_a6000.html +++ /dev/null @@ -1,99 +0,0 @@ - - -Mappings Between SMN Actions and APIs
----
-Table 1 Mappings between SMN actions and APIs Action
-API
-Function
-SMN:UpdateTopic
-UpdateTopic
-Modify the topic. Only the display_name value can be changed.
-SMN:DeleteTopic
-DeleteTopic
-Delete a topic and its subscribers. If a topic is deleted, any pending messages may fail to send to the topic subscribers.
-SMN:QueryTopicDetail
-QueryTopicDetail
-Query details about a topic.
-SMN:ListTopicAttributes
-ListTopicAttributes
-Query topic attributes.
-SMN:UpdateTopicAttribute
-UpdateTopicAttribute
-Modify an attribute of a topic.
-SMN:DeleteTopicAttributes
-DeleteTopicAttributes
-Delete all attributes of a topic.
-SMN:DeleteTopicAttributeByName
-DeleteTopicAttributeByName
-Delete an attribute of a specified topic.
-SMN:ListSubscriptionsByTopic
-ListSubscriptionsByTopic
-Query the subscription list of a specified topic by page. The list is sorted by time when the subscriptions are added in ascending order. You can specify values of offset and limit. If no subscription has been added, an empty list is returned.
-SMN:Subscribe
-Subscribe
-Add a subscription to a specified topic and send a confirmation message to the subscriber. After confirming the subscription, the subscriber can receive notification messages published to the topic.
-SMN:Unsubscribe
-Unsubscribe
-Delete a subscription. This operation requires identity authentication. Only the subscriber or the topic owner can delete a subscription.
-SMN:Publish
-Publish
-Publish messages to a topic. After a message ID is returned, the message has been saved and is to be delivered to subscribers of the topic. The message form varies depending on the protocol of each subscription.
--- diff --git a/docs/smn/umn/smn_ug_a9001.html b/docs/smn/umn/smn_ug_a9001.html index 91c22dd31..455aa89d1 100644 --- a/docs/smn/umn/smn_ug_a9001.html +++ b/docs/smn/umn/smn_ug_a9001.html @@ -1,7 +1,8 @@--Parent topic: Appendix-Introduction
-HTTP/HTTPS messages can be classified as management messages and service messages. The former includes subscription messages and subscription cancellation messages, while the latter includes notification messages. An HTTPS/HTTPS message is composed of a message header and body, which are illustrated in detail in this topic.
+A message sent to the HTTP or HTTPS endpoint is automatically assembled by SMN. HTTP/HTTPS messages can be classified as management messages and service messages.
+- Management messages include subscription messages and subscription cancellation messages.
- Service messages include notification messages. An HTTP/HTTPS message is composed of a message header and body, which are illustrated in detail in this topic.
diff --git a/docs/smn/umn/smn_ug_a9002.html b/docs/smn/umn/smn_ug_a9002.html index 8c1e07434..c2245c1c9 100644 --- a/docs/smn/umn/smn_ug_a9002.html +++ b/docs/smn/umn/smn_ug_a9002.html @@ -1,12 +1,12 @@ -HTTP/HTTPS Message Format
-Scenarios
When receiving HTTP or HTTPS messages sent by SMN, refer to the industry standards for the CN name of the terminal certificate. Some special characters may cause HTTPS message sending failures.
+HTTP or HTTPS Message Format
+Scenarios
- When receiving HTTP or HTTPS messages sent by SMN, refer to the industry standards for the common name (CN) of the terminal certificate. Some special characters may cause HTTPS message sending failures.
- Unencrypted HTTP messages transmitted on the Internet may cause information leakage. Therefore, select the HTTPS protocol when you add subscriptions.
This section describes the format of messages sent to HTTP or HTTPS endpoints. You can identify messages based on message types in the headers. HTTP/HTTPS message types include: subscription confirmation messages, notification messages, and subscription cancellation messages. POST is used for HTTP/HTTPS messages.
-The header of an SMN HTTP/HTTPS message contains the following parameters: X-SMN-MESSAGE-TYPE, X-SMN-MESSAGE-ID, X-SMN-TOPIC-URN, and X-SMN-SUBSCRIPTION-URN.
+The header of an SMN HTTP/HTTPS message contains the following parameters: X-SMN-MESSAGE-TYPE, X-SMN-MESSAGE-ID, and X-SMN-TOPIC-URN.
--Table 1 HTTP/HTTPS header parameters Parameter
++Table 1 HTTP/HTTPS header fields Parameter
Description
X-SMN-MESSAGE-TYPE
Indicates the message type, which can be:
-- SubscriptionConfirmation
- Notification
- UnsubscribeConfirmation
- SubscriptionConfirmation
- Notification
- UnsubscribeConfirmation
X-SMN-MESSAGE-ID
@@ -28,15 +28,11 @@Indicates the URN of the topic the message belongs to.
X-SMN-SUBSCRIPTION-URN
-Identifies the subscription endpoint.
-This parameter is required only when messages are pushed over HTTP/HTTPS and when you cancel your HTTP/HTTPS subscriptions.
- The HTTP/HTTPS header fields must be in lowercase.
+HTTP/HTTPS Subscription Confirmation Message Format
After you add an HTTP/HTTPS endpoint, SMN sends a subscription confirmation message to the subscriber. The message body is composed of JSON character strings. The subscriber must obtain the subscription URL (subscribe_url) to confirm the subscription. Table 2 describes the JSON field in detail.
@@ -48,7 +44,7 @@type
Indicates the message type. Its value is SubscriptionConfirmation.
+Indicates the message type, which is SubscriptionConfirmation.
signature
@@ -84,7 +80,7 @@signing_cert_url
Indicates the certificate URL for generating the message signature.
+Indicates the certificate URL for a message signature. It can be directly accessed without authentication.
timestamp
@@ -95,16 +91,16 @@The following is an example HTTP/HTTPS subscription confirmation message:@@ -112,13 +108,13 @@{ - "signature": "ViE96uGbBkl+S8eWqgebi5KdmRht2U8+Rs88yuyMHq1k4h3jUkcDZ6HCqTqdpJ8nrLcdqETyyEiOQyTszJdU05z+LhfE8jerCCdSbL4zeInVkydHh0kcCRWmORye0/EuQ/gLC1UIXwvUsqbUCPnBRhNFXOeXMOPPCzK+d04xjy4QHd1H/bHxgsY3AlTe0gCFT068Zru7OK6w9aQaY44mXnN3OWGmBmoHyFab5TRXLSQNz/9u/Vj646cQMMaI0PPQ30QzGYD0MtzgDZi12m8jMTHAnMkTEcbLaEgaqmaoEnATSpEcspFKNXv2skwk7rsVakMOISpMH3+qC6RzhETA2A==", - "topic_urn": "urn:smn:region01:0553db98c800d5192f9bc01232b89622:vpc_status_report_topic", - "message_id": "d86c201092574e71a3ca85826652c58b", +The following is an example HTTP/HTTPS subscription confirmation message:{ + "subscribe_url": "https://console.******.com/smn/subscription/confirm?token=0a419ac94f80f2c62f14c01e34ae5dfcf6b0b92ef46241218eaae5b4cb90d5d423cf104593284665a1f98691b1576976785114fb4408450e8de153b9f1******&topic_urn=urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******®ion=region01®ion_id=region01", + "signature": "W/DQSiqpRkY6En0jNaFtCYOpmUjMhzoJIdMPLhnRv37iPzNhH+SxlievFoUIyS29z7Ig4hL/ECWNfGrRhTqoasiAeOaXOjoRNoQ73YfyqWm7x7OdX+2c202zxaOS5GcsUHohxAS+wCYd6W6aVhx6eQpWzpzLwrGgE+iPmsd5I00HXIBeZEeBx/VuoqkPyBDnSvGNNDTJ2gw+fL7XuKqf/DUUjjI8dkPsp3gAcETe/XMgf3UTMFDvLLrq2fAZVhr/jMR/9m81PwuDs1k9i3iBxT67afzmQ1AhY/a/ayQX7Fmwf/FBpehG1o8e98lXAZFS2nzhvTpttawUFG8Z82******", + "topic_urn": "urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******", + "message_id": "54bb04eddfc842e9b44ca36393f77cd3", "signature_version": "v1", "type": "SubscriptionConfirmation", - "message": "{\"enterpriseProjectId\": \"0\", \"eventTime\": \"2019-08-12 22:40:55.040632\", \"chargingMode\": \"postPaid\", \"cloudserviceType\": \"xxx.service.type.bandwidth\", \"eventType\": 1, \"regionId\": \"region01\", \"tenantId\": \"057eefe55400d2742f8cc0017870ceef\", \"resourceType\": \"xxx.resource.type.bandwidth\", \"resourceSpecCode\": \"19_bgp\", \"resourceSize\": 10, \"resourceId\": \"e091f1b1-08ef-4e2b-a27e-f85e4c19026a\", \"resouceSizeMeasureId\": 15, \"resourceName\": \"elbauto_2019_08_13_06_40_46\"}", - "subscribe_url": "https://console.xxx.com/smn/subscription/unsubscribe?subscription_urn=urn:smn:region01:0553db98c800d5192f9bc01232b89622:vpc_status_report_topic:653e212a43884f7188ca656c537e31ce", - "signing_cert_url": "https://console.xxx.com/smn/SMN_region01_b3974c411807498bb532b3cd6cd65d91.pem", - "timestamp": "2019-08-12T22:40:56Z" + "message": "You are invited to subscribe to topic: urn:smn:regionid:0a419ac94f80f2c62f14c01e34******:test_******. To confirm this subscription, please visit the subscribe_url included in this message. The subscribe_url is valid only within 48 hours.", + "signing_cert_url": "https://smn.region01.******.com/smn/SMN_region01_3190c26a56fb435f9882e3435b******.pem", + "timestamp": "2024-07-10T09:43:44Z" }-Table 3 HTTP/HTTPS notification message body Parameter
Description
+Description
type
Indicates the message type. Its value is Notification.
+Indicates the message type, which is Notification.
signature
@@ -170,36 +166,37 @@The following is an example HTTP(S) notification message:{ - "signature": "ViE96uGbBkl+S8eWqgebi5KdmRht2U8+Rs88yuyMHq1k4h3jUkcDZ6HCqTqdpJ8nrLcdqETyyEiOQyTszJdU05z+LhfE8jerCCdSbL4zeInVkydHh0kcCRWmORye0/EuQ/gLC1UIXwvUsqbUCPnBRhNFXOeXMOPPCzK+d04xjy4QHd1H/bHxgsY3AlTe0gCFT068Zru7OK6w9aQaY44mXnN3OWGmBmoHyFab5TRXLSQNz/9u/Vj646cQMMaI0PPQ30QzGYD0MtzgDZi12m8jMTHAnMkTEcbLaEgaqmaoEnATSpEcspFKNXv2skwk7rsVakMOISpMH3+qC6RzhETA2A==", - "topic_urn": "urn:smn:region01:0553db98c800d5192f9bc01232b89622:vpc_status_report_topic", - "message_id": "d86c201092574e71a3ca85826652c58b", +The following is an example HTTP/HTTPS notification message:{ + "signature": "WmSQ2/0kp2v2u2T33lMqKYrrLxnJoW2NHqIy5QowDuHH3y+HvhCNlCgHDUiAGpb3suCXJm16hWF+EJAYR+tPaTY1q0N3p0p+oBbhlD30fOTxRNsEWRAg73k4qArmQajhdDZOtd57xelQiNhzl2r6iCs0en4kR2iY78zZM/9caZQGBTlNcjkd2lyXYP6aSc7MOgxTsYrRus0A6yipD3zsUA7TvTdfsauAe2hZLR5W0l+um+S3ytT7sA1CMlIJPBXHP5WlqS4iMAeivmufZv7T+G43DbwWfw/seKnK6uFKWd214oqsY2/oLY3C4dcyLdvsy0/7/W8zvxXbgHeSL4******", + "subject": "SMN", + "topic_urn": "urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******", + "message_id": "d84bd6629ef04513ad2e37bffd6e17cb", "signature_version": "v1", "type": "Notification", - "message": "{\"enterpriseProjectId\": \"0\", \"eventTime\": \"2019-08-12 22:40:55.040632\", \"chargingMode\": \"postPaid\", \"cloudserviceType\": \"xxx.service.type.bandwidth\", \"eventType\": 1, \"regionId\": \"region01\", \"tenantId\": \"057eefe55400d2742f8cc0017870ceef\", \"resourceType\": \"xxx.resource.type.bandwidth\", \"resourceSpecCode\": \"19_bgp\", \"resourceSize\": 10, \"resourceId\": \"e091f1b1-08ef-4e2b-a27e-f85e4c19026a\", \"resouceSizeMeasureId\": 15, \"resourceName\": \"elbauto_2019_08_13_06_40_46\"}", - "unsubscribe_url": "https://console.xxx.com/smn/subscription/unsubscribe?subscription_urn=urn:smn:region01:0553db98c800d5192f9bc01232b89622:vpc_status_report_topic:653e212a43884f7188ca656c537e31ce", - "signing_cert_url": "https://console.xxx.com/smn/SMN_region01_b3974c411807498bb532b3cd6cd65d91.pem", - "timestamp": "2019-08-12T22:40:56Z" + "message": "{\"enterpriseProjectId\": \"0\", \"eventTime\": \"2019-08-12 22:40:55.040632\", \"chargingMode\": \"postPaid\", \"cloudserviceType\": \"xxx.service.type.bandwidth\", \"eventType\": 1, \"regionId\": \"region01\", \"tenantId\": \"057eefe55400d2742f8cc00178******\", \"resourceType\": \"xxx.resource.type.bandwidth\", \"resourceSpecCode\": \"19_bgp\", \"resourceSize\": 10, \"resourceId\": \"e091f1b1-08ef-4e2b-a27e-f85e4c******\", \"resouceSizeMeasureId\": 15, \"resourceName\": \"elbauto_2019_08_13_06_40_46\"}", + "unsubscribe_url": "https://console.******.com/smn/subscription/unsubscribe?region=region01®ion_id=region01&subscription_urn=urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******:23cf104593284665a1f98691b1******", + "signing_cert_url": "https://smn.region01.******.com/smn/SMN_region01_3190c26a56fb435f9882e3435b******.pem", + "timestamp": "2024-07-10T09:45:00Z" }HTTP/HTTPS Subscription Cancellation Message Format
After an HTTP/HTTPS subscription is canceled, the subscriber receives a subscription cancellation message sent by SMN. The message body is composed of JSON character strings, which are described in Table 4.
--Table 4 HTTP/HTTPS subscription cancellation message body Parameter
+-Table 4 Parameters of HTTP/HTTPS subscription cancellation message format Parameter
Description
+Description
type
Indicates the message type. Its value is UnsubscribeConfirmation.
+Indicates the message type. Its value is UnsubscribeConfirmation.
signature
Indicates the signature information.
-The signature includes the message, message_id, subscribe_url, timestamp, topic_urn, and type fields. For details about signature verification, see Message Signature Verification.
+The signature includes the message, message_id, subscribe_url, timestamp, topic_urn, and type fields. For details about signature verification, see Message Signature Verification.
topic_urn
@@ -240,16 +237,16 @@The following is an example HTTP(S) message for canceling a subscription:diff --git a/docs/smn/umn/smn_ug_a9003.html b/docs/smn/umn/smn_ug_a9003.html index ff147a148..4d8fdde3a 100644 --- a/docs/smn/umn/smn_ug_a9003.html +++ b/docs/smn/umn/smn_ug_a9003.html @@ -8,15 +8,13 @@{ - "signature": "ViE96uGbBkl+S8eWqgebi5KdmRht2U8+Rs88yuyMHq1k4h3jUkcDZ6HCqTqdpJ8nrLcdqETyyEiOQyTszJdU05z+LhfE8jerCCdSbL4zeInVkydHh0kcCRWmORye0/EuQ/gLC1UIXwvUsqbUCPnBRhNFXOeXMOPPCzK+d04xjy4QHd1H/bHxgsY3AlTe0gCFT068Zru7OK6w9aQaY44mXnN3OWGmBmoHyFab5TRXLSQNz/9u/Vj646cQMMaI0PPQ30QzGYD0MtzgDZi12m8jMTHAnMkTEcbLaEgaqmaoEnATSpEcspFKNXv2skwk7rsVakMOISpMH3+qC6RzhETA2A==", - "topic_urn": "urn:smn:region01:0553db98c800d5192f9bc01232b89622:vpc_status_report_topic", +The following is an example HTTP/HTTPS message for canceling a subscription:{ + "signature": "ViE96uGbBkl+S8eWqgebi5KdmRht2U8+Rs88yuyMHq1k4h3jUkcDZ6HCqTqdpJ8nrLcdqETyyEiOQyTszJdU05z+LhfE8jerCCdSbL4zeInVkydHh0kcCRWmORye0/EuQ/gLC1UIXwvUsqbUCPnBRhNFXOeXMOPPCzK+d04xjy4QHd1H/bHxgsY3AlTe0gCFT068Zru7OK6w9aQaY44mXnN3OWGmBmoHyFab5TRXLSQNz/9u/Vj646cQMMaI0PPQ30QzGYD0MtzgDZi12m8jMTHAnMkTEcbLaEgaqmaoEnATSpEcspFKNXv2skwk7rsVakMOISpMH3+qC6RzhE******", + "topic_urn": "urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******", "message_id": "d86c201092574e71a3ca85826652c58b", "signature_version": "v1", "type": "UnsubscribeConfirmation", - "message": "{\"enterpriseProjectId\": \"0\", \"eventTime\": \"2019-08-12 22:40:55.040632\", \"chargingMode\": \"postPaid\", \"cloudserviceType\": \"xxx.service.type.bandwidth\", \"eventType\": 1, \"regionId\": \"region01\", \"tenantId\": \"057eefe55400d2742f8cc0017870ceef\", \"resourceType\": \"xxx.resource.type.bandwidth\", \"resourceSpecCode\": \"19_bgp\", \"resourceSize\": 10, \"resourceId\": \"e091f1b1-08ef-4e2b-a27e-f85e4c19026a\", \"resouceSizeMeasureId\": 15, \"resourceName\": \"elbauto_2019_08_13_06_40_46\"}", - "subscribe_url": "https://console.xxx.com/smn/subscription/unsubscribe?subscription_urn=urn:smn:region01:0553db98c800d5192f9bc01232b89622:vpc_status_report_topic:653e212a43884f7188ca656c537e31ce", - "signing_cert_url": "https://console.xxx.com/smn/SMN_region01_b3974c411807498bb532b3cd6cd65d91.pem", - "timestamp": "2019-08-12T22:40:56Z" + "message": "You are unsubscribed from topic: urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******. To subscribe to this topic again, please visit the subscribe_url included in this message. The subscribe_url is valid only within 48 hours.", + "subscribe_url": "https://console.******.com/smn/subscription/confirm?token=0a419ac94f80f2c62f14c01e34ae5dfcf6b0b92ef46241218eaae5b4cb90d5d423cf104593284665a1f98691b1576976785114fb4408450e8de153b9f1******&topic_urn=urn:smn:region01:0a419ac94f80f2c62f14c01e34******:test_******®ion=region01®ion_id=region01", + "signing_cert_url": "https://smn.region01.******.com/smn/SMN_region01_3190c26a56fb435f9882e3435b******.pem", + "timestamp": "2024-07-10T11:45:00Z" }- Extract the public key from the X509 certificate for verifying the message reliability and integrity.
- Determine which method will be used to verify the signature based on the message type (the type field in the message).
- Create signature strings. Obtain the signature parameters from the message and sort them in alphabetical order. Each parameter occupies a line, with its value following in the next line.
-Signature Strings for Different Message Types
- Notification messages
- A notification message signature must contain the following parameters (If the value of subject is empty, do not include it in the signature):
message +
diff --git a/docs/smn/umn/smn_ug_a9004.html b/docs/smn/umn/smn_ug_a9004.html index b6d99ddc3..faea0413b 100644 --- a/docs/smn/umn/smn_ug_a9004.html +++ b/docs/smn/umn/smn_ug_a9004.html @@ -1,7 +1,7 @@Signature Strings for Different Message Types
- Notification messages
- A notification message signature must contain the following parameters (If subject is left blank, omit subject in the signature):
message message_id subject timestamp topic_urn type
- - For example, the signature information for a notification message is as follows:-
Each parameter occupies a line, with its value following in the next line.
-message +
- Example signature information for a notification message
message My test message message_id 88c726942175432bac921eafd0036163 @@ -28,6 +26,8 @@ topic_urn urn:smn:regionId:74dc9e44d0cc4573adfce91cdfdd3ba9:xxxx type Notification
+ Each parameter occupies a line, with its value following in the next line.
+
- A notification message signature must contain the following parameters (If subject is left blank, omit subject in the signature):
- Subscription confirmation and subscription cancellation messages
- A subscription confirmation or subscription cancellation message signature must contain the following parameters:
message message_id @@ -36,10 +36,8 @@ timestamp topic_urn type
- For example, the signature information for a subscription confirmation message is as follows:-
Each parameter occupies a line, with its value following in the next line.
-message -You are invited to subscribe to topic: urn:smn:regionId:d91989905b8449b896f3a4f0ad57222d:demo. To confirm this subscription, Please visit the following SubscribeURL in this message. +
- Example signature information for a subscription confirmation message
message +You are invited to subscribe to topic: urn:smn:regionId:d91989905b8449b896f3a4f0ad57222d:demo. To confirm this subscription, please visit the following SubscribeURL in this message. message_id def5c309cbff44d5a870787ed937edf8 subscribe_url @@ -50,6 +48,8 @@ topic_urn urn:smn:regionId:d91989905b8449b896f3a4f0ad57222d:demo type SubscriptionConfirmation
+ Each parameter occupies a line, with its value following in the next line.
+
- Example signature information for a subscription confirmation message
- A subscription confirmation or subscription cancellation message signature must contain the following parameters:
Sample Code
-Java
Verify signing_cert_url, signature that obtained in HTTP/HTTPS Message Format, and message (contained in the message signature) to check the message validity, as shown in the following:
+Java
Verify signing_cert_url, signature that obtained in HTTP or HTTPS Message Format, and message (contained in the message signature) to check the message validity, as shown in the following:
private static void isMessageValid(String signing_cert_url, String signature, Map<String, String> message) { InputStream in = null; @@ -150,9 +150,9 @@ private static String buildNotificationMessage(Map<String, String> msg) 67 68 69 -70const fs = require('fs'); -const crypto = require('crypto'); -const jsrsag = require('jsrsasign'); +70
const fs = require('fs'); +const crypto = require('crypto'); +const jsrsag = require('jsrsasign'); /** * Message signature verification @@ -160,68 +160,67 @@ private static String buildNotificationMessage(Map<String, String> msg) * @param signature: signature to be verified * @param message: content of the message to be verified * @returns {boolean} true: The signature passes the verification. false: The signature fails the verification. - */ -function verifyMessage(pemFile, signature, message) { - const pubPem = fs.readFileSync(pemFile); - const verify = crypto.createVerify(signatureAlgorithm(pubPem)); - verify.update(buildSignMessage(message)); - const verifyResult = verify.verify(pubPem, signature, 'base64'); - if (verifyResult) { - console.log("verify success"); - return true; - } else { - console.log('verify failed, result: ' + verifyResult); - return false; - } -} + */ +function verifyMessage(pemFile, signature, message) { + const pubPem = fs.readFileSync(pemFile); + const verify = crypto.createVerify(signatureAlgorithm(pubPem)); + verify.update(buildSignMessage(message)); + const verifyResult = verify.verify(pubPem, signature, 'base64'); + if (verifyResult) { + console.log("verify success"); + return true; + } else { + console.log('verify failed, result: ' + verifyResult); + return false; + } +} /** * Obtain the signature algorithm from the certificate. - */ -function signatureAlgorithm(pubPem) { - const certObject = new jsrsag.X509(); - certObject.readCertPEM(pubPem.toString()); - let algorithm = certObject.getSignatureAlgorithmField(); - if (algorithm.split('with').length > 1) { - algorithm = algorithm.split('with')[1] + '-' + algorithm.split('with')[0]; - } - return algorithm; -} + */ +function signatureAlgorithm(pubPem) { + const certObject = new jsrsag.X509(); + certObject.readCertPEM(pubPem.toString()); + let algorithm = certObject.getSignatureAlgorithmField(); + if (algorithm.split('with').length > 1) { + algorithm = algorithm.split('with')[1] + '-' + algorithm.split('with')[0]; + } + return algorithm; +} -function buildSignMessage(msg) { - const type = msg.type; - let message = ''; - if (type === 'Notification') { - message = buildNotificationMessage(msg); - } else if (type === 'SubscriptionConfirmation') { - message = buildSubscriptionMessage(msg); - } - return message; -} +function buildSignMessage(msg) { + const type = msg.type; + let message = ''; + if (type === 'Notification') { + message = buildNotificationMessage(msg); + } else if (type === 'SubscriptionConfirmation') { + message = buildSubscriptionMessage(msg); + } + return message; +} -function buildNotificationMessage(msg) { - let signMessage = 'message\n' + msg.message + '\n'; - signMessage += 'message_id\n' + msg.message_id + '\n'; - if (msg.subject) { - signMessage += 'subject\n' + msg.subject + '\n'; - } - signMessage += 'timestamp\n' + msg.timestamp + '\n'; - signMessage += 'topic_urn\n' + msg.topic_urn + '\n'; - signMessage += 'type\n' + msg.type + '\n'; - return signMessage; -} +function buildNotificationMessage(msg) { + let signMessage = 'message\n' + msg.message + '\n'; + signMessage += 'message_id\n' + msg.message_id + '\n'; + if (msg.subject) { + signMessage += 'subject\n' + msg.subject + '\n'; + } + signMessage += 'timestamp\n' + msg.timestamp + '\n'; + signMessage += 'topic_urn\n' + msg.topic_urn + '\n'; + signMessage += 'type\n' + msg.type + '\n'; + return signMessage; +} -function buildSubscriptionMessage(msg) { - let signMessage = 'message\n' + msg.message + '\n'; - signMessage += 'message_id\n' + msg.message_id + '\n'; - signMessage += 'subscribe_url\n' + msg.subscribe_url + '\n'; - signMessage += 'timestamp\n' + msg.timestamp + '\n'; - signMessage += 'topic_urn\n' + msg.topic_urn + '\n'; - signMessage += 'type\n' + msg.type + '\n'; - return signMessage; -} +function buildSubscriptionMessage(msg) { + let signMessage = 'message\n' + msg.message + '\n'; + signMessage += 'message_id\n' + msg.message_id + '\n'; + signMessage += 'subscribe_url\n' + msg.subscribe_url + '\n'; + signMessage += 'timestamp\n' + msg.timestamp + '\n'; + signMessage += 'topic_urn\n' + msg.topic_urn + '\n'; + signMessage += 'type\n' + msg.type + '\n'; + return signMessage; +}
- Notification messages
- A notification message signature must contain the following parameters (If the value of subject is empty, do not include it in the signature):
diff --git a/docs/smn/umn/smn_ug_b0000.html b/docs/smn/umn/smn_ug_b0000.html index ef7a2d602..c7cac587d 100644 --- a/docs/smn/umn/smn_ug_b0000.html +++ b/docs/smn/umn/smn_ug_b0000.html @@ -2,13 +2,30 @@ The sample code has passed the test on Nodejs v14.17.5.
Change History
-Released On
+Released On
Description
2019-09-30
+2024-07-31
+- Added the description of the FunctionGraph (function) protocol.
- Deleted X-SMN-SUBSCRIPTION-URN from HTTP or HTTPS Message Format.
2023-05-16
+This issue incorporates the following change:
+Removed DMS from supported protocols.
+2023-03-31
+This issue incorporates the following changes:
+- Added Permissions in Service Overview.
- Added Permissions Management in Simple Message Notification User Guide.
2019-09-30
This issue incorporates the following change:
Modified the tag character set to support the at sign (@).
@@ -57,7 +74,7 @@2018-03-30
This issue incorporates the following change:
-Added the DMS subscription protocol.
+Added the DMS subscription protocol.
2018-01-30
@@ -75,7 +92,7 @@2017-05-30
This issue incorporates the following changes:
-- Removed the Publish Message button from the Topic page.
- Disallowed line breaks in a topic display name.
- Removed the Publish Message button from the Topic page.
- Disallowed line breaks in a topic display name.
2017-03-30
Permissions
++You can use Identity and Access Management (IAM) to manage SMN permissions and control access to your resources. IAM provides identity authentication, permissions management, and access control.
+You can create IAM users for your employees and assign permissions to these users on a principle of least privilege (PoLP) basis to control their access to specific resource types. For example, you can create IAM users for software developers and assign specific permissions to allow them to use SMN resources but prevent them from being able to delete resources or perform any high-risk operations.
+If your account does not require individual IAM users for permissions management, skip this section.
+IAM can be used free of charge. You pay only for the resources in your account.
+For more information about IAM, see IAM Service Overview.
++SMN Permissions
By default, new IAM users do not have any permissions assigned. To assign permissions to these new users, add them to one or more groups and attach permissions policies or roles to these groups.
+SMN is a project-level service deployed and accessed in specific physical regions. When assigning SMN permissions to a user group, specify region-specific projects where the permissions will take effect. If you select All projects, the permissions will be granted for all region-specific projects. When accessing SMN, the users need to switch to a region where they have been authorized to use this service.
+You can grant users permissions by using roles and policies.
+Table 1 lists all system-defined policies supported by SMN. +++
+Table 1 System-defined policies supported by SMN Role/Policy Name
+Description
+Type
+Dependency
+SMN Administrator
+Has all permissions for SMN resources.
+System-defined role
+The Tenant Guest and SMN Administrator roles need to be assigned in the same project.
+SMN FullAccess
+Administrator permissions for SMN. Users granted these permissions can perform all operations on SMN resources.
+System-defined policy
+None
+SMN ReadOnlyAccess
+Read-only permissions for SMN.
+Users granted these permissions can only view SMN data.
+System-defined policy
+None
+Table 2 lists the common operations supported by each SMN system policy or role. Select the policies or roles as needed.
+ ++
+Table 2 Common operations supported by each system-defined policy or role of SMN Operation
+Fine-Grained Action
+SMN Administrator
+SMN FullAccess
+SMN ReadOnlyAccess
+Dependency
+Creating a topic
+smn:topic:create
+√
+√
+×
+None
+Updating a topic
+smn:topic:update
+√
+√
+×
+smn:topic:list
+Deleting a topic
+smn:topic:delete
+√
+√
+×
+smn:topic:list
+Querying topics
+smn:topic:list
+√
+√
+√
+None
+Adding a subscription to a topic
+smn:topic:update
+√
+√
+×
+smn:topic:list
+Configuring topic policies
+smn:topic:update
+√
+√
+×
+smn:topic:list
+Publishing a message
+smn:topic:publish
+√
+√
+×
+smn:topic:list
+Adding a subscription
+smn:topic:update
+√
+√
+×
+smn:topic:list
+Requesting subscription confirmation
+smn:topic:update
+√
+√
+×
+smn:topic:list
+Deleting a subscription
+smn:topic:update
+√
+√
+×
+smn:topic:list
+Querying subscriptions
+smn:topic:list
+√
+√
+√
+None
+Creating a message template
+smn:template:create
+√
+√
+×
+None
+Modifying a message template
+smn:template:update
+√
+√
+×
+smn:template:list
+Deleting a message template
+smn:template:delete
+√
+√
+×
+smn:template:list
+Querying a message template
+smn:template:list
+√
+√
+√
+None
+Adding a tag
+smn:tag:create
+√
+√
+×
+smn:topic:list
+Updating a tag
+smn:tag:update
+√
+√
+×
+Deleting a tag
+smn:tag:delete
+√
+√
+×
+Querying tags
+smn:tag:list
+√
+√
+√
+smn:topic:list
+++ diff --git a/docs/smn/umn/smn_ug_0035.html b/docs/smn/umn/smn_ug_0035.html new file mode 100644 index 000000000..61129bc0c --- /dev/null +++ b/docs/smn/umn/smn_ug_0035.html @@ -0,0 +1,13 @@ + + +++Parent topic: Overview+Permissions Management
+ + + diff --git a/docs/smn/umn/smn_ug_0037.html b/docs/smn/umn/smn_ug_0037.html new file mode 100644 index 000000000..538f34c75 --- /dev/null +++ b/docs/smn/umn/smn_ug_0037.html @@ -0,0 +1,24 @@ + + +Creating a User and Granting SMN Permissions
++Use IAM to implement fine-grained permissions control over your SMN resources. With IAM, you can:
+If your account does not require individual IAM users, skip this chapter.
+This section describes the procedure for granting permissions (see Figure 1).
++Prerequisites
Learn about the system permissions (see Permissions) supported by SMN and choose policies or roles according to your requirements. For system permissions of other cloud services, see Permissions.
++Process Flow
The following describes how to grant the SMN ReadOnlyAccess permissions.
+ +++ diff --git a/docs/smn/umn/smn_ug_0038.html b/docs/smn/umn/smn_ug_0038.html new file mode 100644 index 000000000..85f55ef9e --- /dev/null +++ b/docs/smn/umn/smn_ug_0038.html @@ -0,0 +1,66 @@ + + +++Parent topic: Permissions Management+Creating SMN Custom Policies
++You can create custom policies to supplement the system-defined policies of SMN. For the actions supported by custom policies, see section "Permissions Policies and Supported Actions" in Simple Message Notification API Reference.
+You can create custom policies in either of the following ways:
+The following are examples of custom policies created for SMN. .
++Example SMN Custom Policies
++ diff --git a/docs/smn/umn/smn_ug_42000.html b/docs/smn/umn/smn_ug_42000.html index be60e1fe9..e6e199b8d 100644 --- a/docs/smn/umn/smn_ug_42000.html +++ b/docs/smn/umn/smn_ug_42000.html @@ -3,12 +3,11 @@++Parent topic: Permissions Management+Modifying the Display Name of a Topic
-Scenarios
You have created a topic and want to modify its display name.
To Modify the Topic Display Name
- SMS: Enter one or more valid phone numbers.
- Click
- Management console
- Modifying the Display Name of a Topic
