检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
应用之间通过SMN实现应用的功能集成,降低系统的复杂性。 您可以使用本文档提供的API对消息通知服务进行相关操作,如创建、查询、删除、更新等。支持的全部操作请参见API概览。 在调用消息通知服务API之前,请确保已经充分了解消息通知服务相关概念,详细信息请参见《消息通知服务用户指南》的“产品介绍”。
Topic属性表 属性名称 属性作用 属性默认值 access_policy Topic资源的访问策略,控制其他用户访问该Topic的权限。 空字符串。 introduction 在邮件和短信订阅确认信息中展示Topic的介绍,使您能够让订阅者对主题有更多的了解。 空字符串。 父主题:
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https:
通用请求返回值 异常响应 状态码 父主题: 附录
主题操作 权限 对应API接口 授权项 IAM项目 企业项目 创建主题 POST /v2/{project_id}/notifications/topics smn:topic:create √ √ 查询主题 GET /v2/{project_id}/notifications/topics
标签操作 权限 对应API接口 授权项 IAM项目 企业项目 添加资源标签 POST /v2/{project_id}/{resource_type}/{resource_id}/tags smn:tag:create √ √ 更新标签 - smn:tag:update √ √ 删除资源标签
Cmpp发送状态描述表 发送状态 发送状态描述 DELIVRD 用户已成功收到短信。 EXPIRED 短信已超时。 DELETED 短信已删除。 UNDELIV 短信递送失败。 ACCEPTD 短信已接收。 UNKNOWN 短信状态未知。 REJECTD 短信被拒绝。 父主题: 附录
模板操作 权限 对应API接口 授权项 IAM项目 企业项目 创建消息模板 POST /v2/{project_id}/notifications/message_template smn:template:create √ × 查询消息模板 GET /v2/{project_i
授权操作与SMN接口的映射关系 表1 授权操作与SMN接口的映射关系 授权操作 接口名称 接口功能 SMN:UpdateTopic UpdateTopic 修改主题的属性,目前仅支持修改topic的display_name字段。 SMN:DeleteTopic DeleteTopic
主题创建者是否可以控制所创建的主题中允许的传输协议? 暂不支持主题传输协议的设置。
发布消息操作 权限 对应API接口 授权项 IAM项目 企业项目 发布消息 POST /v2/{project_id}/notifications/topics/{topic_urn}/publish smn:topic:publish √ × 父主题: 权限和授权项
状态码 表1 正常返回值 返回值 说明 200 任务提交成功 201 创建成功 表2 异常返回值 返回值 说明 400 Bad Request 请求参数错误。 401 Unauthorized 鉴权失败。 403 Forbidden 没有权限对资源访问。 404 Not Found
推荐使用JSON格式,如样例所示 对于纯文本可以将body设置为字符串(采用UTF-8编码) 消息体最大2K 详细的字段介绍及其使用请参见华为推送平台的接口定义。 华为系统通知栏消息 "hps": { "msg": { "type": 3, "body": { "content": "Push
Application操作(废弃) 权限 对应API接口 授权项 IAM项目 企业项目 创建应用 POST /v2/{project_id}/notifications/applications smn:application:create √ √ 查询应用 GET /v2/{p
须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要调用接口来查询云服务器列表,那么这个IAM用户被授予的策略中必须包含允许“ecs:ser
异常响应 异常响应要素说明 名称 参数类型 说明 request_id String 请求的ID code String 参考错误码 message String 参考错误码 异常响应举例 { "request_id": "aad0860d089c482b943971f802a6718e"
Application直发消息操作(废弃) 权限 对应API接口 授权项 IAM项目 企业项目 发布应用消息 POST /v2/{project_id}/notifications/endpoints/{endpoint_urn}/publish smn:application:publish
传输中数据保护指在数据传输(发往和离开消息通知服务时)期间保护数据。 向消息通知服务发送消息时,您可以使用Https协议请求消息通知服务接口进行传输加密。消息通知服务向外部系统发送消息时,也支持Https协议发送消息。 父主题: 数据保护技术
在相同的消息模板名称下面,可创建一个或多个不同协议类型的消息模板来适配不同协议的订阅者,但必须包含一个Default协议类型的模板。不同协议类型的消息模板可以设置不同的模板内容,使用{tag}占位符代替变量。如果没有预置的Default协议的模板,将不允许发送该模板。 使用模板格式发
附录 JSON格式消息说明 模板格式消息说明 不同协议消息说明 订阅确认流控说明 国家(或地区)码 授权操作与SMN接口的映射关系 短信发送限制 HTTP(S)终端节点使用样例 订阅筛选策略使用样例