检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 通过使用消息通知服务所提供的接口,您可以完整的使用消息通知服务的所有功能。例如创建Topic、添加订阅。 表1 接口说明 类型 说明 主题操作 包含创建主题、更新主题、删除主题等接口。 订阅操作 包含查询订阅列表、订阅、取消订阅等接口。 模板操作 包含创建消息模板、更新消息模板
历史API Application操作 Application endpoint操作 Application直发消息操作 订阅确认V2接口(废弃)
如何调用API 构造请求 认证鉴权 返回结果
模板操作 权限 对应API接口 授权项 IAM项目 企业项目 创建消息模板 POST /v2/{project_id}/notifications/message_template smn:template:create √ × 查询消息模板 GET /v2/{project_id
主题操作 权限 对应API接口 授权项 IAM项目 企业项目 创建主题 POST /v2/{project_id}/notifications/topics smn:topic:create √ √ 查询主题 GET /v2/{project_id}/notifications/topics
Application直发消息操作(废弃) 权限 对应API接口 授权项 IAM项目 企业项目 发布应用消息 POST /v2/{project_id}/notifications/endpoints/{endpoint_urn}/publish smn:application:publish
发布消息操作 权限 对应API接口 授权项 IAM项目 企业项目 发布消息 POST /v2/{project_id}/notifications/topics/{topic_urn}/publish smn:topic:publish √ × 父主题: 权限和授权项
API 订阅用户 主题操作 订阅操作 模板操作 发布消息操作 使用标签管理服务 查询版本操作 云日志操作 订阅过滤策略操作 通知策略
查询SMN支持的API版本号信息 功能介绍 查询SMN开放API支持的版本号。 调用方法 请参见如何调用API。 URI GET / 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户
消息发布 功能介绍 将消息发送给Topic的所有订阅端点。当返回消息ID时,该消息已被保存并开始尝试将其推送给Topic的订阅者。为确保您的消息能够成功推送到各个订阅者,请确保您的消息内容符合当地法律法规要求。 三种消息发送方式 message message_structure
标签操作 权限 对应API接口 授权项 IAM项目 企业项目 添加资源标签 POST /v2/{project_id}/{resource_type}/{resource_id}/tags smn:tag:create √ √ 更新标签 - smn:tag:update √ √ 删除资源标签
Application操作(废弃) 权限 对应API接口 授权项 IAM项目 企业项目 创建应用 POST /v2/{project_id}/notifications/applications smn:application:create √ √ 查询应用 GET /v2/{project_id
查询SMN API V2版本信息 功能介绍 查询SMN API V2版本信息。 调用方法 请参见如何调用API。 URI GET /v2 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM
资源名称:输入资源的名称,当该事件所涉及的云资源无资源名称或对应的API接口操作不涉及资源名称参数时,该字段为空。 资源ID:输入资源ID,当该资源类型无资源ID或资源创建失败时,该字段为空。 云服务:在下拉框中选择对应的云服务名称。 资源类型:在下拉框中选择对应的资源类型。
对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。
订阅确认V2接口(废弃) 用途 订阅确认接口 接口 PUT /v2/{tenant_id}/notifications/topics/{topic_urn}/subscriptions/{subscription_urn}/confirmation PUT /v2/{tenant_id
多数细粒度策略以API接口为粒度进行权限拆分,权限的最小粒度为API授权项(action),SMN支持的API授权项请参见《消息通知服务接口参考》中“策略及授权项说明”章节。 如表1所示,包括了SMN的所有系统权限。
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
授权操作与SMN接口的映射关系 表1 授权操作与SMN接口的映射关系 授权操作 接口名称 接口功能 SMN:UpdateTopic UpdateTopic 修改主题的属性,目前仅支持修改topic的display_name字段。 SMN:DeleteTopic DeleteTopic
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头