检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 200 SMN.0190 This endpoint already exists. endpoint已存在。
创建主题 操作场景 主题是消息发布或客户端订阅通知的特定事件类型。它作为发送消息和订阅通知的信道,为发布者和订阅者提供一个可以相互交流的通道。 创建主题 登录管理控制台。 在管理控制台左上角单击图标,选择区域和项目。 在页面左上角单击图标,选择“管理与监管” > “消息通知服务 SMN”。
创建消息模板 功能介绍 创建一个模板,用户可以按照模板去发送消息,这样可以减少请求的数据量。 单用户默认可创建100个消息模板,高并发场景下,可能会出现消息模板数量超过100仍创建成功的情况,此为正常现象。 调用方法 请参见如何调用API。 URI POST /v2/{proje
批量添加删除资源标签 功能介绍 为指定实例批量添加或删除标签。一个资源上最多有10个标签。 此接口为幂等接口:创建时如果请求体中存在重复key则报错。 创建时,不允许重复key,如果数据库存在就覆盖。 删除时,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验。 调用方法
示例代码 Java语言 验证消息是否有效,其中signing_cert_url、signature是从HTTP(S)消息格式描述获取的值,message为特定消息的签名键值。以下为示例代码,仅供参考。 private static void isMessageValid(String
创建主题 功能介绍 创建Topic,单用户默认配额为3000。高并发场景下,可能会出现Topic数量超过3000仍创建成功的情况,此为正常现象。 接口是幂等的,接口调用返回成功时,若已存在同名的Topic,返回的status code为200,否则返回的status code为201
更新消息模板 功能介绍 修改消息模板的内容。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/notifications/message_template/{message_template_id} 表1 路径参数 参数 是否必选 参数类型 描述
绑定云日志 功能介绍 为指定Topic绑定一个云日志,用于记录主题消息发送状态等信息。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/notifications/topics/{topic_urn}/logtanks 表1 路径参数 参数 是否必选
SMN自定义策略 如果系统预置的SMN权限,不满足您的授权要求,可以创建自定义策略。自定义策略中可以添加的授权项(Action)请参考《消息通知服务接口参考》中“ 策略及授权项说明”章节。 目前华为云支持以下两种方式创建自定义策略: 可视化视图创建自定义策略:无需了解策略语法,按
添加资源标签 功能介绍 一个资源上最多有10个标签。此接口为幂等接口:创建时,如果创建的标签已经存在(key相同),则覆盖。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/{resource_type}/{resource_id}/tags
创建订阅用户 操作场景 SMN的终端节点订阅主题且确认订阅后,终端节点才能够接收到向该主题发布的所有消息。当用户在多个区域均需要创建同样的订阅时,终端节点会多次收到确认订阅信息,且需要在每一条订阅消息内确认订阅。为防止这种场景下对终端节点的消息干扰,建议使用订阅用户功能,一次创建用户后即可导入其他区域的订阅。
更新主题 功能介绍 更新显示名。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/notifications/topics/{topic_urn} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考
HTTP(S)消息格式 操作场景 接收SMN服务发送的HTTP(S)消息时,终端证书的CN名称请参考业界规范,部分特殊字符可能导致https消息发送失败。 在互联网上传递未加密的http协议消息内容存在信息泄漏风险,推荐用户终端添加订阅时对接通道优先使用https类型。 描述SM
授权操作与SMN接口的映射关系 表1 授权操作与SMN接口的映射关系 授权操作 接口名称 接口功能 SMN:UpdateTopic UpdateTopic 修改主题的属性,目前仅支持修改topic的display_name字段。 SMN:DeleteTopic DeleteTopic
订阅确认V2接口(废弃) 用途 订阅确认接口 接口 PUT /v2/{tenant_id}/notifications/topics/{topic_urn}/subscriptions/{subscription_urn}/confirmation PUT /v2/{tenant
更新主题策略 功能介绍 更新主题的策略信息。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/notifications/topics/{topic_urn}/attributes/{name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
获取http探测结果 功能介绍 根据http探测发送返回的task_id查询探测结果。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/notifications/topics/{topic_urn}/detection/{task_id} 表1
更新云日志 功能介绍 更新指定Topic绑定的云日志。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/notifications/topics/{topic_urn}/logtanks/{logtank_id} 表1 路径参数 参数 是否必选
校验消息签名 操作场景 为了确保安全,提供订阅确认、取消订阅和消息的签名认证,在消息的接收方需要对SMN发送的消息进行校验,消息类型包括订阅确认消息、通知消息和取消订阅通知消息。使用SMN消息中的信息,您可以通过签名串验证消息的合法性。 操作步骤 验证SMN发送的HTTP(S)请求的流程如下: