检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
针对单个主题的流控,不区分协议类型,控制该主题消息的并发量,统计周期固定1分钟,默认3k/分钟。 租户短信流控 针对单个租户一定周期内可发送的短信类型消息总量,不针对特定终端,统计周期默认10分钟,默认1w/10分钟。 租户邮件流控 针对单个租户一定周期内可发送的邮件类型消息总量,不针对特定
更新订阅者 功能介绍 更新订阅者备注。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/notifications/topics/{topic_urn}/subscriptions/{subscription_urn} 表1 路径参数 参数 是否必选
删除主题 功能介绍 删除主题。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/notifications/topics/{topic_urn} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考
异常响应 异常响应要素说明 名称 参数类型 说明 request_id String 请求的ID code String 参考错误码 message String 参考错误码 异常响应举例 { "request_id": "aad0860d089c482b943971f802a6718e"
查询Application(废弃) 功能介绍 查询应用平台列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/notif
创建Application(废弃) 功能介绍 创建平台应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/notifi
查询消息模板详情 功能介绍 查询模板详情,包括模板内容。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/notifications/message_template/{message_template_id} 表1 路径参数 参数 是否必选 参数类型
是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考 获取项目ID。 topic_urn 是 String Topic的唯一的资源标识,可通过查询主题列表获取该标识。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
发布探测消息 功能介绍 基于主题发送http/https探测消息,探测当前http/https 终端是否可用,SMN出口是否能够正常访问该终端。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/notifications/topics/{topic_urn}/detection
参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id
参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 platform_principal
SDK列表 在开始使用之前,请确保您安装的是最新版本的SDK。使用过时的版本可能会导致兼容性问题或无法使用最新功能。您可以在SDK中心查询版本信息。 表1提供了SMN服务支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表
更新主题 功能介绍 更新显示名。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/notifications/topics/{topic_urn} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考
创建主题 功能介绍 创建Topic,单用户默认配额为3000。高并发场景下,可能会出现Topic数量超过3000仍创建成功的情况,此为正常现象。 接口是幂等的,接口调用返回成功时,若已存在同名的Topic,返回的status code为200,否则返回的status code为201
消息发布 功能介绍 将消息发送给Topic的所有订阅端点。当返回消息ID时,该消息已被保存并开始尝试将其推送给Topic的订阅者。为确保您的消息能够成功推送到各个订阅者,请确保您的消息内容符合当地法律法规要求。 三种消息发送方式 message message_structure
查询Application的Endpoint属性(废弃) 功能介绍 获取endpoint的属性。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{p
图1 SMN产品架构 SMN的主题订阅模型,旨在提供一对多的消息订阅以及通知功能,能够实现一站式集成多种推送通知方式。在SMN中有两种类型的客户端,即发布者和订阅者。发布者通过主题发布消息,由SMN将消息推送给主题订阅者,订阅者可以为邮箱地址、手机号码、函数及URL地址。 主
快速入门 操作场景 本节通过调用一系列SMN的API实现通过主题发布消息。 API的调用方法请参见如何调用API。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。 涉及API 当您使用Token认证方式完成
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 content 是 String