检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
授权操作与SMN接口的映射关系 表1 授权操作与SMN接口的映射关系 授权操作 接口名称 接口功能 SMN:UpdateTopic UpdateTopic 修改主题的属性,目前仅支持修改topic的display_name字段。 SMN:DeleteTopic DeleteTopic
如何调用API 构造请求 认证鉴权 返回结果
起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创
与其他服务的关系 其他云服务可以集成SMN,为云服务提供事件通知的能力,使这些服务可以向租户或者消息处理系统发送事件通知。对接SMN的云服务使用SMN的详细信息请参见相应服务的用户指南。 现列举几个云服务使用SMN的例子,如图1所示。 图1 消息通知服务与其他服务的关系示意图 表1
短信传输协议,订阅者为手机号码。 HTTP/HTTPS传输协议,订阅者为URL。 FunctionGraph(函数)传输协议,订阅者为一个函数。 FunctionGraph(工作流)传输协议,订阅者为由一组函数编排成的工作流。 主题 主题是消息发布或客户端订阅通知的特定事件类型。它作为发送消息和订阅
及limit。如果不存在模板,则返回空列表。额外的查询参数分别有message_template_name和protocol。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/notifications/message_template 表1 路径参数
查询消息模板详情 功能介绍 查询模板详情,包括模板内容。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/notifications/message_template/{message_template_id} 表1 路径参数 参数 是否必选 参数类型
分页获取特定Topic的订阅列表,订阅列表按照订阅创建时间进行升序排列。分页查询可以指定offset以及limit。如果指定Topic不存在订阅者,返回空列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/notifications/topics/{topic_urn}/subscriptions
com/notification/action 选择“FunctionGraph(函数)”终端,表示订阅终端是一个函数,单击输入框右侧的选择订阅终端,在“版本”的下拉框中选择可用版本。 选择“FunctionGraph(工作流)”终端,表示订阅终端是一组函数编排成的工作流,单击输入框右侧的选择订阅终端。 选择“语音通知”终端,请输入有效电话号码。
快速入门 操作场景 本节通过调用一系列SMN的API实现通过主题发布消息。 API的调用方法请参见如何调用API。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。 涉及API 当您使用Token认证方式完成
分页返回请求者的所有的订阅列表,订阅列表按照订阅创建时间进行升序排列。分页查询可以指定offset以及limit。如果订阅者不存在,返回空列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/notifications/subscriptions 表1 路径参数
单个主题是否支持通过多种传输协议进行订阅? 单个主题支持多种传输协议定义,目前支持HTTP/HTTPS、邮件、FunctionGraph(函数)、FunctionGraph(工作流)以及短信传输协议。
com/notification/action 选择“FunctionGraph(函数)”终端,表示订阅终端是一个函数,单击输入框右侧的选择订阅终端,在“版本”的下拉框中选择可用版本。 选择“FunctionGraph(工作流)”终端,表示订阅终端是一组函数编排成的工作流,单击输入框右侧的选择订阅终端。 选择“语音通知”终端,请输入有效电话号码。
“functiongraph” FunctionGraph(函数)传输协议,endpoint为一个函数 “functionstage”:。FunctionStage(工作流)传输协议,endpoint为一个函数工作流 “http”、“https”:HTTP/HTTPS传输协议,endpoint为URL。
应用场景 系统告警 系统告警是由预定义阈值触发的通知,通过邮件、短信、FunctionGraph(函数)、HTTP和HTTPS等多种通知方式发送给特定用户。举例来说,很多云服务都使用SMN,从而可使您在事件发生(如云审计服务检测到云服务资源发生关键操作)时能立即接收到通知。 与云服务的集成
JSON格式主要用来处理用户想对不同的订阅者类型发送不同的消息,目前支持的协议Default、HTTP、HTTPS、email、FunctionGraph(函数)、FunctionGraph(工作流),其中Default是必须的,Email的内容将发给邮件类型的订阅者,其它协议依次如下所示: {
邮件和HTTP(S)终端收到的消息包含:消息主题、消息内容和取消订阅的链接。 短信终端接收到的消息只包含消息内容。 FunctionGraph(函数)终端收到的消息包含消息属性、消息标题、消息内容、主题URN等信息。消息样例类似如下。字段说明如表1所示。 { "record":
消息以HTTP/HTTPS请求的形式发送到订阅的URL,目前只支持公网域名或者公网IP地址。 “FunctionGraph(函数)”:使用已发布的消息的负载调用订阅的FunctionGraph(函数)终端。 “FunctionGraph(工作流)”:使用已发布的消息触发执行订阅的FunctionGraph(工作流)终端。