Endpoint

You can use different endpoints to subscribe to topics. Currently, the supported endpoint types include system endpoint, email, DingTalk, HTTP application, short message service, and Microsoft Teams.
  • By default, the Cloud provides a system endpoint. If an alarm binds a system endpoint, you are prompted for alarm notifications displayed near the Messages button at the upper right in the UI.
  • You can also create an email, DingTalk, HTTP application, short message service, or Microsoft Teams endpoint as needed.

Create Email Endpoint

  • Messages that send to topics will be sent to a specified email address via an email server.
  • You can either create an SNS text template in advance or use a system template. Alarm messages will be sent to your email with a unified format.
  • You need to add an email server in advance under the current zone, and test whether the email server can work properly.
In the navigation pane of the ZStack Private Cloud UI, choose Platform O&M > Notification Service > Endpoint. On the Endpoint page, click Create Endpoint. On the displayed Create Endpoint page, set the following parameters:
  • Name: Enter a name for the endpoint.
  • Description: Optional. Enter a description for the endpoint.
  • Endpoint Type: Select Email.
  • Email Address: Enter an email address. A maximum of 100 emails are supported.
  • Email Server: Select an email server that you added. For more information about how to add an email server, see Email Server.
  • Validate: Test whether the email server can work properly.
You can create an email endpoint, as shown in Create Email Endpoint.
Figure 1. Create Email Endpoint


Create DingTalk Endpoint

  • Messages that send to topics will be sent to a specified DingTalk robot address via DingTalk. If you appoint members, alarm notifications will be sent to corresponding DingTalk members via phone numbers.
  • You can either create an SNS text template in advance or use a system template. Alarm messages will be sent to your DingTalk group with a unified format.
  • If you set an SNS text template in DingTalk, follow the Markdown syntax. Currently, DingTalk only supports a subset of Markdown syntax.
  • Name: Enter a name for the endpoint.
  • Description: Optional. Enter a description for the endpoint.
  • Endpoint Type: Select DingTalk.
  • WebHook URL: Enter a DingTalk robot address.
  • Member: Specify nobody, specify all members in a group, or appoint members.
    Note: If you appoint members, alarm notifications will be sent to the corresponding members via phone numbers, such as +86-13800000000.
You can create a DingTalk endpoint, as shown in Create DingTalk Endpoint.
Figure 2. Create DingTalk Endpoint


Create HTTP Application Endpoint

  • Messages that send to topics will be sent to a specified HTTP address via HTTP POST.
  • If the specified HTTP application cannot be accessed without a user name and password, enter accurately the user name and the password.
  • Name: Enter a name for the endpoint.
  • Description: Optional. Enter a description for the endpoint.
  • Endpoint Type: Select HTTP Application.
  • URL Address: Enter an HTTP service address.
  • User Name: Optional. If the specified HTTP application cannot be accessed without a user name and password, enter accurately the user name.
  • Password: Optional. Enter accurately the corresponding password.
You can create an HTTP application endpoint, as shown in Create HTTP Application Endpoint.
Figure 3. Create HTTP Application Endpoint


Create Short Message Service Endpoint

  • Messages that send to topics will be sent to a specified phone number via short message service.
  • You can create an SNS text template in advance and set it as the default template. Alarm short messages will be sent to your phone according to the template that you set.
  • Name: Enter a name for the endpoint.
  • Description: Optional. Enter a description for the endpoint.
  • Endpoint Type: Select short message service.
  • AccessKey: Select a third-party AccessKey that you added.
  • Phone Number: Enter a phone number that can receive short messages.
You can create a short message service endpoint, as shown in Create Short Message Service Endpoint.
Figure 4. Create Short Message Service Endpoint


Create Microsoft Teams Endpoint

  • Messages that send to topics will be sent to a specified Microsoft Teams group via Webhook.
  • You can either create an SNS text template in advance or use a system template. Alarm messages will be sent to your Microsoft Teams group with a unified format.
  • Name: Enter a name for the endpoint.
  • Description: Optional. Enter a description for the endpoint.
  • Endpoint Type: Select Microsoft Teams.
  • WebHook URL: Enter the webhook URL you obtained from Microsoft Teams.
You can create a Microsoft Teams endpoint, as shown in Figure 5.
Figure 5. Create Microsoft Teams Endpoint


Endpoint Operations

You can perform the following operations on an endpoint:
  • Create: Create an endpoint.
  • Enable: Enable an endpoint that has been stopped.
  • Disable: Disable a running endpoint.
  • Add alarm: Add an alarm to the endpoint that you selected.
  • Remove alarm: Remove an alarm from the endpoint.
  • Delete: Delete an endpoint.
  • Change name and description: Change a name and description for the endpoint.
  • Receive message: Set a time range to check message logs of the endpoint within the time range.
  • Audit: Check related operations of this endpoint.