检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
以在应用之间通过SMN实现应用的功能集成,降低系统的复杂性。 您可以使用本文档提供的API对消息通知服务进行相关操作,如创建、查询、删除、更新等。支持的全部操作请参见API概览。 在调用消息通知服务API之前,请确保已经充分了解消息通知服务相关概念,详细信息请参见《消息通知服务用户指南》的“产品介绍”。
发布消息操作 权限 对应API接口 授权项 IAM项目 企业项目 发布消息 POST /v2/{project_id}/notifications/topics/{topic_urn}/publish smn:topic:publish √ × 父主题: 权限和授权项
通用请求返回值 异常响应 状态码 父主题: 附录
Cmpp发送状态描述表 发送状态 发送状态描述 DELIVRD 用户已成功收到短信。 EXPIRED 短信已超时。 DELETED 短信已删除。 UNDELIV 短信递送失败。 ACCEPTD 短信已接收。 UNKNOWN 短信状态未知。 REJECTD 短信被拒绝。 父主题: 附录
查询Application的Endpoint属性(废弃) 功能介绍 获取endpoint的属性。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{pro
创建时间进行升序排列。分页查询可以指定offset以及limit。如果指定Topic不存在订阅者,返回空列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/notifications/topics/{topic_urn}/subscriptions
当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 IAM获取token的API SMN创建Topic的API SMN添加订阅的API SMN发送消息的API 具体步骤 Token认证,具体操作请参考认证鉴权。 创建Topic。发送“POST
消息通知服务的主题名称有何格式要求? 主题名称不能超过255个字符,允许使用字母数字字符以及连字符(-)和下划线(_)。 一个账户中的主题名称必须唯一,删除主题后,可以重新使用该主题名称。 创建主题后,主题名称为主题的唯一标识,一旦创建后不能再修改主题名称。SMN将为该主题分配唯
Application操作(废弃) 权限 对应API接口 授权项 IAM项目 企业项目 创建应用 POST /v2/{project_id}/notifications/applications smn:application:create √ √ 查询应用 GET /v2/{p
状态码 表1 正常返回值 返回值 说明 200 任务提交成功 201 创建成功 表2 异常返回值 返回值 说明 400 Bad Request 请求参数错误。 401 Unauthorized 鉴权失败。 403 Forbidden 没有权限对资源访问。 404 Not Found
default message." } JSON格式约束 满足JSON格式要求。 JSON格式中必须有Default协议。 整个JSON消息的大小不超过256KB。 JSON消息计算 选择不同的协议,生成的JSON格式消息的大小不同。JSON格式消息的字节数包含消息框中显示的花括号、双引
模板格式消息说明 模板格式消息指固定格式的消息,可以通过tag的方式来处理变量的部分。 通过模板发送消息,建议消息大小不超过256KB,模板格式消息如下所示: { "message_template_name":"confirm_message", "tags":{
描述SMN服务向HTTP(S)终端发送消息的格式,您可以通过消息头部信息中的消息类型来区分消息格式。消息格式包括:HTTP(S)订阅确认消息的格式、HTTP(S)推送消息的格式和HTTP(S)取消订阅消息的格式三种消息格式,HTTP/HTTPS协议均为POST方式。 当SMN服务向HTT
Application直发消息操作(废弃) 权限 对应API接口 授权项 IAM项目 企业项目 发布应用消息 POST /v2/{project_id}/notifications/endpoints/{endpoint_urn}/publish smn:application:publish
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 200 SMN.0190 This endpoint already exists. endpoint已存在。
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https:
示例1:使用主题发布消息 操作场景 本章节指导用户通过API发布消息。API的调用方法请参见如何调用API。 涉及接口 获取用户Token:通过用户名/密码的方式进行认证来获取IAM用户Token。 创建主题:创建Topic。 订阅:为指定Topic添加订阅者。 消息发布:将消息发送给Topic的所有订阅终端。
须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要调用接口来查询云服务器列表,那么这个IAM用户被授予的策略中必须包含允许“ecs:ser
附录 JSON格式消息说明 模板格式消息说明 不同协议消息说明 订阅确认流控说明 国家(或地区)码 授权操作与SMN接口的映射关系 短信发送限制 HTTP(S)终端节点使用样例 订阅筛选策略使用样例
示例2:使用消息模板方式发布消息 操作场景 本章节指导用户通过API使用消息模板方式发布消息。API的调用方法请参见如何调用API。 涉及接口 获取用户Token:通过用户名/密码的方式进行认证来获取IAM用户Token。 创建主题:创建Topic。 订阅:为指定Topic添加订阅者。