Updated on 2023-12-25 GMT+08:00

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, FunctionGraph (function), Email, HTTP, and HTTPS.

Publisher

A publisher sends messages to a topic.

Subscriber

A subscriber receives messages delivered from a topic.

When adding a subscription, you can choose protocols as required:

  • 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 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.

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.