检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对
异常响应 异常响应要素说明 名称 参数类型 说明 request_id String 请求的ID code String 参考错误码 message String 参考错误码 异常响应举例 { "request_id": "aad0860d089c482b943971f802a6718e"
通用请求返回值 异常响应 状态码 父主题: 附录
状态码 表1 正常返回值 返回值 说明 200 任务提交成功 201 创建成功 表2 异常返回值 返回值 说明 400 Bad Request 请求参数错误。 401 Unauthorized 鉴权失败。 403 Forbidden 没有权限对资源访问。 404 Not Found
JSON格式主要用来处理用户想对不同的订阅者类型发送不同的消息,目前支持的协议Default、HTTP、HTTPS、email、FunctionGraph(函数)、FunctionGraph(工作流),其中Default是必须的,Email的内容将发给邮件类型的订阅者,其它协议依次如下所示:
添加订阅时,用户可以根据需要选择不同的传输协议,每种协议对应不同类型的订阅者,具体对应关系如下所示: 邮件传输协议,订阅者为邮箱地址。 短信传输协议,订阅者为手机号码。 HTTP/HTTPS传输协议,订阅者为URL。 FunctionGraph(函数)传输协议,订阅者为一个函数。 FunctionGraph(工
单个主题是否支持通过多种传输协议进行订阅? 单个主题支持多种传输协议定义,目前支持HTTP/HTTPS、邮件、FunctionGraph(函数)、FunctionGraph(工作流)以及短信传输协议。
com/notification/action 选择“FunctionGraph(函数)”终端,表示订阅终端是一个函数,单击输入框右侧的选择订阅终端,在“版本”的下拉框中选择可用版本。 选择“FunctionGraph(工作流)”终端,表示订阅终端是一组函数编排成的工作流,单击输入框右侧的选择订阅终端。 选择“语音通知”终端,请输入有效电话号码。
f8465"}] } 表2 字段说明 字段配置项 类型 说明 records JSON对象 消息列表 event_version String 版本 topic_urn String 主题URN type String 消息类型 message String 消息内容 timestamp
查询订阅者列表 功能介绍 分页返回请求者的所有的订阅列表,订阅列表按照订阅创建时间进行升序排列。分页查询可以指定offset以及limit。如果订阅者不存在,返回空列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/notifications/subscriptions
“functiongraph” FunctionGraph(函数)传输协议,endpoint为一个函数 “functionstage”:。FunctionStage(工作流)传输协议,endpoint为一个函数工作流 “http”、“https”:HTTP/HTTPS传输协议,endpoint为URL。
smn_protocol。 当“类型”取值为“String Array”时,输入限定发布消息的数组名称。 当“类型”取值为“String”时,输入限定发布消息的字符串名称。 值 当“类型”取值为“协议”时,在下拉框中选择需要限定消息发布的协议类型,提供的选项为“短信”、“邮件”、
消息以HTTP/HTTPS请求的形式发送到订阅的URL,目前只支持公网域名或者公网IP地址。 “FunctionGraph(函数)”:使用已发布的消息的负载调用订阅的FunctionGraph(函数)终端。 “FunctionGraph(工作流)”:使用已发布的消息触发执行订阅的FunctionGraph(工作流)终端。
essage_template 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,偏移量为一个大于0
应用场景 系统告警 系统告警是由预定义阈值触发的通知,通过邮件、短信、FunctionGraph(函数)、HTTP和HTTPS等多种通知方式发送给特定用户。举例来说,很多云服务都使用SMN,从而可使您在事件发生(如云审计服务检测到云服务资源发生关键操作)时能立即接收到通知。 与云服务的集成
景下,可能会出现Topic数量超过3000仍创建成功的情况,此为正常现象。 接口是幂等的,接口调用返回成功时,若已存在同名的Topic,返回的status code为200,否则返回的status code为201 调用方法 请参见如何调用API。 URI POST /v2/{p
Topic不存在订阅者,返回空列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/notifications/topics/{topic_urn}/subscriptions 表1 路径参数 参数 是否必选 参数类型 描述 project_id
smn_protocol。 当“类型”取值为“String Array”时,输入限定发布消息的数组名称。 当“类型”取值为“String”时,输入限定发布消息的字符串名称。 值 当“类型”取值为“协议”时,在下拉框中选择需要限定消息发布的协议类型,提供的选项为“短信”、“邮件”、
com/notification/action 选择“FunctionGraph(函数)”终端,表示订阅终端是一个函数,单击输入框右侧的选择订阅终端,在“版本”的下拉框中选择可用版本。 选择“FunctionGraph(工作流)”终端,表示订阅终端是一组函数编排成的工作流,单击输入框右侧的选择订阅终端。 选择“语音通知”终端,请输入有效电话号码。
“functionstage”:FunctionGraph(函数)传输协议,endpoint为一个函数。 “functiongraph”:FunctionGraph(工作流)传输协议,endpoint为由一组函数编排成的工作流。 “http”、“https”:HTTP/HTT