检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 通过使用消息通知服务所提供的接口,您可以完整的使用消息通知服务的所有功能。例如创建Topic、添加订阅。 表1 接口说明 类型 说明 主题操作 包含创建主题、更新主题、删除主题等接口。 订阅操作 包含查询订阅列表、订阅、取消订阅等接口。 模板操作 包含创建消息模板、更新消息模板
批量删除订阅过滤策略 功能介绍 删除订阅者的消息过滤策略。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/notifications/subscriptions/filter_polices 表1 路径参数 参数 是否必选 参数类型 描述
记录消息通知服务 记录消息通知服务简介 支持审计的关键操作列表 查询审计事件
批量更新订阅过滤策略 功能介绍 更新订阅者的消息过滤策略。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/notifications/subscriptions/filter_polices 表1 路径参数 参数 是否必选 参数类型 描述 project_id
更新消息模板 功能介绍 修改消息模板的内容。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/notifications/message_template/{message_template_id} 表1 路径参数 参数 是否必选 参数类型 描述
创建消息模板 功能介绍 创建一个模板,用户可以按照模板去发送消息,这样可以减少请求的数据量。 单用户默认可创建100个消息模板,高并发场景下,可能会出现消息模板数量超过100仍创建成功的情况,此为正常现象。 调用方法 请参见如何调用API。 URI POST /v2/{project_id
主题操作 查询主题列表 创建主题 查询主题详情 更新主题 删除主题 查询主题策略 删除所有主题策略 更新主题策略 删除指定名称的主题策略 父主题: API
绑定云日志 功能介绍 为指定Topic绑定一个云日志,用于记录主题消息发送状态等信息。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/notifications/topics/{topic_urn}/logtanks 表1 路径参数 参数 是否必选
创建主题 操作场景 主题是消息发布或客户端订阅通知的特定事件类型。它作为发送消息和订阅通知的信道,为发布者和订阅者提供一个可以相互交流的通道。 创建主题 登录管理控制台。 在管理控制台左上角单击图标,选择区域和项目。 在页面左上角单击图标,选择“管理与监管” > “消息通知服务 SMN
请求订阅 操作场景 创建订阅用户完成后,用户需要向订阅终端发送请求订阅,请求订阅的流控规则请见订阅确认流控说明。可一次向一个订阅终端发送确认请求。 操作步骤 登录管理控制台。 在管理控制台左上角单击图标,选择区域和项目。 在页面左上角单击图标,选择“管理与监管” > “消息通知服务
模板操作 查询消息模板列表 创建消息模板 查询消息模板详情 更新消息模板 删除消息模板 父主题: API
查询资源实例 功能介绍 使用标签过滤实例。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/{resource_type}/resource_instances/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id
请求订阅 操作场景 如果订阅者未收到订阅请求消息,用户可以再次请求订阅,请求订阅的流控规则请见订阅确认流控说明。可一次向一个或多个订阅终端发送确认请求。 请求订阅 登录管理控制台。 在管理控制台左上角单击图标,选择区域和项目。 在页面左上角单击图标,选择“管理与监管” > “消息通知服务
批量添加删除资源标签 功能介绍 为指定实例批量添加或删除标签。一个资源上最多有10个标签。 此接口为幂等接口:创建时如果请求体中存在重复key则报错。 创建时,不允许重复key,如果数据库存在就覆盖。 删除时,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验。 调用方法
Application endpoint操作 查询Application的Endpoint列表(废弃) 创建Application endpoint(废弃) 查询Application的Endpoint属性(废弃) 更新Application endpoint(废弃) 删除Application
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
消息发布 功能介绍 将消息发送给Topic的所有订阅端点。当返回消息ID时,该消息已被保存并开始尝试将其推送给Topic的订阅者。三种消息发送方式 message message_structure message_template_name 只需要设置其中一个,如果同时设置,生效的优先级为
更新主题策略 功能介绍 更新主题的策略信息。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/notifications/topics/{topic_urn}/attributes/{name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
与其他服务的关系 其他云服务可以集成SMN,为云服务提供事件通知的能力,使这些服务可以向租户或者消息处理系统发送事件通知。对接SMN的云服务使用SMN的详细信息请参见相应服务的用户指南。 现列举几个云服务使用SMN的例子,如图1所示。 图1 消息通知服务与其他服务的关系示意图 表1
application消息体格式(废弃) 表1 application消息体格式 类型 样例 备注 华为透传消息 "hps": { "msg" : { "type" : 1, "body" : {"key":"value"} } } body为用户自定义格式。 说明: 推荐使用JSON