通知系统SNS核心分为三部分，主题（Topic)，平台（Application Platform），接收端（Application Endpoint）

• 主题（Topic)：用于接收信息的通道。例如ZWatch可以将报警消息发送到某个主题，由主题分发给订阅的接收端。
• 平台（Application Platform）：某些接收端需要通过平台发送信息，例如邮件接收端需要邮件服务器发送邮件，邮件服务器就被抽象成平台。目前只有邮件服务器和系统平台两种平台。系统平台用于给不需要平台的接收端（如钉钉和HTTP应用）发送信息
• 接收端（Application Endpoint）：用于接收信息的终端，目前包含系统/邮箱/钉钉/HTTP应用/短信/Microsoft Teams。接收端只有订阅了主题后，才能接收到发送到该主题的信息。

当外部系统（如ZWatch）发送信息到主题后，主题会查找所有订阅该主题的接收端，然后通过该接收端所属的平台将信息发送出去。例如某个邮件接收端（邮箱地址）订阅了某个报警主题，当该报警主题接收到一条报警信息后，会通过该邮件接收端所属的平台（邮件服务器），发送报警邮件到该接收端代表的邮箱地址。

用户可以使用ChangeSNSTopicState启用/停用一个主题，主题停用后，发送到该主题的消息自动忽略，不会分发到订阅的接收端。

ChangeSNSTopicState uuid=e034cef9ad3d43e0b3f9c0a316a0f25a stateEvent=disable

用户可以使用QuerySNSTopic查询主题：

QuerySNSTopic uuid=b86c9016b4f24953a9edefb53ca0678c

用户可以使用CreateSNSEmailPlatform创建一个邮箱服务器（平台）：

CreateSNSEmailPlatform name=my-sftp-server smtpServer=mail.zstack.org smtpPort=25 username=support@zstack.io password=password

{
    "inventory": {
        "createDate": "Jan 25, 2018 8:43:32 PM",
        "lastOpDate": "Jan 25, 2018 8:43:32 PM",
        "name": "my-sftp-server",
        "smtpPort": 25,
        "smtpServer": "mail.zstack.org",
        "state": "Enabled",
        "type": "Email",
        "username": "support@zstack.io",
        "uuid": "bec03e2d93224c7381782833e8b685ca"
    },
    "success": true
}

用户可以使用ValidateSNSEmailPlatform测试邮箱服务器是否可用

ValidateSNSEmailPlatform uuid=bec03e2d93224c7381782833e8b685ca

用户可以使用QuerySNSApplicationPlatform查询应用平台：

QuerySNSApplicationPlatform uuid=b3454k6ll687h23345jh24hk5

用户可以使用ChangeSNSApplicationPlatformState启用/停用应用平台。当应用平台停用后，不能再通过该平台发送邮件给接收端。

ChangeSNSApplicationPlatformState uuid=bec03e2d93224c7381782833e8b685ca stateEvent=disable

用户可以使用CreateSNSEmailEndpoint创建一个邮箱接收端：

CreateSNSEmailEndpoint name=operator email=operator@zstack.org

{
    "inventory": {
        "createDate": "Jan 25, 2018 8:57:14 PM",
        "email": "operator@zstack.org",
        "lastOpDate": "Jan 25, 2018 8:57:14 PM",
        "name": "operator",
        "platformUuid": "bec03e2d93224c7381782833e8b685ca",
        "state": "Enabled",
        "type": "Email",
        "uuid": "b03b125230b0406ea198919954ae3928"
    },
    "success": true
}

用户可以使用CreateSNSHttpEndpoint创建HTTP应用接收端

CreateSNSHttpEndpoint name=http url=http://localhost:8080/webhook-url username=url-username password=url-password

{
    "inventory": {
        "createDate": "Jan 25, 2018 9:01:30 PM",
        "lastOpDate": "Jan 25, 2018 9:01:30 PM",
        "name": "http",
        "platformUuid": "02d24b9b0a7f4ee1846f15cda248ceb7",
        "state": "Enabled",
        "type": "HTTP",
        "url": "http://localhost:8080/webhook-url",
        "username": "url-username",
        "uuid": "d9d8186eeed245e0b18ec8deef185fb7"
    },
    "success": true
}

钉钉接收端采用钉钉机器人，用户可以使用CreateSNSDingTalkEndpoint创建钉钉接收端：

CreateSNSDingTalkEndpoint name=dingding url=https://oapi.dingtalk.com/robot/send?access_token=128f268950234c6c2f065fe88be6cc26d780e9d9863d63eae12be831605345 atPersonPhoneNumbers=+86-12900010002,+86-13977889933

{
    "inventory": {
        "atAll": false,
        "atPersonPhoneNumbers": [
            "+86-12900010002",
            "+86-13977889933"
        ],
        "createDate": "Jan 25, 2018 9:11:00 PM",
        "lastOpDate": "Jan 25, 2018 9:11:00 PM",
        "name": "dingding",
        "platformUuid": "02d24b9b0a7f4ee1846f15cda248ceb7",
        "state": "Enabled",
        "type": "DingTalk",
        "url": "https://oapi.dingtalk.com/robot/send?access_token=128f268950234c6c2f065fe88be6cc26d780e9d9863d63eae12be831605345",
        "uuid": "2663ecb5356a4fbeb6cde202b2e6eaf1"
    },
    "success": true
}

用户可以使用UpdateSNSApplicationEndpoint更新一个接收端的名字和描述信息。如果要更新接收端的特定字段（如url,email），删除再重建该接收端。

UpdateSNSApplicationEndpoint uuid=2663ecb5356a4fbeb6cde202b2e6eaf1 name=my-endpoint

用户可以使用QuerySNSApplicationEndpoint查询报警器：

QuerySNSApplicationEndpoint

用户可以使用SubscribeSNSTopic将一个接收端订阅到一个主题。订阅完成后，发送到该主题的消息会自动发送给接收端。

SubscribeSNSTopic endpointUuid=b03b125230b0406ea198919954ae3928 topicUuid=e034cef9ad3d43e0b3f9c0a316a0f25a

用户可以用QuerySNSTopicSubscriber查看有哪些endpoint订阅了某个主题：

QuerySNSTopicSubscriber topicUuid=71efab26b4f84a62b001ec9b222efe47

用户可以使用UnsubscribeSNSTopic退订一个主题：

UnsubscribeSNSTopic endpointUuid=b03b125230b0406ea198919954ae3928 topicUuid=e034cef9ad3d43e0b3f9c0a316a0f25a

SNS内置一些系统主题，一些预定义的消息会发送到系统主题，用户可以直接订阅这些主题以获得感兴趣的信息。

QuerySNSTopic  name=system-alarm

{
    "inventories": [
        {
            "createDate": "Jan 10, 2018 12:11:09 AM",
            "description": "topic for reporting system defined alarms",
            "lastOpDate": "Jan 10, 2018 12:11:09 AM",
            "name": "system-alarm",
            "state": "Enabled",
            "uuid": "e7d6f5e23bb74e99a2777126078b551c"
        }
    ],
    "success": true
}

ZWatch预定义的报警器会将报警信息发送到该主题。用户也可以直接使用该主题作为自定义报警器的主题。

sns.systemTopic.endpoints.http.url = 接收POST消息的HTTP URL
sns.systemTopic.endpoints.http.url.username = HTTP请求用户名（可选）
sns.systemTopic.endpoints.http.url.password = HTTP请求密码（可选）

QuerySNSTopic  name=system-alarm

{
    "inventories": [
        {
            "createDate": "Jan 10, 2018 12:11:09 AM",
            "description": "the topic to publish API requests and responses",
            "lastOpDate": "Jan 10, 2018 12:11:09 AM",
            "name": "api",
            "state": "Enabled",
            "uuid": "7bfa0eb8555b3528ace936edfd1d74f1"
        }
    ],
    "success": true
}

云平台会将所有API请求和返回发送到该主题，用户可以订阅该主题获得API的调用情况。该主题只能被HTTP接收端订阅，接收端收到的消息将会是API的JSON格式文本。