检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
状态码 表1 正常返回值 返回值 说明 200 任务提交成功 201 创建成功 表2 异常返回值 返回值 说明 400 Bad Request 请求参数错误。 401 Unauthorized 鉴权失败。 403 Forbidden 没有权限对资源访问。 404 Not Found
查询主题详情 功能介绍 查询Topic的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/notifications/topics/{topic_urn} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
通过SMN发布JSON消息 操作场景 消息通知服务能够根据用户的需求,向订阅终端主动推送消息。消息通知服务支持发布JSON消息,可通过一次消息发布,向不同类型的订阅者发布不同内容的消息。 本章节以创建主题并发布JSON消息为例,指导您快速上手消息通知服务。 操作流程 操作步骤 说明
向主题发布JSON消息 操作场景 如果您需要向不同的订阅协议发送不同的内容,可以向主题发布JSON消息,它可以定义分别向短信、邮件、FunctionGraph(函数)、FunctionGraph(工作流)和HTTP(S)订阅协议发送不同内容。 前提条件 所有的订阅终端必须确认订阅
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
订阅主题 操作场景 要接收发布至主题的消息,您必须向该主题添加订阅者。 添加订阅 登录管理控制台。 在管理控制台左上角单击图标,选择区域和项目。 在页面左上角单击图标,选择“管理与监管” > “消息通知服务 SMN”。 进入消息通知服务页面。 在左侧导航栏,选择“主题管理” > “主题”。
约束与限制 当您通过消息通知服务SMN发送邮件、短信等消息时,您需要确保传输的内容符合当地法律法规要求。 SMN使用异步方式推送消息,不保证消息送达的时效性。如果业务要求消息准实时送达,请慎重考虑是否使用SMN服务。 SMN服务发送消息的邮箱地址和发送短信/语音的号码地址不固定,
添加订阅 操作场景 订阅是您将订阅者注册到主题的操作。要接收发布至主题的消息,您必须订阅一个订阅终端到该主题。终端节点可以是手机号码、邮箱地址、函数或HTTP(S)终端。为终端节点订阅主题且确认订阅后,终端节点能够接收到向该主题发布的所有消息。 您可以拥有多个主题,每个主题有多个
向主题发布模板消息 操作场景 消息模板指消息的固定格式。如果您要发布的消息内容丰富,并且这条消息需要多次发布,每次发布时需要变更的内容极少,此时您可以套用已创建的消息模板向订阅者发送消息。 在相同的消息模板名称下面,可创建一个或多个不同协议类型的消息模板来适配不同协议的订阅者,但
新增/修改/删除主题标签 操作场景 标签由标签“键”和标签“值”组成,用于标识云资源,可对云资源进行分类和搜索。 一个标签的“键”可以拥有多个标签“值”。 一个云资源不能拥有重复的标签“键”。 创建主题标签 登录管理控制台。 在管理控制台左上角单击图标,选择区域和项目。 在页面左上角单击图标,选择“管理与监管”
快速入门 操作场景 本节通过调用一系列SMN的API实现通过主题发布消息。 API的调用方法请参见如何调用API。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。 涉及API 当您使用Token认证方式完成
基本概念 项目 项目用于将OpenStack的资源(计算资源、存储资源和网络资源)进行分组和隔离。项目可以是一个部门或者一个项目组。一个账户中可以创建多个项目。 协议 SMN支持发送的消息类型,包括邮件、HTTP(S)、短信、FunctionGraph(函数)、FunctionGraph(工作流)。
取消订阅 操作场景 订阅者订阅了主题之后,会收到系统发出的确认请求消息。只有订阅者确认订阅才能收到消息。当订阅者不需要收到消息时,可取消订阅。 目前SMN服务的订阅管理能力对终端订阅者开放,终端订阅者必须保护好自己的订阅链接,避免被其他人窃取后无法收到或收到非本人期望得到的通知信息。
示例1:使用主题发布消息 操作场景 本章节指导用户通过API发布消息。API的调用方法请参见如何调用API。 涉及接口 获取用户Token:通过用户名/密码的方式进行认证来获取IAM用户Token。 创建主题:创建Topic。 订阅:为指定Topic添加订阅者。 消息发布:将消息发送给Topic的所有订阅终端。
查询资源标签 功能介绍 查询指定实例的标签信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/{resource_type}/{resource_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
JSON格式消息说明 JSON格式体说明 JSON格式主要用来处理用户想对不同的订阅者类型发送不同的消息,目前支持的协议Default、HTTP、HTTPS、email、FunctionGraph(函数)、FunctionGraph(工作流),其中Default是必须的,Emai
创建订阅用户 操作场景 SMN的终端节点订阅主题且确认订阅后,终端节点才能够接收到向该主题发布的所有消息。当用户在多个区域均需要创建同样的订阅时,终端节点会多次收到确认订阅信息,且需要在每一条订阅消息内确认订阅。为防止这种场景下对终端节点的消息干扰,建议使用订阅用户功能,一次创建用户后即可导入其他区域的订阅。
示例2:使用消息模板方式发布消息 操作场景 本章节指导用户通过API使用消息模板方式发布消息。API的调用方法请参见如何调用API。 涉及接口 获取用户Token:通过用户名/密码的方式进行认证来获取IAM用户Token。 创建主题:创建Topic。 订阅:为指定Topic添加订阅者。
向主题推送消息后,订阅者为什么没有收到消息? 在排除终端设备本身的问题,比如信号不好。最可能原因是您未完成确认订阅或信息被拦截。 优先排查信息是否被拦截,查看您的短信/邮件是否被处理为垃圾信息。 如果仍然不能解决您的问题,请联系技术支持。 短信协议 如果是订阅确认短信,请优先排查被拦截的短信。
查询资源实例 功能介绍 使用标签过滤实例。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/{resource_type}/resource_instances/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id