• API White Paper

wp
  1. Help Center
  2. API White Paper
  3. API Reference
  4. Open Telekom Cloud API Overview
  5. Open Telekom Cloud SMN API Overview
  6. Application Scenarios

Application Scenarios

SMN provides APIs for topic management, subscription management, template management, and message publishing. Tenants can manage subscription terminals through topic API and subscription management API, manage message templates through template management API, and publish messages through message publishing API. API Gateway controls whether SMN APIs are open to tenants, and tenants access SMN APIs through API Gateway. The following figure shows the SMN APIs.

NOTE:

API Gateway only checks parameter validity of APIs and does not convert models to ensure that Open Telekom Cloud APIs are compatible with native OpenStack APIs. However, Combined API encapsulates and enhances cloud service APIs. The enhanced APIs are independent of native OpenStack APIs and do not affect native OpenStack API compatibility.

API Gateway

API Gateway, as the access gateway for OpenStack APIs and Combined API, is in charge of external access control of API capabilities. For example:

  • API life cycle management (publish/unpublished)

    API Gateway controls whether APIs are published by API registration.

  • API flow control (throttling)

    For security purposes, the SMN service limits the total times users can call the open APIs within a specified period. The API flow control methods are as follows:

    • SMN controls the total calls to APIs based on their weights (system resource consumption). For example, the weight of VM creation or deletion is greater than that of VM query. Therefore, the control of the total calls to APIs is different.
    • Users can control the upper limit of calls made to all APIs within a specified period.
  • API monitoring and operation log

    To improve system security when users call SMN APIs and use the SMN service, API Gateway provides monitoring and operation logs to assist O&M and analysis. These logs are open to O&M personnel currently.

SMN API Description

  • SMN provides the following APIs:
    • API for creating a topic: Tenants can use this API to create a topic and publish messages through the topic.
    • API for querying the topic list: Tenants can use this API to query created topic lists.
    • API for deleting a topic: Tenants can use this API to delete the specified topic.
    • API for modifying a topic attribute: A tenant can use this API to modify topic attributes. Currently, only the access_policy attribute can be modified. This attribute authorizes topic permissions to other tenants.
    • API for adding a subscriber: Tenants can use this API to add a subscriber.
    • API for deleting a subscriber: Tenants can use this API to delete a subscriber.
    • API for creating a template: Tenants can use this API to create a template.
    • API for viewing a template list: Tenants can use this API to query created template lists.
    • API for modifying a template: Tenants can use this API to modify a template.
    • API for deleting a template: Tenants can use this API to delete a template.
  • SMN provides the following APIs:
    • API for publishing a message: Tenants can use this API to publish a common, structured, or template message to a topic.
    • API for directly publishing an SMS message: Tenants can use this API to directly send an SMS message to a mobile number.