参数au商城

消息通知服务接口参考文档版本01发布日期2021-03-30华为技术有限公司版权所有华为技术有限公司2021.
保留一切权利.
非经本公司书面许可,任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部,并不得以任何形式传播.
商标声明和其他华为商标均为华为技术有限公司的商标.
本文档提及的其他所有商标或注册商标,由各自的所有人拥有.
注意您购买的产品、服务或特性等应受华为公司商业合同和条款的约束,本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内.
除非合同另有约定,华为公司对本文档内容不做任何明示或默示的声明或保证.
由于产品版本升级或其他原因,本文档内容会不定期进行更新.
除非另有约定,本文档仅作为使用指导,本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保.
文档版本01(2021-03-30)版权所有华为技术有限公司i目录1使用前必读.
11.
1概述.
11.
2调用说明.
11.
3终端节点(Endpoint)11.
4约束与限制.
11.
5基本概念.
12API概览.
33如何调用API.
43.
1构造请求.
43.
2认证鉴权.
83.
3返回结果.
94快速入门.
115API.
135.
1主题操作.
135.
1.
1查询主题列表.
135.
1.
2创建主题.
175.
1.
3查询主题详情.
205.
1.
4更新主题.
235.
1.
5删除主题.
265.
1.
6查询主题策略.
295.
1.
7删除所有主题策略.
345.
1.
8更新主题策略.
375.
1.
9删除指定名称的主题策略.
405.
2订阅操作.
435.
2.
1查询订阅者列表.
435.
2.
2查询指定Topic的订阅者列表.
475.
2.
3订阅.
515.
2.
4取消订阅.
565.
3模板操作.
585.
3.
1查询消息模板列表.
585.
3.
2创建消息模板.
635.
3.
3查询消息模板详情.
67消息通知服务接口参考目录文档版本01(2021-03-30)版权所有华为技术有限公司ii5.
3.
4更新消息模板.
695.
3.
5删除消息模板.
725.
4发布消息操作.
745.
4.
1消息发布.
755.
5使用标签管理服务.
805.
5.
1查询资源实例.
805.
5.
2批量添加删除资源标签.
885.
5.
3查询资源标签.
915.
5.
4添加资源标签.
955.
5.
5查询项目标签.
995.
5.
6删除资源标签.
1025.
6Application操作.
1055.
6.
1查询Application.
1055.
6.
2创建Application.
1095.
6.
3查询Application属性.
1125.
6.
4更新Application.
1155.
6.
5删除Application.
1185.
7Applicationendpoint操作.
1215.
7.
1查询Application的Endpoint列表.
1215.
7.
2创建Applicationendpoint.
1255.
7.
3查询Application的Endpoint属性.
1285.
7.
4更新Applicationendpoint.
1315.
7.
5删除Applicationendpoint.
1345.
8Application直发消息操作.
1375.
8.
1App消息发布.
1375.
9查询版本操作.
1425.
9.
1查询SMN支持的API版本号信息.
1425.
9.
2查询SMNAPIV2版本信息.
1456应用示例.
1506.
1示例1:使用主题发布消息.
1506.
2示例2:使用消息模板方式发布消息.
1516.
3示例3:使用移动推送.
1537公共参数.
1567.
1application消息体格式.
1567.
2获取项目ID.
157A附录.
159A.
1Topic属性表.
159A.
2通用请求返回值.
159A.
2.
1异常响应.
159A.
2.
2状态码.
160A.
3错误码.
160消息通知服务接口参考目录文档版本01(2021-03-30)版权所有华为技术有限公司iiiA.
4Cmpp发送状态描述表.
175A.
5国家码和地区码.
176B修订记录.
184消息通知服务接口参考目录文档版本01(2021-03-30)版权所有华为技术有限公司iv1使用前必读1.
1概述欢迎使用消息通知服务(SimpleMessageNotification,SMN).
消息通知服务是可靠的、可扩展的、海量的消息处理服务.
它可以依据您的需求主动推送通知消息,最终您可以通过短信、电子邮件、应用等方式接收.
您也可以在应用之间通过SMN实现应用的功能集成,降低系统的复杂性.
您可以使用本文档提供的API对消息通知服务进行相关操作,如创建、查询、删除、更新等.
支持的全部操作请参见API概览.
在调用消息通知服务API之前,请确保已经充分了解消息通知服务相关概念,详细信息请参见《消息通知服务用户指南》的"产品介绍".
1.
2调用说明消息通知服务提供了REST(RepresentationalStateTransfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API.
1.
3终端节点(Endpoint)终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询所有服务的终端节点.
1.
4约束与限制您能创建的SMN资源的数量与配额有关系,如果您想查看服务配额、扩大配额,具体请参见"关于配额".
更详细的限制请参见具体API的说明.
1.
5基本概念帐号消息通知服务接口参考1使用前必读文档版本01(2021-03-30)版权所有华为技术有限公司1用户注册时的帐号,帐号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等.
由于帐号是付费主体,为了确保帐号安全,建议您不要直接使用帐号进行日常管理工作,而是创建用户并使用他们进行日常管理工作.
用户由帐号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥).
在我的凭证下,您可以查看帐号ID和IAM用户ID.
通常在调用API的鉴权过程中,您需要用到帐号、用户和密码等信息.
区域(Region)从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务.
Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region.
详情请参见区域和可用区.
可用区(AZ,AvailabilityZone)一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群.
一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求.
项目区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您帐号中该区域的所有资源.
如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确.
图1-1项目隔离模型同样在我的凭证下,您可以查看项目ID.
企业项目企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离.
企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出.
关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》.
消息通知服务接口参考1使用前必读文档版本01(2021-03-30)版权所有华为技术有限公司22API概览通过使用消息通知服务所提供的接口,您可以完整的使用消息通知服务的所有功能.
例如创建Topic、添加订阅.
表2-1接口说明类型说明Topic操作包含创建Topic、更新Topic、删除Topic等接口.
订阅操作包含查询订阅列表、订阅、取消订阅等接口.
模板操作包含创建消息模板、更新消息模板、删除消息模板等接口.
消息发布包含消息发布、使用消息结构体方式的消息发布和使用消息模板方式的消息发布接口.
使用标签管理服务包含查询资源实例、添加资源标签和查询项目标签等接口.
查询版本操作包含查询SMN支持的API版本号信息和查询SMNAPIV2版本信息接口.
Application操作包含创建Application、更新Application和删除Application等接口.
Applicationendpoint操作包含创建Applicationendpoint、更新Applicationendpoint和删除Applicationendpoint等接口.
Application直发消息操作包含APP消息发布和使用消息结构体方式的App消息发布接口.
消息通知服务接口参考2API概览文档版本01(2021-03-30)版权所有华为技术有限公司33如何调用API3.
1构造请求本节介绍RESTAPI请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权.
您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.
huaweicloud.
com/videos/102987.
请求URI请求URI由如下部分组成:{URI-scheme}://{Endpoint}/{resource-path}{query-string}尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调.
表3-1URI中的参数说明参数描述URI-scheme表示用于传输请求的协议,当前所有API均采用HTTPS协议.
Endpoint指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取.
例如IAM服务在"华北-北京一"区域的Endpoint为"iam.
cn-north-1.
myhuaweicloud.
com".
resource-path资源路径,也即API访问路径.
从具体API的URI模块获取,例如"获取用户Token"API的resource-path为"/v3/auth/tokens".
query-string查询参数,是可选部分,并不是每个API都有查询参数.
查询参数前面需要带一个"",形式为"参数名=参数取值",例如"limit=10",表示查询不超过10条数据.
消息通知服务接口参考3如何调用API文档版本01(2021-03-30)版权所有华为技术有限公司4例如您需要获取IAM在"华北-北京一"区域的Token,则需使用"华北-北京一"区域的Endpoint(iam.
cn-north-1.
myhuaweicloud.
com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示.
https://iam.
cn-north-1.
myhuaweicloud.
com/v3/auth/tokens图3-1URI示意图说明为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起.
这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略.
请求方法HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作.
表3-2HTTP方法方法说明GET请求服务器返回指定资源.
PUT请求服务器更新指定资源.
POST请求服务器新增资源或执行特殊操作.
DELETE请求服务器删除指定资源,如删除对象等.
HEAD请求服务器资源头部.
PATCH请求服务器更新资源的部分内容.
当资源不存在的时候,PATCH可能会去创建一个新的资源.
在获取用户Token的URI部分,您可以看到其请求方法为"POST",则其请求为:POSThttps://iam.
cn-north-1.
myhuaweicloud.
com/v3/auth/tokens请求消息头附加请求头字段,如指定的URI和HTTP方法所要求的字段.
例如定义消息体类型的请求头"Content-Type",请求鉴权信息等.
详细的公共请求消息头字段请参见表3-3.
消息通知服务接口参考3如何调用API文档版本01(2021-03-30)版权所有华为技术有限公司5表3-3公共请求消息头名称描述是否必选示例Host请求的服务器信息,从服务API的URL中获取.
值为hostname[:port].
端口缺省时使用默认的端口,https的默认端口为443.
否使用AK/SK认证时该字段必选.
code.
test.
comorcode.
test.
com:443Content-Type消息体的类型(格式).
推荐用户使用默认值application/json,有其他取值时会在具体接口中专门说明.
是application/jsonContent-Length请求body长度,单位为Byte.
否3495X-Project-Idprojectid,项目编号.
请参考获取项目ID章节获取项目编号.
否如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求,则该字段必选.
e9993fc787d94b6c886cbaa340f9c0f4X-Auth-Token用户Token.
用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口.
请求响应成功后在响应消息头(Headers)中包含的"X-Subject-Token"的值即为Token值.
否使用Token认证时该字段必选.
注:以下仅为Token示例片段MIIPAgYJKoZIhvcNAQcCo.
.
.
ggg1BBIINPXsidG9rZ说明API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头.
AK/SK认证的详细说明请参见认证鉴权的"AK/SK认证".
消息通知服务接口参考3如何调用API文档版本01(2021-03-30)版权所有华为技术有限公司6对于获取用户Token接口,由于不需要认证,所以只添加"Content-Type"即可,添加消息头后的请求如下所示.
POSThttps://iam.
cn-north-1.
myhuaweicloud.
com/v3/auth/tokensContent-Type:application/json请求消息体(可选)该部分可选.
请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容.
若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码.
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定.
对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明.
将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的帐号名称,为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如"cn-north-1",您可以从地区和终端节点获取.
说明scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源.
您还可以设置Token的作用域为某个帐号下所有资源或帐号的某个project下的资源,详细定义请参见获取用户Token.
POSThttps://iam.
cn-north-1.
myhuaweicloud.
com/v3/auth/tokensContent-Type:application/json{"auth":{"identity":{"methods":["password"],"password":{"user":{"name":"username","password""domain":{"name":"domainname"}}}},"scope":{"project":{"name":"xxxxxxxxxxxxxxxxxx"}}}}到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API.
对于获取用户Token接口,返回的响应消息头中"x-subject-token"就是需要获取的用户Token.
有了Token之后,您就可以使用Token认证调用其他API.
消息通知服务接口参考3如何调用API文档版本01(2021-03-30)版权所有华为技术有限公司73.
2认证鉴权调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权.
Token认证:通过Token认证通用请求.
AK/SK认证:通过AK(AccessKeyID)/SK(SecretAccessKey)加密调用请求.
推荐使用AK/SK认证,其安全性比Token认证要高.
Token认证说明Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用.
Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限.
Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限.
Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.
scope的取值需要选择project,如下所示.
{"auth":{"identity":{"methods":["password"],"password":{"user":{"name":"username","password""domain":{"name":"domainname"}}}},"scope":{"project":{"name":"xxxxxxxx"}}}}获取Token后,再调用其他接口时,您需要在请求消息头中添加"X-Auth-Token",其值即为Token.
例如Token值为"ABCDEFJ.
.
.
.
",则调用接口时将"X-Auth-Token:ABCDEFJ.
.
.
.
"加到请求消息头即可,如下所示.
POSThttps://iam.
cn-north-1.
myhuaweicloud.
com/v3/auth/projectsContent-Type:application/jsonX-Auth-Token:ABCDEFJ.
.
.
.
您还可以通过这个视频教程了解如何使用Token认证:https://bbs.
huaweicloud.
com/videos/101333.
消息通知服务接口参考3如何调用API文档版本01(2021-03-30)版权所有华为技术有限公司8AK/SK认证说明AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证.
AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证.
AK(AccessKeyID):访问密钥ID.
与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名.
SK(SecretAccessKey):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改.
使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名.
详细的签名方法和SDK使用方法请参见API签名指南.
说明签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意.
3.
3返回结果状态码请求发送以后,您会收到响应,包含状态码、响应消息头和消息体.
状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码.
对于获取用户Token接口,如果调用后返回状态码为"201",则表示请求成功.
响应消息头对应请求消息头,响应同样也有消息头,如"Content-type".
对于获取用户Token接口,返回如图3-2所示的消息头,其中"x-subject-token"就是需要获取的用户Token.
有了Token之后,您就可以使用Token认证调用其他API.
消息通知服务接口参考3如何调用API文档版本01(2021-03-30)版权所有华为技术有限公司9图3-2获取用户Token响应消息头响应消息体(可选)该部分可选.
响应消息体通常以结构化格式(如JSON或XML)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容.
对于获取用户Token接口,返回如下消息体.
为篇幅起见,这里只展示部分内容.
{"token":{"expires_at":"2019-02-13T06:52:13.
855000Z","methods":["password"],"catalog":[{"endpoints":[{"region_id":"az-01",.
.
.
.
.
.
当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示.
{"error_msg":"Theformatofmessageiserror","error_code":"AS.
0001"}其中,error_code表示错误码,error_msg表示错误描述信息.
消息通知服务接口参考3如何调用API文档版本01(2021-03-30)版权所有华为技术有限公司104快速入门操作场景本节通过调用一系列SMN的API实现通过主题发布消息.
API的调用方法请参见如何调用API.
说明通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用.
涉及API当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加"X-Auth-Token"到业务接口请求消息头中.
IAM获取token的APISMN创建Topic的APISMN添加订阅的APISMN发送消息的API具体步骤1.
Token认证,具体操作请参考认证鉴权.
2.
创建Topic.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics".
a.
在RequestHeader中增加"X-Auth-Token".
b.
在RequestBody中传入参数如下:{"name":"test_topic_v2",//Topic名称(必填String)"display_name":"test"//显示名(非必填String)}请求响应成功后,返回request_id和topic_urn.
如果请求失败,则会返回错误码及对应的错误信息说明,详细错误码信息请参考错误码.
3.
添加订阅.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/subscriptions".
消息通知服务接口参考4快速入门文档版本01(2021-03-30)版权所有华为技术有限公司11其中,topic_urn可在2.
b的返回体中获取.
a.
在RequestHeader中增加"X-Auth-Token".
b.
在RequestBody中传入参数如下:{"protocol":"email",//订阅协议(必填String)"endpoint":"xxx@xx.
com",//邮件地址(必填String)"remark":"订阅终端"//备注(非必填String)}请求响应成功后,返回request_id和subscription_urn.
如果请求失败,则会返回错误码及对应的错误信息说明,详细错误码信息请参考错误码.
说明可为Topic添加多种以及多个订阅终端,支持的订阅协议请参考订阅.
c.
订阅终端会收到一条确认订阅的消息,请在邮箱中进行确认订阅的操作.
4.
发送消息.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/publish".
a.
在RequestHeader中增加"X-Auth-Token".
b.
在RequestBody中传入参数如下:{"subject":"testmessagev2",//标题,邮件订阅终端使用(非必填String)"message":"Messagetestmessagev2.
"//需要发送的消息(必填String)}请求响应成功后,返回request_id和message_id.
如果请求失败,则会返回错误码及对应的错误信息说明,详细错误码信息请参考错误码.
说明已完成3.
c中的确认订阅操作的订阅终端都能收到该消息,否则无法接收消息.
消息通知服务接口参考4快速入门文档版本01(2021-03-30)版权所有华为技术有限公司125API5.
1主题操作5.
1.
1查询主题列表功能介绍分页查询Topic列表,Topic列表按照Topic创建时间进行降序排列.
分页查询可以指定offset以及limit.
如果不存在Topic,则返回空列表.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/notifications/topics表5-1路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司13表5-2Query参数参数是否必选参数类型描述offset否Integer偏移量.
偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0.
缺省值:0limit否Integer查询的数量限制.
取值范围:1~100,取值一般为10,20,50.
功能说明:每页返回的资源个数.
默认值为100.
缺省值:100请求参数表5-3请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-4响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
topic_countInteger返回的Topic个数.
该参数不受offset和limit影响,即返回的是您帐户下所有的Topic个数.
topicsArrayofListTopicsItemobjectsTopic结构体数组.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司14表5-5ListTopicsItem参数参数类型描述topic_urnStringTopic的唯一的资源标识.
nameString创建topic的名字.
display_nameStringTopic的显示名,推送邮件消息时,作为邮件发件人显示.
push_policyInteger消息推送的策略,该属性目前不支持修改,后续将支持修改.
0表示发送失败,保留到失败队列,1表示直接丢弃发送失败的消息.
enterprise_project_idString企业项目ID.
状态码:400表5-6响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-7响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-8响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司15参数参数类型描述codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-9响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例查询主题列表GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topicsoffset=0&limit=100null响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","topic_count":1,"topics":[{"topic_urn":"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_topic_v2","display_name":"testtest","name":"test_topic_v1","push_policy":0,"enterprise_project_id":"0"}]}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司16状态码描述500InternalServerError错误码请参见错误码.
5.
1.
2创建主题功能介绍创建Topic,单用户默认配额为3000.
高并发场景下,可能会出现Topic数量超过3000仍创建成功的情况,此为正常现象.
接口是幂等的,接口调用返回成功时,若已存在同名的Topic,返回的statuscode为200,否则返回的statuscode为201调试您可以在APIExplorer中调试该接口.
URIPOST/v2/{project_id}/notifications/topics表5-10路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
请求参数表5-11请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司17表5-12请求Body参数参数是否必选参数类型描述name是String创建topic的名字.
Topic名称只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度为1到255个字符.
最小长度:1最大长度:255display_name是StringTopic的显示名,推送邮件消息时,作为邮件发件人显示.
显示名的长度为192byte或64个中文.
默认值为空.
最小长度:1最大长度:192enterprise_project_id否String企业项目ID.
非必选参数,当企业项目开关打开时需要传入该参数.
缺省值:0响应参数状态码:201表5-13响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
topic_urnStringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
状态码:400表5-14响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司18状态码:403表5-15响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-16响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-17响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例创建主题POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics{"name":"test_topic_v2","display_name":"testtest"}响应示例状态码:201OK消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司19{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","topic_urn":"urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2"}状态码状态码描述201OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
1.
3查询主题详情功能介绍查询Topic的详细信息.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/notifications/topics/{topic_urn}表5-18路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
topic_urn是StringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司20请求参数表5-19请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-20响应Body参数参数参数类型描述update_timeString更新时间.
时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ.
push_policyInteger消息推送的策略.
0表示发送失败,保留到失败队列,1表示直接丢弃发送失败的消息.
create_timeString创建时间.
时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ.
nameString创建Topic的名字.
topic_urnStringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
display_nameStringTopic的显示名,推送邮件消息时,作为邮件发件人显示.
request_idString请求的唯一标识ID.
enterprise_project_idString企业项目ID.
状态码:400表5-21响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司21参数参数类型描述messageString服务异常错误信息描述.
状态码:403表5-22响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-23响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-24响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例查询主题详情GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2null消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司22响应示例状态码:200OK{"update_time":"2016-08-01T02:16:38Z","push_policy":0,"create_time":"2016-08-01T02:16:38Z","name":"test_create_topic_v2","topic_urn":"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2","display_name":"testcreatetopicv2","request_id":"6837531fd3f54550927b930180a706bf","enterprise_project_id":"0"}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
1.
4更新主题功能介绍更新显示名.
调试您可以在APIExplorer中调试该接口.
URIPUT/v2/{project_id}/notifications/topics/{topic_urn}表5-25路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司23参数是否必选参数类型描述topic_urn是StringTopic的唯一的资源标识.
可以通过查看主题列表获取该标识.
请求参数表5-26请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
表5-27请求Body参数参数是否必选参数类型描述display_name是StringTopic的显示名,推送邮件消息时,作为邮件发件人显示.
显示名的长度为192byte或64个中文.
最小长度:1最大长度:192响应参数状态码:200表5-28响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400表5-29响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司24参数参数类型描述codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-30响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-31响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-32响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例更新主题PUThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司25{"display_name":"testtest222"}响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085"}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
1.
5删除主题功能介绍删除主题.
调试您可以在APIExplorer中调试该接口.
URIDELETE/v2/{project_id}/notifications/topics/{topic_urn}表5-33路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司26参数是否必选参数类型描述topic_urn是StringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
请求参数表5-34请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-35响应Body参数参数参数类型描述request_idString请求的唯一标识ID状态码:400表5-36响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-37响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司27参数参数类型描述codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-38响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-39响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例删除主题DELETEhttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2null响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085"}消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司28状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
1.
6查询主题策略功能介绍查询主题的策略信息.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/notifications/topics/{topic_urn}/attributes表5-40路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
topic_urn是StringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
表5-41Query参数参数是否必选参数类型描述name是String主题策略名称.
只支持特定的策略名称,请参见Topic属性表.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司29请求参数表5-42请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-43响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
attributesTopicAttributeobject属性的键值对.
access_policy:设置topic的方法的访问策略.
introduction:设置topic的简介.
表5-44TopicAttribute参数参数类型描述VersionString访问策略规范版本.
目前只支持"2016-09-07".
IdString策略的唯一标识.
不能为空.
StatementArrayofStatementobjects访问策略是通过Statement语句来定义的.
一个访问策略可包含一条或多条Statement语句.
通过Statement语句向其他用户或云服务授权对主题的操作.
表5-45Statement参数参数类型描述SidStringStatement语句的ID.
Statement语句ID必须是唯一的,例如statement01、statement02.
EffectStringStatement语句的效果.
"Allow"或者"Deny".
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司30参数参数类型描述PrincipalStringStatement语句作用的对象.
目前支持"CSP"和"Service"两类对象.
"CSP"对象指的是其他用户,可以作用于多个用户.
"Service"对象指的是云服务,可以作用于多个云服务.
Principal元素和NotPrincipal元素两者任选其一.
选定后,"CSP"对象填写内容的格式为urn:csp:iam::domainId:root,其中domainId为其他用户的"帐号ID".
"Service"对象填写内容的格式为小写的云服务名称缩写.
NotPrincipalStringNotPrincipal:Statement语句排除作用的对象.
目前支持"CSP"和"Service"两类对象.
"CSP"对象指的是其他用户,可以作用于多个用户.
"Service"对象指的是云服务,可以作用于多个云服务.
Principal元素和NotPrincipal元素两者任选其一.
选定后,"CSP"对象填写内容的格式为urn:csp:iam::domainId:root,其中domainId为其他用户的"帐号ID".
"Service"对象填写内容的格式为小写的云服务名称缩写.
ActionStringStatement语句作用的操作.
允许使用通配符来表示一类操作,例如:SMN:Update*、SMN:Delete*.
如果只填写"*",表示Statement语句作用的操作为该资源支持的所有操作.
Action元素和NotAction元素两者任选其一.
目前支持的操作有:SMN:UpdateTopicSMN:DeleteTopicSMN:QueryTopicDetailSMN:ListTopicAttributesSMN:UpdateTopicAttributeSMN:DeleteTopicAttributesSMN:DeleteTopicAttributeByNameSMN:ListSubscriptionsByTopicSMN:SubscribeSMN:UnsubscribeSMN:Publish消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司31参数参数类型描述NotActionStringStatement语句排除作用的操作.
允许使用通配符来表示一类操作,例如:SMN:Update*、SMN:Delete*.
如果只填写"*",表示Statement语句作用的操作为该资源支持的所有操作.
Action元素和NotAction元素两者任选其一.
目前支持的操作有:SMN:UpdateTopicSMN:DeleteTopicSMN:QueryTopicDetailSMN:ListTopicAttributesSMN:UpdateTopicAttributeSMN:DeleteTopicAttributesSMN:DeleteTopicAttributeByNameSMN:ListSubscriptionsByTopicSMN:SubscribeSMN:UnsubscribeSMN:PublishResourceStringStatement语句作用的主题.
Resource和NotResource两者任选其一.
选定后,填写内容为主题URN.
NotResourceStringStatement语句排除作用的主题.
Resource和NotResource两者任选其一.
选定后,填写内容为主题URN.
状态码:400表5-46响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司32表5-47响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-48响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-49响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例查询主题策略GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:test_create_topic_v2/attributesname=access_policynull响应示例状态码:200OK{"request_id":"6837531fd3f54550927b930180a706bf","attributes":{"access_policy":{消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司33"version":"2016-09-07","Id":"__default_policy_ID","Statement":[{"Sid":"__user_pub_0","Effect":"Allow","Principal":[{"CSP":["urn:csp:iam::93dc1b4697ac493d9b7d089569f86b32:root"]}],"Action":["SMN:Publish","SMN:QueryTopicDetail"],"Resource":"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:aaa"},{"Sid":"__service_pub_0","Effect":"Allow","Principal":[{"Service":["obs"]}],"Action":["SMN:Publish","SMN:QueryTopicDetail"],"Resource":"urn:smn:regionId:8bad8a40e0f7462f8c1676e3f93a8183:aaa"}]}}}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
1.
7删除所有主题策略功能介绍删除所有主题策略.
调试您可以在APIExplorer中调试该接口.
URIDELETE/v2/{project_id}/notifications/topics/{topic_urn}/attributes消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司34表5-50路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
topic_urn是StringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
请求参数表5-51请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-52响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400表5-53响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司35表5-54响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-55响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-56响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例DELETEhttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/attributesnull响应示例状态码:200OK{"request_id":"6837531fd3f54550927b930180a706bf"}消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司36状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
1.
8更新主题策略功能介绍更新主题的策略信息.
调试您可以在APIExplorer中调试该接口.
URIPUT/v2/{project_id}/notifications/topics/{topic_urn}/attributes/{name}表5-57路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
topic_urn是StringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
name是String主题策略名称.
只支持特定的策略名称,请参见Topic属性表.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司37请求参数表5-58请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
表5-59请求Body参数参数是否必选参数类型描述value是String1.
当请求参数name为access_policy时,value为Topic属性值,最大支持30KB.
2.
当请求参数name为introduction时,value为topic简介,最大长度120B.
响应参数状态码:200表5-60响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400表5-61响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司38表5-62响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-63响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-64响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例更新主题策略PUThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/attributes/access_policy{"value"Version\":\"2016-09-07\",\"Id\":\"__default_policy_ID\",\"Statement\Sid\":\"__user_pub_0\",\"Effect\":\"Allow\",\"Principal\":{\"CSP\":[\"urn:csp:iam::{domainID}:root\"]},\"Action\":[\"SMN:Publish\",\"SMN:QueryTopicDetail\"],\"Resource\":\"{topic_urn}Sid\":\"__service_pub_0\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"obs\Action\":[\"SMN:Publish\",\"SMN:QueryTopicDetail\"],\"Resource\":\"{topic_urn}}更新主题策略PUThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/attributes/introduction{"value":""}消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司39响应示例状态码:200OK{"request_id":"6837531fd3f54550927b930180a706bf"}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
1.
9删除指定名称的主题策略功能介绍删除指定名称的主题策略.
调试您可以在APIExplorer中调试该接口.
URIDELETE/v2/{project_id}/notifications/topics/{topic_urn}/attributes/{name}表5-65路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
topic_urn是StringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司40参数是否必选参数类型描述name是String主题策略名称.
只支持特定的策略名称,请参见Topic属性表.
请求参数表5-66请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-67响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400表5-68响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司41表5-69响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-70响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-71响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例删除指定名称的主题策略DELETEhttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/attributes/access_policynull响应示例状态码:200OK{"request_id":"6837531fd3f54550927b930180a706bf"}消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司42状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
2订阅操作5.
2.
1查询订阅者列表功能介绍分页返回请求者的所有的订阅列表,订阅列表按照订阅创建时间进行升序排列.
分页查询可以指定offset以及limit.
如果订阅者不存在,返回空列表.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/notifications/subscriptions表5-72路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司43表5-73Query参数参数是否必选参数类型描述offset否Integer偏移量.
偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0.
缺省值:0limit否Integer查询数量限制.
取值范围:1~100,取值一般为10,20,50.
功能说明:每页返回的资源个数.
默认值为100.
缺省值:100请求参数表5-74请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-75响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
subscription_countInteger订阅者个数.
subscriptionsArrayofListSubscriptionsItemobjectsSubscription结构体.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司44表5-76ListSubscriptionsItem参数参数类型描述topic_urnStringTopic的唯一的资源标识.
protocolString不同协议对应不同的endpoint(接受消息的接入点).
目前支持的协议包括:"email":邮件传输协议,endpoint为邮箱地址.
"sms":短信传输协议,endpoint为手机号码.
"functionstage":FunctionGraph(函数)传输协议,endpoint为一个函数.
"functiongraph":FunctionGraph(工作流)传输协议,endpoint为由一组函数编排成的工作流.
"http"、"https":HTTP/HTTPS传输协议,endpoint为URL.
subscription_urnString订阅者的唯一资源标识.
ownerStringTopic创建者的项目ID.
endpointString接受消息的接入点.
remarkString备注.
statusInteger订阅者状态:0表示订阅还未确认,1表示已经确认,3表示已经取消确认.
状态码:400表5-77响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司45表5-78响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-79响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-80响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例查询订阅者列表GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/subscriptionsoffset=0&limit=2null响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","subscription_count":2,"subscriptions":[{"topic_urn":"urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1",消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司46"protocol":"sms","subscription_urn":"urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837","owner":"762bdb3251034f268af0e395c53ea09b","endpoint":"xxxxxxxxxxx","remark":"","status":0},{"topic_urn":"urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1","protocol":"email","subscription_urn":"urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:a2d52a9f5c3b47f48c3fafb177a58796","owner":"762bdb3251034f268af0e395c53ea09b","endpoint":"xx@xx.
com","remark":"","status":0}]}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
2.
2查询指定Topic的订阅者列表功能介绍分页获取特定Topic的订阅列表,订阅列表按照订阅创建时间进行升序排列.
分页查询可以指定offset以及limit.
如果指定Topic不存在订阅者,返回空列表.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/notifications/topics/{topic_urn}/subscriptions消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司47表5-81路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
topic_urn是StringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
表5-82Query参数参数是否必选参数类型描述offset否Integer偏移量.
偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0.
缺省值:0limit否Integer查询的数量限制.
取值范围:1~100,取值一般为10,20,50.
功能说明:每页返回的资源个数.
默认值为100.
缺省值:100请求参数表5-83请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司48表5-84响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
subscription_countInteger订阅者个数.
subscriptionsArrayofListSubscriptionsItemobjectsSubscription结构体.
表5-85ListSubscriptionsItem参数参数类型描述topic_urnStringTopic的唯一的资源标识.
protocolString不同协议对应不同的endpoint(接受消息的接入点).
目前支持的协议包括:"email":邮件传输协议,endpoint为邮箱地址.
"sms":短信传输协议,endpoint为手机号码.
"functionstage":FunctionGraph(函数)传输协议,endpoint为一个函数.
"functiongraph":FunctionGraph(工作流)传输协议,endpoint为由一组函数编排成的工作流.
"http"、"https":HTTP/HTTPS传输协议,endpoint为URL.
subscription_urnString订阅者的唯一资源标识.
ownerStringTopic创建者的项目ID.
endpointString接受消息的接入点.
remarkString备注.
statusInteger订阅者状态:0表示订阅还未确认,1表示已经确认,3表示已经取消确认.
状态码:400消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司49表5-86响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-87响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-88响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-89响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例查询指定Topic的订阅者列表消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司50GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1/subscriptionsoffset=0&limit=100null响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","subscription_count":2,"subscriptions":[{"topic_urn":"urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1","protocol":"sms","subscription_urn":"urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837","owner":"762bdb3251034f268af0e395c53ea09b","endpoint":"xxxxxxxxxxx","remark":"","status":0},{"topic_urn":"urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1","protocol":"email","subscription_urn":"urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:a2d52a9f5c3b47f48c3fafb177a58796","owner":"762bdb3251034f268af0e395c53ea09b","endpoint":"xx@xx.
com","remark":"","status":0}]}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
2.
3订阅功能介绍为指定Topic添加一个订阅者,如果订阅者的状态为未确认,则向订阅者发送一个确认的消息.
待订阅者进行ConfirmSubscription确认后,该订阅者才能收到Topic发布的消消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司51息.
单Topic默认可添加10000个订阅者,高并发场景下,可能会出现订阅者数量超过10000仍添加成功的情况,此为正常现象.
接口是幂等的,如果添加已存在的订阅者,则返回成功,且statuscode为200,否则statuscode为201.
调试您可以在APIExplorer中调试该接口.
URIPOST/v2/{project_id}/notifications/topics/{topic_urn}/subscriptions表5-90路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
topic_urn是StringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
请求参数表5-91请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司52表5-92请求Body参数参数是否必选参数类型描述endpoint是String说明:http协议,接入点必须以"http://"开头.
https协议,接入点必须以"https://"开头.
email协议,接入点必须是邮件地址.
sms协议,接入点必须是一个电话号码.
functionstage协议,接入点必须是一个函数.
functiongraph协议,接入点必须是一个函数工作流.
dms协议,接入点必须是一个消息队列.
application协议,接入点必须是一个应用平台的设备终端.
callnotify协议,接入点必须是一个电话号码.
protocol是String不同协议对应不同的endpoint(接受消息的接入点).
目前支持的协议包括:"email":邮件传输协议,endpoint为邮箱地址.
"default""sms":短信传输协议,endpoint为手机号码.
"functionstage":FunctionGraph(函数)传输协议,endpoint为一个函数.
"functiongraph":FunctionGraph(工作流)传输协议,endpoint为由一组函数编排成的工作流.
"http"、"https":HTTP/HTTPS传输协议,endpoint为URL.
"callnotify":语音通知传输协议,endpoint为手机号码.
remark是String备注.
最大支持128字节,约42个中文,必须是UTF-8编码的字符串,否则无法正常显示中文.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司53响应参数状态码:201表5-93响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
subscription_urnString订阅者的唯一资源标识.
状态码:400表5-94响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-95响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-96响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司54状态码:500表5-97响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例为指定Topic添加一个订阅者POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1/subscriptions{"protocol":"email","endpoint":"xxx@xxx.
com","remark":"运维"}响应示例状态码:201OK[{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","subscription_urn":"urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837"}]状态码状态码描述201OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司555.
2.
4取消订阅功能介绍删除指定的订阅者.
调试您可以在APIExplorer中调试该接口.
URIDELETE/v2/{project_id}/notifications/subscriptions/{subscription_urn}表5-98路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
subscription_urn是String订阅者的唯一资源标识.
请求参数表5-99请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-100响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司56表5-101响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-102响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-103响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-104响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例取消订阅消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司57DELETEhttps://{SMN_Endpoint}/v2/{project_id}/notifications/subscriptions/urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837null响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085"}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
3模板操作5.
3.
1查询消息模板列表功能介绍分页查询模板列表,模板列表按照创建时间进行升序排列.
分页查询可以指定offset以及limit.
如果不存在模板,则返回空列表.
额外的查询参数分别有message_template_name和protocol.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/notifications/message_template消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司58表5-105路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
表5-106Query参数参数是否必选参数类型描述offset否Integer偏移量,偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0.
缺省值:0limit否Integer取值范围:1~100,取值一般为10,20,50.
功能说明:每页返回的资源个数.
默认值为100.
缺省值:100message_template_name否String模板的名称.
只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度在1到64个字符之间.
protocol否String模板支持的协议类型.
目前支持的协议包括:default:默认协议.
email:邮件传输协议.
sms:短信传输协议.
functionstage:FunctionGraph(函数)传输协议.
functiongraph:FunctionGraph(工作流)传输协议.
dms:DMS传输协议.
http、https:HTTP/HTTPS传输协议.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司59请求参数表5-107请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-108响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
message_template_countInteger返回的模板个数.
message_templatesArrayofMessageTemplateobjectsMessage_template结构体数组.
表5-109MessageTemplate参数参数类型描述message_template_idString模板ID.
message_template_nameString模板名称.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司60参数参数类型描述protocolString模板协议类型.
目前支持的协议包括:default:默认协议.
email:邮件传输协议.
sms:短信传输协议.
functionstage:FunctionGraph(函数)传输协议.
functiongraph:FunctionGraph(工作流)传输协议.
dms:DMS传输协议.
http、https:HTTP/HTTPS传输协议.
tag_namesArrayofstrings模板tag列表.
create_timeString模板创建时间.
时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ.
update_timeString模板最后更新时间.
时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ.
状态码:400表5-110响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-111响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司61状态码:404表5-112响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-113响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例查询消息模板列表GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/message_templateoffset=0&limit=2&message_template_name=test1&protocol=emailnull响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","message_template_count":3,"message_templates":[{"message_template_name":"confirm_message","protocol":"sms","update_time":"2016-08-02T08:22:18Z","create_time":"2016-08-02T08:22:18Z","tag_names":["topic_urn"],"message_template_id":"79227dfdf88d4e52a1820ca1eb411635"},{"message_template_name":"confirm_message","protocol":"email","update_time":"2016-08-02T08:22:19Z","create_time":"2016-08-02T08:22:19Z","tag_names":["topic_id"],"message_template_id":"ecf63465804a4b10a0573980be78ffba"},{消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司62"message_template_name":"confirm_message","protocol":"https","update_time":"2016-08-02T08:22:20Z","create_time":"2016-08-02T08:22:20Z","tag_names":["topic_id"],"message_template_id":"57ba8dcecda844878c5dd5815b65d10f"}]}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
3.
2创建消息模板功能介绍创建一个模板,用户可以按照模板去发送消息,这样可以减少请求的数据量.
单用户默认可创建100个消息模板,高并发场景下,可能会出现消息模板数量超过100仍创建成功的情况,此为正常现象.
调试您可以在APIExplorer中调试该接口.
URIPOST/v2/{project_id}/notifications/message_template表5-114路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司63请求参数表5-115请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
表5-116请求Body参数参数是否必选参数类型描述message_template_name是String创建模板的名称.
只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度在1到64个字符之间.
protocol是String模板支持的协议类型.
目前支持的协议包括:default:默认协议.
email:邮件传输协议.
sms:短信传输协议.
functionstage:FunctionGraph(函数)传输协议.
functiongraph:FunctionGraph(工作流)传输协议.
dms:DMS传输协议.
http、https:HTTP/HTTPS传输协议.
content是String模板内容,模板目前仅支持纯文本模式.
模板内容不能空,最大支持256KB.
响应参数状态码:201消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司64表5-117响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
message_template_idString模板唯一的资源标识.
状态码:400表5-118响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-119响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-120响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司65表5-121响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例创建消息模板POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/message_template{"message_template_name":"confirm_message","protocol":"https","content":"(1/2)Youareinvitedtosubscribetotopic({topic_id}).
ClickthefollowingURLtoconfirmsubscription:(Ifyoudonotwanttosubscribetothistopic,ignorethismessage.
)"}响应示例状态码:201OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","message_template_id":"57ba8dcecda844878c5dd5815b65d10f"}状态码状态码描述201OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司665.
3.
3查询消息模板详情功能介绍查询模板详情,包括模板内容.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/notifications/message_template/{message_template_id}表5-122路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
message_template_id是String模板唯一的资源标识,可通过查询消息模板列表获取该标识.
请求参数表5-123请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-124响应Body参数参数参数类型描述message_template_idString模板ID.
message_template_nameString模板名称.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司67参数参数类型描述protocolString模板支持的协议类型.
目前支持的协议包括:default:默认协议.
email:邮件传输协议.
sms:短信传输协议.
functionstage:FunctionGraph(函数)传输协议.
functiongraph:FunctionGraph(工作流)传输协议.
dms:DMS传输协议.
http、https:HTTP/HTTPS传输协议.
tag_namesArrayofstrings模板tag列表.
是消息模板"{}"内的字段,在具体使用消息模板时,可根据实际情况替为该字段赋值.
create_timeString模板创建时间.
时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ.
update_timeString模板最后更新时间.
时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ.
contentString模板内容.
request_idString请求的唯一标识ID.
请求示例查询消息模板详情GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/message_template/57ba8dcecda844878c5dd5815b65d10fnull响应示例状态码:200OK{"message_template_id":"57ba8dcecda844878c5dd5815b65d10f","message_template_name":"confirm_message","protocol":"https","tag_names":["topic_id_id4"],"create_time":"2016-08-02T08:22:20Z","update_time":"2016-08-02T08:22:25Z","content":"(1/24)Youareinvitedtosubscribetotopic({topic_id_id4}).
ClickthefollowingURLtoconfirmsubscription:(Ifyoudonotwanttosubscribetothistopic,ignorethismessage.
)","request_id":"ba79ca8f794f4f50985ce7b98a401b47"}消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司68状态码状态码描述200OK错误码请参见错误码.
5.
3.
4更新消息模板功能介绍修改消息模板的内容.
调试您可以在APIExplorer中调试该接口.
URIPUT/v2/{project_id}/notifications/message_template/{message_template_id}表5-125路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
message_template_id是String模板唯一的资源标识,可通过查询消息模板列表获取该标识.
请求参数表5-126请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司69表5-127请求Body参数参数是否必选参数类型描述content是String模板内容.
响应参数状态码:200表5-128响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400表5-129响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-130响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-131响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司70参数参数类型描述codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-132响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例更新消息模板PUThttps://{SMN_Endpoint}/v2/{project_id}/notifications/message_template/b3ffa2cdda574168826316f0628f774f{"content":"(1/22)Youareinvitedtosubscribetotopic({topic_id_id1}).
ClickthefollowingURLtoconfirmsubscription:(Ifyoudonotwanttosubscribetothistopic,ignorethismessage.
)"}响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085"}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司71错误码请参见错误码.
5.
3.
5删除消息模板功能介绍删除消息模板.
删除模板之前的消息请求都可以使用该模板发送,删除之后无法再使用该模板发送消息.
调试您可以在APIExplorer中调试该接口.
URIDELETE/v2/{project_id}/notifications/message_template/{message_template_id}表5-133路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
message_template_id是String模板唯一的资源标识,可通过查询消息模板列表获取该标识.
请求参数表5-134请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司72表5-135响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400表5-136响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-137响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-138响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司73表5-139响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例删除消息模板DELETEhttps://{SMN_Endpoint}/v2/{project_id}/notifications/message_template/b3ffa2cdda574168826316f0628f774enull响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085"}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
4发布消息操作消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司745.
4.
1消息发布功能介绍将消息发送给Topic的所有订阅端点.
当返回消息ID时,该消息已被保存并开始尝试将其推送给Topic的订阅者.
三种消息发送方式messagemessage_structuremessage_template_name只需要设置其中一个,如果同时设置,生效的优先级为message_structure>message_template_name>message.
调试您可以在APIExplorer中调试该接口.
URIPOST/v2/{project_id}/notifications/topics/{topic_urn}/publish表5-140路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
topic_urn是StringTopic的唯一的资源标识,可通过查询主题列表获取该标识.
请求参数表5-141请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司75表5-142请求Body参数参数是否必选参数类型描述subject是String消息标题,给邮箱订阅者发送邮件时作为邮件主题,长度不能超过512个字符.
message否String发送的消息.
消息体必须是UTF-8编码的字符串,大小至多256KB.
如果订阅者是手机号码,长度不超过490个字符,超出部分系统自动截断.
短信内容不能包含"[]"或者"【】"符号.
对于移动推送订阅者推送消息,message消息必须符合移动推送平台的消息格式,消息格式请参见application消息体格式.
否则移动app无法收到消息,目前支持的平台有HMS、APNS、APNS_SANDBOX.
说明参数"message"、"message_structure"、"message_template_name"至少需要设置一个,如果同时设置,生效的优先级为:message_structure>message_template_name>message.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司76参数是否必选参数类型描述message_structure否StringJson格式的字符串.
支持"email"、"sms"、"http"、"https"、"dms"、"functiongraph"、"functionstage"、"HMS"、"APNS"以及"APNS_SANDBOX".
其中,"HMS"、"APNS"以及"APNS_SANDBOX"三种消息的格式请参见application消息体格式.
必须设置默认的消息"default",当匹配不到消息协议时,按"default"中的内容发送.
说明参数"message"、"message_structure"、"message_template_name"至少需要设置一个,如果同时设置,生效的优先级为:message_structure>message_template_name>message.
message_template_name否String消息模板名称,可通过查询消息模板列表获取名称.
三种消息发送方式:messagemessage_structuremessage_template_name三种方式至少需要设置其中一个,如果同时设置,生效的优先级为:message_structure>message_template_name>message.
tags否Maptag以及替换tag的参数组成的字典.
消息模板中的标签对应的值.
使用消息模板方式的消息发布必须携带该参数.
字典中的key为消息模板中的参数名称,不超过21个字符.
字典中的value为消息模板中的参数被替换后的值,不超过1KB.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司77参数是否必选参数类型描述time_to_live是String指消息在SMN系统内部的最长存留时间.
超过该存留时间,系统将不再发送该消息.
单位是s,变量默认值是3600s,即一小时.
值为正整数且小于等于3600*24.
响应参数状态码:200表5-143响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
message_idString唯一的消息ID.
状态码:400表5-144响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-145响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司78表5-146响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-147响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例消息发布POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/publish{"subject":"testmessagev2","message":"Messagetestmessagev2","time_to_live":"3600"}使用消息结构体方式的消息发布POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/publish{"subject":"testmessagev2","message_structure":{"default":"testv2default","email":"abc","APNS":{"aps":{"alert":"helloworldapnsproduction"}}},"time_to_live":"3600"}使用消息模板方式的消息发布POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/publish{"subject":"testmessagetemplatev2","message_template_name":"confirm_message","time_to_live":"3600",消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司79"tags":{"topic_urn":"topic_urn3331","topic_id":"topic_id3332"}}响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","message_id":"bf94b63a5dfb475994d3ac34664e24f2"}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
5使用标签管理服务5.
5.
1查询资源实例功能介绍使用标签过滤实例.
调试您可以在APIExplorer中调试该接口.
URIPOST/v2/{project_id}/{resource_type}/resource_instances/action消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司80表5-148路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
resource_type是String资源类型,目前有:smn_topic,主题smn_sms,短信smn_application,移动推送请求参数表5-149请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
表5-150请求Body参数参数是否必选参数类型描述tags否ArrayofResourceTagsobjects最多包含10个key,每个key最多包含10个value,结构体不能缺失.
key不能为空或者空字符串.
key不能重复,同一个key中value不能重复,不同key对应的资源之间为与的关系.
tags_any否ArrayofResourceTagsobjects最多包含10个key,每个key最多包含10个value,结构体不能缺失.
key不能为空或者空字符串.
key不能重复,同一个key中value不能重复,不同key对应的资源之间为或的关系.
not_tags否ArrayofResourceTagsobjects最多包含10个key,每个key最多包含10个value,结构体不能缺失.
key不能为空或者空字符串.
key不能重复,同一个key中value不能重复,不同key对应的资源之间为与非的关系.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司81参数是否必选参数类型描述not_tags_any否ArrayofResourceTagsobjects最多包含10个key,每个key最多包含10个value,结构体不能缺失.
key不能为空或者空字符串.
key不能重复,同一个key中value不能重复,不同key对应的资源之间为或非的关系.
offset否String索引位置,从offset指定的下一条数据开始查询.
查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据时响应体中的值带入此参数.
action为count时无此参数.
action为filter时,默认为0,必须为数字,且不能为负数.
缺省值:0limit否String查询记录数.
action为count时无此参数.
action为filter时,默认为1000.
limit最多为1000,不能为负数,最小值为1.
缺省值:1000action是String操作标识(仅限于filter,count):filter(过滤),count(查询总条数).
为filter时表示分页查询,为count只需按照条件将总条数返回即可.
matches否ArrayofTagMatchobjects搜索字段.
key为要匹配的字段,当前只支持resource_name.
value为匹配的值,当前为精确匹配.
表5-151ResourceTags参数是否必选参数类型描述key是String键.
最大长度127个unicode字符.
key不能为空.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司82参数是否必选参数类型描述values是Arrayofstrings值列表.
最多10个value.
value不允许重复.
每个值最大长度255个unicode字符.
如果values为空则表示any_value.
value之间为或的关系.
表5-152TagMatch参数是否必选参数类型描述key是String键,表示要匹配的字段.
当前key的参数值只能取"resource_name",此时value的参数值为云服务器名称.
key不能重复,value为匹配的值.
此字段为固定字典值.
不允许为空字符串.
value是String值.
当前key的参数值只能取"resource_name",此时value的参数值为云服务器名称.
每个值最大长度255个unicode字符.
不可以为空.
响应参数状态码:200表5-153响应Body参数参数参数类型描述resourcesArrayofTagResourceobjects返回的资源列表.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司83参数参数类型描述total_countInteger总记录数.
表5-154TagResource参数参数类型描述resource_idString资源ID.
resource_detailResourceDetailobject资源详情.
资源对象,用于扩展.
默认为空.
对于topic资源类型,该字段内容为{"topic_urn":"${TopicUrn}","display_name":"displayname"};对于其它资源类型为null.
tagsArrayofResourceTagobjects标签列表.
resource_nameString资源名称.
表5-155ResourceDetail参数参数类型描述enterprise_project_idString企业项目IDdetailIdString详情IDtopic_urnStringtopic唯一标识display_nameString显示名消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司84表5-156ResourceTag参数参数类型描述keyString键,表示要匹配的字段.
当前key的参数值只能取"resource_name",此时value的参数值为云服务器名称.
key不能重复,value为匹配的值.
此字段为固定字典值.
不允许为空字符串.
valueString值.
当前key的参数值只能取"resource_name",此时value的参数值为云服务器名称.
每个值最大长度255个unicode字符.
不可以为空.
状态码:400表5-157响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-158响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司85表5-159响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-160响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例使用标签过滤资源实例POSThttps://{SMN_Endpoint}/v2/{project_id}/{resource_type}/resource_instances/action{"offset":"100","limit":"100","action":"filter","matches":[{"key":"resource_name","value":"resource1"}],"not_tags":[{"key":"key1","values":["*value1","value2"]},{"key":"key2","values":["*value21","value22"]}],"tags":[{"key":"key1","values":["*value1","value2"]}],"tags_any":[{"key":"key1","values":["value1","value2"]}],"not_tags_any":[{"key":"key1","values":["value1","value2"]}]}使用标签查询资源实例总数POSThttps://{SMN_Endpoint}/v2/{project_id}/{resource_type}/resource_instances/action{消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司86"action":"count","not_tags":[{"key":"key1","values":["value1","*value2"]}],"tags":[{"key":"key1","values":["value1","value2"]}],"tags_any":[{"key":"key1","values":["value1","value2"]}],"not_tags_any":[{"key":"key1","values":["value1","value2"]}],"matches":[{"key":"resource_name","value":"resource"}]}响应示例状态码:200OK{"resources":{"resource_detail":{"topic_urn":"urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:resource1","display_name":"testtest","enterprise_project_id":"0"},"resource_id":"cffe4fc4c9a54219b60dbaf7b586e132","resource_name":"resource1","tags":[{"key":"key1","value":"value1"}]},"total_count":1000}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司875.
5.
2批量添加删除资源标签功能介绍为指定实例批量添加或删除标签.
一个资源上最多有10个标签.
此接口为幂等接口:创建时如果请求体中存在重复key则报错.
创建时,不允许重复key,如果数据库存在就覆盖.
删除时,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验.
调试您可以在APIExplorer中调试该接口.
URIPOST/v2/{project_id}/{resource_type}/{resource_id}/tags/action表5-161路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
resource_type是String资源类型,目前有:smn_topic,主题smn_sms,短信smn_application,移动推送resource_id是String资源ID.
获取resource_id的方法:当resource_type为"smn_topic"时,手动添加请求消息头"X-SMN-RESOURCEID-TYPE=name",资源ID即为topic名称.
不添加请求消息头,通过"查询资源实例",获取资源ID.
当resource_type为"smn_sms"时,resource_id为签名ID.
您可在控制台获取.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司88请求参数表5-162请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
表5-163请求Body参数参数是否必选参数类型描述tags是ArrayofResourceTagobjects标签列表,结构体说明请参见表5-164.
删除时tags结构体不能缺失,key不能为空或空字符串,且不针对字符集范围进行校验.
action是String操作标识:仅限于create(创建)、delete(删除).
表5-164ResourceTag参数是否必选参数类型描述key是String键,表示要匹配的字段.
当前key的参数值只能取"resource_name",此时value的参数值为云服务器名称.
key不能重复,value为匹配的值.
此字段为固定字典值.
不允许为空字符串.
value是String值.
当前key的参数值只能取"resource_name",此时value的参数值为云服务器名称.
每个值最大长度255个unicode字符.
不可以为空.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司89响应参数状态码:400表5-165响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-166响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-167响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-168响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司90请求示例批量添加资源标签POSThttps://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tags/action{"action":"create","tags":[{"key":"key1","value":"value1"},{"key":"key","value":"value3"}]}批量删除资源标签POSThttps://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tags/action{"action":"delete","tags":[{"key":"key1"},{"key":"key2","value":"value3"}]}响应示例无状态码状态码描述204OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
5.
3查询资源标签功能介绍查询指定实例的标签信息.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司91调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/{resource_type}/{resource_id}/tags表5-169路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
resource_type是String资源类型.
目前有:主题:smn_topic.
短信:smn_sms.
移动推送:smn_application.
resource_id是String资源ID.
获取resource_id的方法:当resource_type为"smn_topic"时,手动添加请求消息头"X-SMN-RESOURCEID-TYPE=name",资源ID即为topic名称.
不添加请求消息头,通过"查询资源实例",获取资源ID.
当resource_type为"smn_sms"时,resource_id为签名ID.
您可在控制台获取.
请求参数表5-170请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司92表5-171响应Body参数参数参数类型描述tagsArrayofResourceTagobjects资源标签列表.
表5-172ResourceTag参数参数类型描述keyString键,表示要匹配的字段.
当前key的参数值只能取"resource_name",此时value的参数值为云服务器名称.
key不能重复,value为匹配的值.
此字段为固定字典值.
不允许为空字符串.
valueString值.
当前key的参数值只能取"resource_name",此时value的参数值为云服务器名称.
每个值最大长度255个unicode字符.
不可以为空.
状态码:400表5-173响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-174响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司93参数参数类型描述messageString服务异常错误信息描述.
状态码:404表5-175响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-176响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例查询资源标签GEThttps://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tagsnull响应示例状态码:200OK{"tags":[{"key":"key1","value":"value1"},{"key":"key2","value":"value3"}]}消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司94状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
5.
4添加资源标签功能介绍一个资源上最多有10个标签.
此接口为幂等接口:创建时,如果创建的标签已经存在(key相同),则覆盖.
调试您可以在APIExplorer中调试该接口.
URIPOST/v2/{project_id}/{resource_type}/{resource_id}/tags表5-177路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
resource_type是String资源类型,目前有:smn_topic,主题smn_sms,短信smn_application,移动推送消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司95参数是否必选参数类型描述resource_id是String资源ID.
获取resource_id的方法:当resource_type为"smn_topic"时,手动添加请求消息头"X-SMN-RESOURCEID-TYPE=name",资源ID即为topic名称.
不添加请求消息头,通过"查询资源实例",获取资源ID.
当resource_type为"smn_sms"时,resource_id为签名ID.
您可在控制台获取.
请求参数表5-178请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
表5-179请求Body参数参数是否必选参数类型描述tag是tagobject资源标签结构体.
表5-180tag参数是否必选参数类型描述key是String键,表示要匹配的字段.
当前key的参数值只能取"resource_name",此时value的参数值为云服务器名称.
key不能重复,value为匹配的值.
此字段为固定字典值.
不允许为空字符串.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司96参数是否必选参数类型描述value是String值.
当前key的参数值只能取"resource_name",此时value的参数值为云服务器名称.
每个值最大长度255个unicode字符.
不可以为空.
响应参数状态码:400表5-181响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-182响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-183响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司97状态码:500表5-184响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例添加资源标签POSThttps://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tags{"tag":{"key":"DEV","value":"DEV1"}}响应示例无状态码状态码描述204OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司985.
5.
5查询项目标签功能介绍查询租户在指定Region和实例类型的所有标签集合.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/{resource_type}/tags表5-185路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
resource_type是String资源类型.
目前有:主题:smn_topic.
短信:smn_sms.
移动推送:smn_application.
请求参数表5-186请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司99表5-187响应Body参数参数参数类型描述tagsArrayofResourceTagsobjects资源标签列表.
表5-188ResourceTags参数参数类型描述keyString键.
最大长度127个unicode字符.
key不能为空.
valuesArrayofstrings值列表.
最多10个value.
value不允许重复.
每个值最大长度255个unicode字符.
如果values为空则表示any_value.
value之间为或的关系.
状态码:400表5-189响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-190响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司100状态码:404表5-191响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-192响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例查询项目标签GEThttps://{SMN_Endpoint}/v2/{project_id}/{resource_type}/tagsnull响应示例状态码:200OK{"tags":[{"key":"key1","value":["value1","value2"]},{"key":"key2","value":["value1","value2"]}]}状态码状态码描述200OK消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司101状态码描述400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
5.
6删除资源标签功能介绍幂等接口:删除时,不对标签做校验.
删除的key不存在报404,key不能为空或者空字符串.
调试您可以在APIExplorer中调试该接口.
URIDELETE/v2/{project_id}/{resource_type}/{resource_id}/tags/{key}表5-193路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
resource_type是String资源类型,目前有:smn_topic,主题.
smn_sms,短信.
smn_application,移动推送.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司102参数是否必选参数类型描述resource_id是String资源ID.
获取resource_id的方法:当resource_type为"smn_topic"时,手动添加请求消息头"X-SMN-RESOURCEID-TYPE=name",资源ID即为topic名称.
不添加请求消息头,通过"查询资源实例",获取资源ID.
当resource_type为"smn_sms"时,resource_id为签名ID.
您可在控制台获取.
key是String待删除标签的key值.
请求参数表5-194请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:400表5-195响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司103表5-196响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-197响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-198响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例删除资源标签DELETEhttps://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tags/{key}null响应示例无消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司104状态码状态码描述204OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
6Application操作5.
6.
1查询Application功能介绍查询应用平台列表.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/notifications/applications表5-199路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司105表5-200Query参数参数是否必选参数类型描述offset否Integer偏移量.
偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0.
缺省值:0limit否Integer查询的数量限制.
取值范围:1~100,取值一般为10,20,50.
功能说明:每页返回的资源个数.
默认值为100.
缺省值:100name否String检索应用名称.
支持后向模糊匹配,长度不得超过64个字符,只能包含英文字母、下划线和数字.
platform否String应用平台.
目前仅支持HMS、APNS、APNS_SANDBOX.
HMS是为开发者提供的消息推送平台.
APNS和APNS_SANDBOX是用于推送iOS消息的服务平台.
请求参数表5-201请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司106表5-202响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
application_countInteger返回的Application个数.
该参数不受offset和limit影响,即返回的是您帐户下所有的Application个数.
applicationsArrayofApplicationItemobjects详见表5-203.
表5-203ApplicationItem参数参数类型描述nameString创建application的名字.
platformString应用平台.
create_timeString创建application的时间.
时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ.
application_urnStringApplication的唯一资源标识.
application_idStringApplication的唯一标识ID.
enabledString应用平台是否启用.
apple_certificate_expiration_dateString苹果证书过期时间APNS、APNS_SANDBOX平台特有属性时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ.
状态码:400表5-204响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司107表5-205响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-206响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-207响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/applicationsoffset=0&limit=100&name=application_name&platform=APNSnull响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","application_count":2,"applications":[{"create_time":"2018-02-08T08:30:16Z","apple_certificate_expiration_date":"2018-03-09T12:21:40Z","name":"application_name001",消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司108"platform":"APNS","enabled":"true","application_urn":"urn:smn:regionId:429ffced18074da0938112f2c362b935:app-APNS-application_name001","application_id":"b1b8643dc12b4g77ad6e35a16003119b"},{"create_time":"2018-01-11T12:58:58Z","apple_certificate_expiration_date":"2018-03-09T12:21:40Z","name":"application_name002","platform":"APNS","enabled":"true","application_urn":"urn:smn:regionId:429ffced18074da0938112f2c362b935:app-APNS-application_name002","application_id":"a3a4643dc12b4g77ad6e35a16002558c"}]}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
6.
2创建Application功能介绍创建平台应用.
调试您可以在APIExplorer中调试该接口.
URIPOST/v2/{project_id}/notifications/applications表5-208路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司109请求参数表5-209请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
表5-210请求Body参数参数是否必选参数类型描述name是String应用名.
最大支持64个字符,只能包含英文字母、下划线和数字.
platform是String应用平台.
目前仅支持HMS、APNS、APNS_SANDBOX.
HMS是为开发者提供的消息推送平台.
APNS和APNS_SANDBOX是用于推送iOS消息的服务平台.
platform_principal是String对于HMS平台是APPID,只能包含英文字母和数字,最大20个字符.
对于苹果APNS、APNS_SandBox平台是推送证书,大小不超过8K,且是Base64编码.
platform_credential是String对于HMS平台是APPSECRET,只能包含英文字母和数字,32到64个字符.
对于苹果APNS、APNS_SandBox平台是推送证书的私钥(privatekey),大小不超过8K,且是Base64编码.
响应参数状态码:201消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司110表5-211响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
application_urnStringApplication的唯一资源标识.
application_idStringApplication资源的ID.
状态码:400表5-212响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-213响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-214响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司111表5-215响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例创建ApplicationPOSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/applications{"name":"application_name","platform":"HMS","platform_principal":"appId","platform_credential":"appSecret"}响应示例无状态码状态码描述201OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
6.
3查询Application属性功能介绍获取应用平台属性.
调试您可以在APIExplorer中调试该接口.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司112URIGET/v2/{project_id}/notifications/applications/{application_urn}表5-216路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
application_urn是StringApplication的唯一资源标识,可通过查询Application获取该标识.
请求参数表5-217请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-218响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
application_idStringApplication的唯一标识ID.
attributes表5-219object-表5-219ApplicationAttribute参数参数类型描述enabledString应用平台是否启用.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司113参数参数类型描述apple_certificate_expiration_dateString苹果证书过期时间,APNS、APNS_SANDBOX平台特有属性.
时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ.
状态码:400表5-220响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-221响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-222响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司114表5-223响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}null响应示例状态码:200OK{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","application_id":"b1b8643dc12b4g77ad6e35a16003119b","attributes":{"enabled":"true","apple_certificate_expiration_date":"2018-03-09T12:21:40Z"}}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
6.
4更新Application功能介绍更新应用平台.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司115调试您可以在APIExplorer中调试该接口.
URIPUT/v2/{project_id}/notifications/applications/{application_urn}表5-224路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
application_urn是StringApplication的唯一资源标识,可通过查询Application获取该标识.
请求参数表5-225请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
表5-226请求Body参数参数是否必选参数类型描述platform_principal是String对于HMS平台是APPID,只能包含英文字母和数字,最大20个字符.
对于苹果APNS、APNS_SandBox平台是推送证书,大小不超过8K,且是Base64编码.
platform_credential是String对于HMS平台是APPSECRET,只能包含英文字母和数字,32到64个字符.
对于苹果APNS、APNS_SandBox平台是推送证书的私钥(privatekey),大小不超过8K,且是Base64编码.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司116响应参数状态码:200表5-227响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400表5-228响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-229响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-230响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司117状态码:500表5-231响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例更新应用平台PUThttps://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}{"platform_principal":"appId","platform_credential":"appSecret"}响应示例无状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
6.
5删除Application功能介绍删除平台应用.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司118调试您可以在APIExplorer中调试该接口.
URIDELETE/v2/{project_id}/notifications/applications/{application_urn}表5-232路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
application_urn是StringApplication的唯一资源标识,可通过查询Application获取该标识.
请求参数表5-233请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-234响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400表5-235响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司119参数参数类型描述codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-236响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-237响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-238响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例删除平台应用DELETEhttps://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}{消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司120"platform_principal":"appId","platform_credential":"appSecret"}响应示例无状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
7Applicationendpoint操作5.
7.
1查询Application的Endpoint列表功能介绍查询平台的endpoint列表.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/notifications/applications/{application_urn}/endpoints表5-239路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司121参数是否必选参数类型描述application_urn是StringApplication的唯一资源标识,可通过查询Application获取该标识.
表5-240Query参数参数是否必选参数类型描述offset否Integer偏移量.
偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0.
缺省值:0limit否Integer查询的数量限制.
取值范围:1~100,取值一般为10,20,50.
功能说明:每页返回的资源个数.
默认值为100.
缺省值:100enabled否String设备是否可用,值为true或false字符串.
token否String设备token,最大长度512个字节.
user_data否String用户数据,最大长度2048个字节.
请求参数表5-241请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司122表5-242响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
next_page_flagBoolean是否有下一页标识.
endpointsArrayofApplicationEndpointobjectsApplication_endpoint结构体数.
表5-243ApplicationEndpoint参数参数类型描述create_timeString创建application的时间.
时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ.
endpoint_urnStringApplicationendpoint的唯一资源标识.
user_dataString用户自定义数据.
最大长度支持UTF-8编码后2048字节.
enabledStringendpoint启用开关.
true或false字符串.
tokenString设备token.
最大长度512个字节.
状态码:400表5-244响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-245响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司123参数参数类型描述codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-246响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-247响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}/endpointsoffset=0&limit=10null响应示例状态码:200OK{"request_id":"c90d871f77f7425cae0a8b772a563d17","next_page_flag":false,"endpoints":[{"create_time":"2018-01-12T01:25:14Z","endpoint_urn":"urn:smn:regionId:429ffced18074da0938112f2c362b935:endpoint-APNS-application_name-62f0bafec61c45fbbb5d0fc6bd696a2d","user_data":"nouserdata","enabled":"true","token":"1f2fda4c1013c47ac4c59bd22379d88e14b07b0ebf47f2f79d1a6b06ed03390d"消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司124}]}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
7.
2创建Applicationendpoint功能介绍创建应用平台的endpoint终端.
调试您可以在APIExplorer中调试该接口.
URIPOST/v2/{project_id}/notifications/applications/{application_urn}/endpoints表5-248路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
application_urn是StringApplication的唯一资源标识,可通过查询Application获取该标识.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司125请求参数表5-249请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
表5-250请求Body参数参数是否必选参数类型描述token是String移动应用设备token,最大长度512个字节.
user_data是String用户自定义数据,最大长度支持UTF-8编码后2048字节.
响应参数状态码:201表5-251响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
endpoint_urnStringEndpoint的唯一资源标识.
状态码:400表5-252响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司126表5-253响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-254响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-255响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例创建ApplicationendpointPOSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}/endpoints{"token":"3708232124742383445","user_data":"Thisistokenforuser001"}响应示例无消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司127状态码状态码描述201OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
7.
3查询Application的Endpoint属性功能介绍获取endpoint的属性.
调试您可以在APIExplorer中调试该接口.
URIGET/v2/{project_id}/notifications/endpoints/{endpoint_urn}表5-256路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
endpoint_urn是StringEndpoint的唯一资源标识,可通过查询Application的Endpoint列表获取该标识.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司128请求参数表5-257请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-258响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
attributes表5-259object属性的键值对.
表5-259ApplicationEndpointAttribute参数参数类型描述enabledString设备是否可用.
tokenString设备token.
user_dataString用户数据.
状态码:400表5-260响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司129表5-261响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-262响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-263响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例GEThttps://{SMN_Endpoint}/v2/{project_id}/notifications/endpoints/{endpoint_urn}null响应示例状态码:200OK{"request_id":"c90d871f77f7425cae0a8b772a563d17","attributes":{"enabled":"true","token":"3708232124742383445","user_data":"abc"}}消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司130状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
7.
4更新Applicationendpoint功能介绍更新设备属性.
调试您可以在APIExplorer中调试该接口.
URIPUT/v2/{project_id}/notifications/endpoints/{endpoint_urn}表5-264路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
endpoint_urn是StringEndpoint的唯一资源标识,可通过查询Application的Endpoint列表获取该标识.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司131请求参数表5-265请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
表5-266请求Body参数参数是否必选参数类型描述enabled否String设备是否可用,值为true或false字符串.
user_data否String用户自定义数据,最大长度支持UTF-8编码后2048字节.
响应参数状态码:200表5-267响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400表5-268响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司132表5-269响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-270响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-271响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例更新ApplicationendpointPOSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}/endpoints{"enabled":"false","user_data":"ThisisanAPNStokenforuser001"}响应示例无消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司133状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
7.
5删除Applicationendpoint功能介绍删除设备.
调试您可以在APIExplorer中调试该接口.
URIDELETE/v2/{project_id}/notifications/endpoints/{endpoint_urn}表5-272路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
endpoint_urn是StringEndpoint的唯一资源标识,可通过查询Application的Endpoint列表获取该标识.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司134请求参数表5-273请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-274响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
状态码:400表5-275响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-276响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司135表5-277响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-278响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例删除ApplicationendpointDELETEhttps://{SMN_Endpoint}/v2/{project_id}/notifications/endpoints/{endpoint_urn}null响应示例无状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司1365.
8Application直发消息操作5.
8.
1App消息发布功能介绍将消息直发给endpoint设备.
调试您可以在APIExplorer中调试该接口.
URIPOST/v2/{project_id}/notifications/endpoints/{endpoint_urn}/publish表5-279路径参数参数是否必选参数类型描述project_id是String项目ID.
获取项目ID请参考获取项目ID.
endpoint_urn是StringEndpoint的唯一资源标识,可通过查询Application的Endpoint列表获取该标识请求参数表5-280请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司137表5-281请求Body参数参数是否必选参数类型描述message否Stringmessage与message_structure二者选其一.
message,App消息发布.
message_structure,使用消息结构体方式的App消息发布.
app推送的消息内容,当前支持的推送平台有HMS、APNS、APNS_SANDBOX.
HMS是为开发者提供的消息推送平台.
APNS和APNS_SANDBOX是用于推送iOS消息的服务平台.
HMS平台指定的消息内容不超过2K.
APNS和APNS_SANDBOX平台的消息内容不能超过4K.
推送平台的消息内容格式要求详情见application消息体格式.
华为透传消息{"hps":{"msg":{"type":1,"body":{"key":"value"华为系统通知栏消息{"hps":{"msg":{"type":3,"body":{"content":"Pushmessagecontent","title":"Pushmessagecontent"},"action":{"type":1,"param":{"intent":"#Intent;compo=com.
rvr/.
Activity;S.
W=U;end"ext":{"biTag":"Trump","icon":"http://upload.
w.
org/00/150pxsvg.
png"}}}苹果平台消息格式{"aps":{"alert":"helloworld"}}消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司138参数是否必选参数类型描述message_structure否Stringapp推送的消息内容,当前支持的推送平台有HMS、APNS、APNS_SANDBOX.
HMS是为开发者提供的消息推送平台.
APNS和APNS_SANDBOX是用于推送iOS消息的服务平台.
HMS平台指定的消息内容不超过2K.
APNS和APNS_SANDBOX平台的消息内容不能超过4K.
推送平台的消息内容格式要求详情见application消息体格式.
华为透传消息{"HMS":{"hps":{"msg":{"type":1,"body":{"key":"value"华为系统通知栏消息{"HMS":{"hps":{"msg":{"type":3,"body":{"content":"Pushmessagecontent","title":"Pushmessagecontent"},"action":{"type":1,"param":{"intent":"#Intent;compo=com.
rvr/.
Activity;S.
W=U;end"ext":{"biTag":"Trump","icon":"http://upload.
w.
org/00/150pxsvg.
png"苹果平台消息格式{"APNS":{"aps":{"alert":"helloworld"}}}time_to_live否String消息发送的生存时间,是相对于发布时间的.
SMN系统将移动推送消息转交给推送平台前,会计算该消息在系统消耗的时间.
只有消耗的时间小于time_to_live时,SMN才会将消息转交给推送平台,并将time_to_live减去消耗的时间传递给推送平台,否则消息废弃.
time_to_live的单位是s,变量默认值是3600s,即一小时.
值为正整数且小于等于3600*24.
缺省值:3600消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司139响应参数状态码:200表5-282响应Body参数参数参数类型描述message_idString唯一的消息ID.
request_idString请求的唯一标识ID.
状态码:400表5-283响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-284响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-285响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司140状态码:500表5-286响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例App消息发布POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/endpoints/{endpoint_urn}/publish{"message":{"hps":{"msg":{"action":{"param":{"intent":"#Intent;compo=com.
HC.
SmnAppPush.
defaultAction/.
Activity;S.
W=U;end"},"type":1},"body":{"title":"helloworld","content":"helloworld"},"type":3}}},"time_to_live":3600}使用消息结构体方式的App消息发布POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/endpoints/{endpoint_urn}/publish{"message":{"HMS":{"hps":{"msg":{"action":{"param":{"intent":"#Intent;compo=com.
HC.
SmnAppPush.
defaultAction/.
Activity;S.
W=U;end"},"type":1},"body":{"title":"helloworld","content":"helloworld"},"type":3}}}},"time_to_live":3600}消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司141响应示例无状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
9查询版本操作5.
9.
1查询SMN支持的API版本号信息功能介绍查询SMN开放API支持的版本号.
调试您可以在APIExplorer中调试该接口.
URIGET/请求参数表5-287请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司142响应参数状态码:200表5-288响应Body参数参数参数类型描述versionsArrayofVersionItemobjects描述version相关对象的列表.
表5-289VersionItem参数参数类型描述idString版本ID(版本号),如v2.
min_versionString若该版本API支持微版本,则返回支持的最小微版本号;若不支持微版本,则返回空.
statusString版本状态,为如下3种:CURRENT:表示该版本为主推版本.
SUPPORTED:表示为老版本,但是现在还继续支持.
DEPRECATED:表示为废弃版本,存在后续删除的可能.
updatedString版本发布时间,要求用UTC时间格式表示.
如v2发布的时间2014-06-28T12:20:21Z.
versionString若该版本API支持微版本,则返回支持的最大微版本号;若不支持微版本,则返回空.
linksArrayofLinksItemobjectsAPI的URL地址.
表5-290LinksItem参数参数类型描述hrefString对应快捷链接.
relString快捷链接标记名称.
状态码:400消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司143表5-291响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-292响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-293响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:500表5-294响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司144请求示例GEThttps://{SMN_Endpoint}/null响应示例状态码:200OK{"versions":{"id":"v2","links":[{"href":"https://127.
0.
0.
1/v2","rel":"self"}],"min_version":"","status":"CURRENT","updated":"2018-09-19T00:00:00Z","version":""}}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError错误码请参见错误码.
5.
9.
2查询SMNAPIV2版本信息功能介绍查询SMNAPIV2版本信息.
调试您可以在APIExplorer中调试该接口.
URIGET/{api_version}消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司145表5-295路径参数参数是否必选参数类型描述api_version是String待查询版本号.
当前仅支持v2.
请求参数表5-296请求Header参数参数是否必选参数类型描述X-Auth-Token是String用户Token.
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值).
响应参数状态码:200表5-297响应Body参数参数参数类型描述versionObject描述version相关对象的列表.
表5-298VersionItem参数参数类型描述idString版本ID(版本号),如v2.
min_versionString若该版本API支持微版本,则返回支持的最小微版本号;若不支持微版本,则返回空.
statusString版本状态,为如下3种:CURRENT:表示该版本为主推版本.
SUPPORTED:表示为老版本,但是现在还继续支持.
DEPRECATED:表示为废弃版本,存在后续删除的可能.
updatedString版本发布时间,要求用UTC时间格式表示.
如v2发布的时间2014-06-28T12:20:21Z.
versionString若该版本API支持微版本,则返回支持的最大微版本号;若不支持微版本,则返回空.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司146参数参数类型描述linksArrayofLinksItemobjectsAPI的URL地址.
表5-299LinksItem参数参数类型描述hrefString对应快捷链接.
relString快捷链接标记名称.
状态码:400表5-300响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:403表5-301响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
状态码:404表5-302响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司147参数参数类型描述messageString服务异常错误信息描述.
状态码:500表5-303响应Body参数参数参数类型描述request_idString请求的唯一标识ID.
codeString服务异常错误信息编码.
messageString服务异常错误信息描述.
请求示例GEThttps://{SMN_Endpoint}/v2null响应示例状态码:200OK{"version":{"id":"v2","links":[{"href":"https://127.
0.
0.
1/v2","rel":"self"}],"min_version":"","status":"CURRENT","updated":"2018-09-19T00:00:00Z","version":""}}状态码状态码描述200OK400BadRequest403Unauthorized404NotFound500InternalServerError消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司148错误码请参见错误码.
消息通知服务接口参考5API文档版本01(2021-03-30)版权所有华为技术有限公司1496应用示例6.
1示例1:使用主题发布消息操作场景本章节指导用户通过API发布消息.
API的调用方法请参见如何调用API.
涉及接口获取用户Token:通过用户名/密码的方式进行认证来获取IAM用户Token.
创建主题:创建Topic.
订阅:为指定Topic添加订阅者.
消息发布:将消息发送给Topic的所有订阅终端.
操作步骤1.
Token认证,具体操作请参考认证鉴权.
2.
创建Topic.
a.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics".
b.
在RequestHeader中增加"X-Auth-Token".
c.
在RequestBody中传入如下参数:详细的参数说明请参见创建主题{"name":"test_topic_v2",//Topic名称(必填String)"display_name":"test",//显示名(非必填String)"enterprise_project_id":"0"//企业项目ID(企业项目场景下为必填String)}响应示例:{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","topic_urn":"urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2"}3.
添加订阅.
消息通知服务接口参考6应用示例文档版本01(2021-03-30)版权所有华为技术有限公司150a.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/subscriptions".
其中,topic_urn可在2.
c的返回体中获取.
b.
在RequestHeader中增加"X-Auth-Token".
c.
在RequestBody中传入参数如下.
{"protocol":"email",//订阅协议(必填String)"endpoint":"xxx@xx.
com",//邮件地址(必填String)"remark":"订阅终端"//备注(非必填String)}响应示例:{"subscriptions_result":[{"request_id":"126c17f805934e5eadf647b0860c7a0a","subscription_urn":"urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2","http_code":201}]}说明可为Topic添加多种以及多个订阅终端,支持的订阅协议请参考订阅.
d.
订阅终端会受到一条确认订阅的消息,请在邮箱中进行确认订阅的操作.
4.
发送消息.
a.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/publish".
b.
在RequestHeader中增加"X-Auth-Token".
c.
在RequestBody中传入参数如下:{"subject":"testmessagev2",//标题,邮件订阅终端使用(非必填String)"message":"Messagetestmessagev2.
"//需要发送的消息(必填String)}响应示例:{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","message_id":"992bbd32819448af95f83814cb3c7454"}说明已完成3.
c的确认订阅操作的订阅终端都能接收到该消息,否则无法接收消息.
6.
2示例2:使用消息模板方式发布消息操作场景本章节指导用户通过API使用消息模板方式发布消息.
API的调用方法请参见如何调用API.
涉及接口获取用户Token:通过用户名/密码的方式进行认证来获取IAM用户Token.
创建主题:创建Topic.
订阅:为指定Topic添加订阅者.
消息通知服务接口参考6应用示例文档版本01(2021-03-30)版权所有华为技术有限公司151创建消息模板:创建一个模板,用户可以按照模板去发送消息,这样可以减少请求的数据量.
消息发布:将消息发送给Topic的所有订阅终端.
操作步骤1.
Token认证,具体操作请参考认证鉴权.
2.
创建Topic.
a.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics".
b.
在RequestHeader中增加"X-Auth-Token".
c.
在RequestBody中传入如下参数.
详细的参数说明请参见"创建主题"{"name":"publish_by_template",//Topic名称(必填String)"display_name":"test",//显示名(非必填String)"enterprise_project_id":"0"//企业项目ID(企业项目场景下为必填String)}响应示例:{"request_id":"a8f8161449564f569c19e2a9e3be25c9","topic_urn":"urn:smn:br-iaas-odin1:0605767e0a00d5762fe7c00d0e33345c:publish_by_template"}3.
添加订阅.
a.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/subscriptions".
其中,topic_urn可在2.
c的返回体中获取.
b.
在RequestHeader中增加"X-Auth-Token".
c.
在RequestBody中传入参数如下.
{"protocol":"sms",//订阅协议(必填String)"endpoint":"86137****3629",//邮件地址(必填String)"remark":"订阅终端"//备注(非必填String)}响应示例:{"subscriptions_result":[{"request_id":"126c17f805934e5eadf647b0860c7a0a","subscription_urn":"urn:smn:br-iaas-odin1:0605767e0a00d5762fe7c00d0e33345c:publish_by_template:3e5ac4544a1947b7b0d9f743fe52bdbd","http_code":201}]}说明可为Topic添加多种以及多个订阅终端,支持的订阅协议请参考订阅.
d.
订阅终端会受到一条确认订阅的消息,请在邮箱中进行确认订阅的操作.
4.
创建消息模板.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/message_template".
5.
在RequestHeader中增加"X-Auth-Token".
消息通知服务接口参考6应用示例文档版本01(2021-03-30)版权所有华为技术有限公司152a.
在RequestBody中传入参数如下:{"message_template_name":"sms_template_test","locale":"zh-cn","content":"{content}","protocol":"sms"}响应示例:{"request_id":"e67228ac92324a58980e922ca600f8ef","message_template_id":"cdb113996c5d49149fb97af36d9801ce"}b.
订阅终端会受到一条确认订阅的消息,请在手机中进行确认订阅的操作.
6.
使用消息模板方式发布消息.
a.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/publish".
b.
在RequestHeader中增加"X-Auth-Token".
c.
在RequestBody中传入参数如下:{"message_template_name":"sms_template_test","tags":{"content":"hellotest"},"subject":"templatemessagetest"}响应示例:{"message_id":"5da965fd9e2c4036a0542317d944af83","request_id":"c6be4517f985470e8448e42f9d2ec5a2"}说明已完成3.
c的确认订阅操作的订阅终端都能接收到该消息,否则无法接收消息.
6.
3示例3:使用移动推送操作场景本章节指导用户通过API使用移动推送.
API的调用方法请参见如何调用API.
前提条件若使用HMS,已获取到PUSH服务参数(APPID和APPSECRET),获取方式参见HMS入门.
若使用APNS,已获取到P12格式IOS推送证书及其密码.
涉及接口获取用户Token:通过用户名/密码的方式进行认证来获取IAM用户Token.
创建Application:创建平台应用.
创建Applicationendpoint:创建应用平台的endpoint终端.
App消息发布:将消息直发给endpoint设备.
消息通知服务接口参考6应用示例文档版本01(2021-03-30)版权所有华为技术有限公司153操作步骤1.
Token认证,具体操作请参考认证鉴权.
2.
创建Application.
a.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/applications".
b.
在RequestHeader中增加"X-Auth-Token".
c.
在RequestBody中传入如下参数.
详细的参数说明请参见"创建主题"{"name":"application_name","platform":"HMS","platform_principal":"appId","platform_credential":"appSecret"}响应示例:{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","application_urn":"urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:app-HMS-application_name","application_id":"4f9ad22e1c244034995a77760252553c"}3.
创建Applicationendpoint.
a.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}/endpoints".
其中,application_urn可在2.
c的返回体中获取.
b.
在RequestHeader中增加"X-Auth-Token".
c.
在RequestBody中传入参数如下:{"token":"37082*******383445","user_data":"addendpoint"}响应示例:{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","endpoint_urn":"urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:endpoint-APNS-example_application_name-37a2cb947fa43a20bc66e91281194e7a"}说明可以为Application添加多个endpoint,且endpoint信息支持修改,详见更新Applicationendpoint.
4.
App消息发布.
a.
发送"POSThttps://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/publish".
b.
在RequestHeader中增加"X-Auth-Token".
c.
在RequestBody中传入参数如下所示.
{"message":{"hps":{"msg":{"action":{"param":{"intent":消息通知服务接口参考6应用示例文档版本01(2021-03-30)版权所有华为技术有限公司154"#Intent;compo=com.
HC.
SmnAppPush.
defaultAction/.
Activity;S.
W=U;end"},"type":1},"body":{"title":"helloworld","content":"helloworld"},"type":3}}}}响应示例:{"request_id":"6a63a18b8bab40ffb71ebd9cb80d0085","message_id":"992bbd32819448af95f83814cb3c7454"}说明确保4.
c中的token参数正确,否则您可能无法收到移动应用消息.
消息通知服务接口参考6应用示例文档版本01(2021-03-30)版权所有华为技术有限公司1557公共参数7.
1application消息体格式表7-1application消息体格式类型样例备注华为透传消息"hps":{"msg":{"type":1,"body":{"key":"value"}}}body为用户自定义格式.
说明推荐使用JSON格式,如样例所示对于纯文本可以将body设置为字符串(采用UTF-8编码)消息体最大2K详细的字段介绍及其使用请参见华为推送平台的接口定义.
消息通知服务接口参考7公共参数文档版本01(2021-03-30)版权所有华为技术有限公司156类型样例备注华为系统通知栏消息"hps":{"msg":{"type":3,"body":{"content":"Pushmessagecontent","title":"Pushmessagecontent"},"action":{"type":1,"param":{"intent":"#Intent;compo=com.
rvr/.
Activity;S.
W=U;end"}}},"ext":{"biTag":"Trump","icon":"http://upload.
w.
org/00/150pxsvg.
png"}}苹果平台消息格式{"aps":{"alert":"helloworld"}}消息体最大4K.
详细的字段介绍及其使用参见苹果推送平台的接口定义.
7.
2获取项目ID操作场景在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID.
有如下两种获取方式:调用API获取项目ID从控制台获取项目ID消息通知服务接口参考7公共参数文档版本01(2021-03-30)版权所有华为技术有限公司157调用API获取项目ID项目ID可以通过调用查询指定条件下的项目列表API获取.
获取项目ID的接口为"GEThttps://{Endpoint}/v3/projects",其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取.
接口的认证鉴权请参见认证鉴权.
响应示例如下,其中projects下的"id"即为项目ID.
{"projects":[{"domain_id":"65382450e8f64ac0870cd180d14e684b","is_domain":false,"parent_id":"65382450e8f64ac0870cd180d14e684b","name":"project_name","description":"","links":{"next":null,"previous":null,"self":"https://www.
example.
com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"},"id":"a4a5d4098fb4474fa22cd05f897d6b99","enabled":true}],"links":{"next":null,"previous":null,"self":"https://www.
example.
com/v3/projects"}}从控制台获取项目ID从控制台获取项目ID的步骤如下:1.
登录管理控制台.
2.
鼠标悬停在右上角的用户名,选择下拉列表中的"我的凭证".
在"API凭证"页面的项目列表中查看项目ID.
图7-1查看项目ID消息通知服务接口参考7公共参数文档版本01(2021-03-30)版权所有华为技术有限公司158A附录A.
1Topic属性表属性名称属性作用属性默认值access_policyTopic资源的访问策略,控制其他用户访问该Topic的权限.
空字符串.
introduction在邮件和短信订阅确认信息中展示Topic的介绍,使您能够让订阅者对主题有更多的了解.
空字符串.
A.
2通用请求返回值A.
2.
1异常响应异常响应要素说明名称参数类型说明request_idString请求的IDcodeString参考错误码messageString参考错误码异常响应举例{"request_id":"aad0860d089c482b943971f802a6718e","code":"SMN.
0006","message":"Topicnotfound.
"}消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司159A.
2.
2状态码表A-1正常返回值返回值说明200任务提交成功201创建成功表A-2异常返回值返回值说明400BadRequest请求参数错误.
401Unauthorized鉴权失败.
403Forbidden没有权限对资源访问.
404NotFound请求的资源不存在.
500InternalServerError请求未完成.
服务异常.
501NotImplemented请求未完成.
服务器不支持所请求的功能.
502BadGateway请求未完成.
服务器从上游服务器收到一个无效的响应.
503ServiceUnavailable请求未完成.
系统暂时异常.
504GatewayTimeout网关超时.
A.
3错误码当您调用API时,如果遇到"APIGW"开头的错误码,请参见API网关错误码进行处理.
表A-3错误码状态码错误码错误信息描述处理措施400SMN.
0038Parameter:tagisinvalid.
参数:tag无效.
请输入有效的tag参数.
403SMN.
0075Parameter:tagsaretoomany.
参数:标签数过多.
超过消息模板的最大非重复标签数,模板内容中允许最多90个不重复的标签.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司160状态码错误码错误信息描述处理措施400SMN.
0159Thenumberofendpointshasreachedthemaximumallowed.
终端数量已达配额.
发送号码个数超过限额,手机号码个数不能超过1000.
400SMN.
0160Invalidendpoint.
endpoint无效.
请输入有效的endpoint.
404SMN.
0167Phonenumberdoesnotexist.
手机号码不存在.
用户注册的手机号码不存在.
404SMN.
0168EmailAddressdoesnotexist.
邮件地址不存在.
用户注册的邮件地址不存在.
400SMN.
0082Thelengthoftheremarkparametervaluehasreachedthemaximumallowed.
remark参数超过长度限制.
请输入有效的remark参数.
400SMN.
0152ThenumberallocatedtotheSMStemplatehasreachedthemaximumallowed.
分配的短信模板数量已达限额.
创建的短信模板超过限额,每个用户可以创建100个短信模板.
403SMN.
0153OnlyenterpriseuserscancreateSMSmessageTemplate.
只有企业用户才能创建短信模板.
请完成企业身份认证.
403SMN.
0154Onlyenterpriseuserswhousethecertificateimagesforauthenticationcancreatesmsmessagetemplates.
只有使用证书进行身份验证的企业用户才能创建短信模板.
如遇到请联系客服技术支持.
400SMN.
0155Parameter:SmsTemplateTypeisinvalid.
参数:sms_template_type无效.
请输入有效的sms_template_type.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司161状态码错误码错误信息描述处理措施400SMN.
0156Parameter:SmsTemplateNameisinvalid.
参数:sms_template_name无效.
请输入有效的sms_template_name.
400SMN.
0157Parameter:SmsTemplateContentisinvalid.
参数:sms_template_content无效.
请输入有效的sms_template_content.
400SMN.
0161InvalidSMStemplateID.
短信模板ID无效.
请输入有效的sms_template_id.
404SMN.
0162SMStemplatenotfound.
短信模板不存在.
短信模板不存在,请输入有效的短信模板.
400SMN.
0204PromotionalSMSmessagesmustcontainthewaytounsubscribeintheend,forexample,byreplying"TD",or"T".
推广短信末尾必须包含取消订阅的方式,例如,退订回复"TD"或"T".
在推广短信内容末尾必须包含退订方式,比如在内容末尾添加"退订回TD".
400SMN.
0215TheSMSmessagesignatureIDdoesnotmatchthesignaturenameintheSMSmessagetemplatecontent.
sms消息签名id与sms消息模板内容中的签名名称不匹配.
请传入与sms_template_content内容中的签名名称一致的签名ID.
400SMN.
0216ThetemplatecontentdoesnotincludeanyvalidSMSmessagesignature.
模板内容不包括任何有效的sms消息签名.
请在内容填入有效的签名.
400SMN.
0217ThetemplatecontentdoesnotincludeanySMSmessagesignature.
模板内容不包括任何sms消息签名.
sms_template_content内容必须要包含有效的签名名称,如【XX商城】.
该签名必须是已审批通过的可用签名.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司162状态码错误码错误信息描述处理措施400SMN.
0224TheSMSmessagetemplateisinvalidbecausetheassociatedsignaturehasbeendeleted.
短信模板因关联签名删除已失效.
请传入有效的sms_template_id.
400SMN.
0227Themessagecontainssensitivewords.
消息中包含敏感关键词.
当前传入的message中包含敏感关键词,请根据返回提示修改message内容.
403SMN.
0057ThenumberofSMSmessagesexceedsthelimit.
SMS消息的数量超过了限制.
短信直发时,同一个手机号码限制1小时内最多发送60条短信,12小时最多发200条短信.
向Topic发布消息时则没有限制.
404SMN.
0084TheSMSmessagesignaturecouldnotbefound.
找不到SMS短信签名.
请输入已经审批通过的签名.
403SMN.
0086ThenumberallocatedtotheSMSmessagesignaturehasreachedthemaximumallowed.
分配给sms消息签名的数字已达限额.
创建签名超过限额,您最多可以创建10个短信签名.
400SMN.
0087TheSMSmessagesignaturehasnotbeenapproved.
短信签名未被审批通过.
请输入已经审批通过的签名.
400SMN.
0151Themessagesignaturetypecannotbepromotional.
不能是推广类消息签名.
请输入通知验证码类短信签名.
500SMN.
0158Failedtouploadthefile.
上传文件失败.
如遇到请联系客服技术支持.
400SMN.
0188InvalidSMStemplatetype.
短信模板类型无效.
当前的短信模板类型不存在,必须是推广模板.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司163状态码错误码错误信息描述处理措施403SMN.
0001Nopermissiontorequestresources.
没有请求资源的权限.
添加相应的权限.
400SMN.
0015Parameter:Offsetorlimitisinvalid.
参数:offsetorlimit无效.
请输入有效的offset和limit.
500SMN.
0016DatabaseExceptions.
数据库异常.
如遇到请联系客服技术支持.
400SMN.
0017Parameter:Remarkisinvalid.
参数:remark无效.
请输入有效的remark参数.
500SMN.
0018Serviceinternalerror.
服务内部错误.
如遇到请联系客服技术支持.
403SMN.
0022Parameter:tokenisinvalid.
参数:token无效.
请输入有效token.
400SMN.
0033Parameter:push_policyisinvalid.
参数:push_policy无效.
请输入有效的push_policy参数.
400SMN.
0034Parameter:subscription_auth_policyisinvalid.
参数:subscription_auth_policy无效.
请输入有效的subscription_auth_policy参数.
400SMN.
0035Parameter:validation_policyisinvalid.
参数:validation_policy无效.
请输入有效的validation_policy参数.
400SMN.
0036Parameter:xdomain_typeisinvalid.
参数:xdomain_type无效.
请输入有效的xdomain_type参数.
400SMN.
0059Parameter:job_idisinvalid.
参数:job_id无效.
如遇到请联系客服技术支持.
404SMN.
0060Jobnotfound.
查询不到Job.
如遇到请联系客服技术支持.
400SMN.
0061Parameter:Servicenameisinvalid.
参数:Servicename无效.
如遇到请联系客服技术支持.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司164状态码错误码错误信息描述处理措施400SMN.
0062Parameter:Shownameisinvalid.
参数:Showname无效.
如遇到请联系客服技术支持.
404SMN.
0063Cloudservicenotfound.
找不到云服务.
如遇到请联系客服技术支持.
403SMN.
0065Thenumberofemailmessagesexceedsthelimit.
邮件的数量超过了限制.
如遇到请联系客服技术支持.
400SMN.
0066Parameter:Systemparameternameisinvalid.
参数:系统参数名称无效.
如遇到请联系客服技术支持.
400SMN.
0067Parameter:Systemparametervalueisinvalid.
参数:系统参数值无效.
如遇到请联系客服技术支持.
404SMN.
0068Systemparameternotfound.
找不到系统参数.
如遇到请联系客服技术支持.
403SMN.
0069Notauthorizedtosubscribeinternalendpoints.
订阅内部终端未授权.
检查http(s)终端地址,请填写正确的https(s)终端地址.
403SMN.
0070Nopermissiontorequestresources.
Theroleisop_restricted.
Contactcustomerservice.
没有请求资源的权限.
操作受限.
请检查余额是否充足,余额不足请尽快充值.
如未解决,请联系客服技术支持.
403SMN.
0071Nopermissiontorequestresources.
Roleisop_suspended.
没有请求资源的权限.
角色被挂起.
请检查帐号是否被挂起冻结.
400SMN.
0074Failedtoaddpermission.
添加权限失败.
如遇到请联系客服技术支持.
400SMN.
0077Parameter:Statusisinvalid.
参数:status无效.
请输入有效的status参数.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司165状态码错误码错误信息描述处理措施400SMN.
0080ThesignIdparameterisinvalid.
参数:sign_id无效.
请输入有效的sign_id参数.
400SMN.
0081ThesignNameparameterisinvalid.
参数:sign_name无效.
请输入有效的sign_name参数,签名只能由中文、英文字母和数字组成,长度为2到8个字符.
403SMN.
0083Finishreal-nameauthenticationbeforecontinuing.
请先完成实名认证.
如遇到请联系客服技术支持.
500SMN.
0089AnerroroccurredintheBSSsystem.
Tryagainlater.
BSS系统中出现错误.
请稍后再试.
如遇到请联系客服技术支持.
400SMN.
0090InvaliddomainID.
无效的domain_id.
请输入有效的domain_id.
获取方法请参见获取项目ID.
400SMN.
0092Thekafka_idparameterisinvalid.
参数:kafka_id无效.
如遇到请联系客服技术支持.
400SMN.
0093Theaddress_listparameterisinvalid.
参数:address_list无效.
如遇到请联系客服技术支持.
400SMN.
0094Thetypeofqueueparameterisinvalid.
队列参数类型无效.
如遇到请联系客服技术支持.
400SMN.
0095Thecountofqueueparameterisinvalid.
队列参数统计数量无效.
如遇到请联系客服技术支持.
404SMN.
0096Kafkanotfound.
找不到Kafka.
如遇到请联系客服技术支持.
400SMN.
0097Thenamesparameterisinvalid.
names参数无效.
如遇到请联系客服技术支持.
404SMN.
0098Thisqueuedoesnotexist.
队列不存在.
请输入有效的DMS队列.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司166状态码错误码错误信息描述处理措施403SMN.
0099TheSMNservicehasnotbeenauthorizedtosendmessagestothisqueue.
SMN服务未被授权将消息发送到此队列.
请在该队列策略里面授权smn服务相关权限.
400SMN.
0100TheeventTypeparameterisinvalid.
参数:event_type无效.
请输入有效的event_type参数.
400SMN.
0103Thestart_timeparametervalueisinvalid.
start_time参数值无效.
请输入有效的start_time参数.
400SMN.
0104Theend_timeparametervalueisinvalid.
end_time参数值无效.
请输入有效的end_time参数.
400SMN.
0108Parameter:Typeisinvalid.
参数:type无效.
请输入有效的type参数.
404SMN.
0109Startdateisnotfound.
找不到参数start_date.
请输入有效的start_date参数,不能为空.
400SMN.
0110Parameter:Startdateisinvalid.
参数:start_date无效.
请输入有效的start_date参数.
404SMN.
0111Enddateisnotfound.
找不到参数end_date.
请输入有效的end_date参数,不能为空.
400SMN.
0112Parameter:Enddateisinvalid.
参数:end_date无效.
请输入有效的end_date参数.
400SMN.
0113Thestarttimeandendtimemustbewithinthepast3months.
开始时间和结束时间必须在过去3个月内.
开始时间和结束时间必须在过去3个月内.
400SMN.
0114Theendtimemustbelaterthanthestarttime.
结束时间必须大于开始时间.
结束时间必须大于开始时间.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司167状态码错误码错误信息描述处理措施403SMN.
0147Onlyenterpriseuserswhousethecertificateimagesforauthenticationcancreatemessagesignatures.
只有使用证书进行身份验证的企业用户才能创建消息签名.
如遇到请联系客服技术支持.
400SMN.
0150Completereal-nameregistrationusingyourcompany'scertificate.
使用贵公司的证书完成实名注册.
如遇到请联系客服技术支持.
403SMN.
0165Parameter:tenant_tokenisinvalid.
参数:tenant_token无效.
请输入有效的tenant_token参数.
400SMN.
0189FailedtoobtainthecertificaterequiredforreviewingtheSMSmessagetemplatefunction.
获取查看sms消息模板功能所需的证书失败.
如遇到请联系客服技术支持.
400SMN.
0191Parameter:Invalidenterprisename.
公司名称无效.
如遇到请联系客服技术支持.
400SMN.
0192Parameter:InvalidenterprisecertificateID.
公司证书无效.
如遇到请联系客服技术支持.
403SMN.
0195Completeenterprisereal-nameauthenticationfirst.
请先完成实名认证.
请进行实名认证.
403SMN.
0228DonothavepermissiontousethisAPI.
Contactcustomerservicetoapplyforpermission.
当前接口没有使用权限,如需使用请联系客服申请.
当前接口目前没有权限访问,如需使用请联系客服申请.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司168状态码错误码错误信息描述处理措施400SMN0261Checkwhetheryouraccountbalanceissufficientandtopupyouraccountifnecessary.
请检查账户余额是否充足,如余额不足请尽快充值.
请检查账户余额是否充足,如余额不足请尽快充值.
400SMN.
0115Parameter:Applicationnameisinvalid.
参数:applicationname无效.
请输入有效的applicationname.
403SMN.
0116PlatFormdonotsupportyet.
平台暂不支持.
该平台暂不支持.
403SMN.
0117Certificatetypeisnotsupported.
证书类型暂不支持.
该证书类型暂不支持.
400SMN.
0118WrongCertificate.
证书错误.
请输入有效证书.
403SMN.
0119PlatformPrincipalmustbeatmost8192byteslonginUTF-8encoding.
UTF-8编码的platform_principal不得超过8192bytes.
请输入有效platform_principal参数,不超过8192bytes,且为UTF-8编码.
403SMN.
0120PlatformCredentialmustbeatmost8192byteslonginUTF-8encoding.
platform_credential不超过8192bytes,且为UTF-8编码.
请输入有效platform_credential参数,不超过8192bytes,且为UTF-8编码.
201SMN.
0121Anapplicationwiththesamenamebutdifferentpropertiesalreadyexists.
具有相同名称但属性不同的应用程序已存在.
请输入有效的application名称404SMN.
0122Applicationnotfound.
找不到应用程序.
请输入有效的application名称400SMN.
0123Parameter:ApplicationUrnisinvalid.
参数:application_urn无效.
请输入有效的application_urn参数.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司169状态码错误码错误信息描述处理措施400SMN.
0124Parameter:applicationattributeisinvalid.
参数:application_attributes无效.
请输入有效的attributes参数.
404SMN.
0125Endpointdoesnotexist.
终端不存在.
请输入存在的applicationendpoint400SMN.
0126ContentTypeiswrong.
Content类型错误.
如遇到请联系客服技术支持.
403SMN.
0127Fileistoolarge.
文件过大.
如遇到请联系客服技术支持.
403SMN.
0128Passwordisempty.
密码为空.
如遇到请联系客服技术支持.
400SMN.
0129Certificatetypeiswrong.
证书类型错误.
如遇到请联系客服技术支持.
404SMN.
0130Theapplicationdoesnotexist.
平台不存在.
请输入有效的application_urn.
403SMN.
0131ThevalueoftheTokenparameterisinvalid.
token无效.
请输入有效的token.
400SMN.
0132ThevalueoftheUser_dataparameterisinvalid.
user_data无效.
请输入有效的user_data.
400SMN.
0133Thedevicetokenalreadyexists.
device_token已存在.
device_token不能重复创建.
400SMN.
0134TheendpointURNisinvalid.
endpoint_urn无效.
请输入有效的endpoint_urn.
400SMN.
0135Theendpointdoesnotexist.
endpoint不存在.
请使用存在的endpoint.
400SMN.
0136Thevalueoftheenabledparameterisinvalid.
enabled无效.
请输入有效的enabled参数.
400SMN.
0137TheapplicationURNisinvalid.
application_urn无效.
请输入有效的application_urn参数.
201SMN.
0190Thisendpointalreadyexists.
endpoint已存在.
该endpoint在列表中已经存在.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司170状态码错误码错误信息描述处理措施400SMN.
0230Parameter:Invalidtitle.
参数title无效.
请输入合法的title参数.
400SMN.
0011Parameter:Protocolisinvalid.
参数:protocol无效.
请输入正确的协议类型.
400SMN.
0012Parameter:Endpointisinvalid.
参数:endpoint无效.
请输入正确格式的终端.
404SMN.
0013Subscriptionresourcenotfound.
查询不到订阅资源.
请使用正确的订阅资源.
400SMN.
0014Parameter:SubscriptionUrnisinvalid.
参数:SubscriptionUrn无效.
请输入有效的subscription_urn.
400SMN.
0043Parameter:subscriptionisinvalid.
参数:subscription无效.
请输入有效的subscription参数.
403SMN.
0078Themaximumnumberofsubscriptionshasbeenreached.
已达到订阅的最大数量.
订阅者列表超过数量限制.
403SMN.
0008Parameter:Subjectisinvalid.
参数:subject无效.
请输入有效的subject参数.
403SMN.
0009Parameter:Messageisinvalid.
参数:message无效.
请输入有效的message参数.
400SMN.
0019ProducerExceptions.
生成器异常.
如遇到请联系客服技术支持.
400SMN.
0021MessageStructureisinvalid.
消息结构无效.
请输入有效的message_structure参数.
400SMN.
0140ThetopicURNconfiguredforthemessagesendingfailureeventisinvalid.
配置发送消息失败回调事件的topic_urn无效.
配置发送消息失败回调事件的topic_urn无效,请输入有效的topic_urn.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司171状态码错误码错误信息描述处理措施400SMN.
0141Thetopicconfiguredforthemessagesendingfailureeventdoesnotexist.
配置发送消息失败回调事件的topic_urn不存在.
配置发送消息失败回调事件的topic_urn不存在,请输入有效的topic_urn.
400SMN.
0142ThetopicURNconfiguredforthemessagesendingsuccesseventisinvalid.
配置发送消息成功回调事件的topic_urn无效.
配置发送消息成功回调事件的topic_urn无效,请输入有效的topic_urn.
400SMN.
0143Thetopicconfiguredforthemessagesendingsuccesseventdoesnotexist.
配置发送消息成功回调事件的topic_urn不存在.
配置发送消息成功回调事件的topic_urn不存在,请输入有效的topic_urn.
400SMN.
0144ThetopicURNconfiguredfortheresponsemessageeventisinvalid.
配置回复消息回调事件的topic_urn无效.
配置回复消息回调事件的topic_urn无效,请输入有效的topic_urn.
400SMN.
0145Thetopicconfiguredfortheresponsemessageeventdoesnotexist.
配置回复消息回调事件的topic_urn不存在.
配置回复消息回调事件的topic_urn不存在,请输入有效的topic_urn.
400SMN.
0148Parameter:user_idisinvalid.
参数:user_id无效.
请输入有效的user_id参数.
400SMN.
0024Parameter:contentisinvalid.
参数:content无效.
请输入有效的content参数.
200SMN.
0025Templatealreadyexists.
模板已经存在.
请不要重复创建相同的模板.
404SMN.
0027Templatenotfound.
找不到模板.
请使用存在的模版.
400SMN.
0031Parameter:template_idisinvalid.
参数:template_id无效.
请输入有效的template_id参数.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司172状态码错误码错误信息描述处理措施400SMN.
0032Parameter:message_template_nameisinvalid.
参数:message_template_name无效.
请输入有效的message_template_name参数.
400SMN.
0042Parameter:Message_template_nameisinvalid.
参数:message_template_name无效.
请输入有效的message_template_name参数.
400SMN.
0044Exceededtemplatelimit.
模板数量超过限制.
消息模板数量超过限制.
每个用户可以创建100个消息模板.
404SMN.
0076Defaultmessagetemplatenotfound.
默认消息模板不存在.
请先创建一个default模板.
404SMN.
0091Defaultsystemmessagetemplatenotfound.
不存在默认系统消息模板.
请先创建一个默认模板.
404SMN.
0101Thegraphdoesnotexistinthefunctiongraphservice.
函数在functiongraph服务中不存在.
请检查functiongraph终端是否输入正确.
400SMN.
0102Parameter:message_idisinvalid.
参数:message_id无效.
请输入有效的message_id参数.
400SMN.
0002Parameter:Nameisinvalid.
参数:name无效.
请输入有效的topic名称.
400SMN.
0003Parameter:DisplayNameisinvalid.
参数:displayname无效.
请输入有效的topic显示名.
403SMN.
0004Exceededtopiclimit.
主题数量超过限制.
topic数量超过了限制,每个用户可以最多创建3000个主题.
400SMN.
0005Parameter:TopicUrnisinvalid.
参数:topic_urn无效请输入有效的topic_urn参数.
404SMN.
0006Topicnotfound.
未查询到该主题.
topic不存在.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司173状态码错误码错误信息描述处理措施403SMN.
0007Exceededsubscriptionlimit.
订阅数量超过限制.
每个主题最多支持10000个订阅者.
404SMN.
0045Attributenotfound.
未查询到attribute.
请使用存在的属性.
400SMN.
0046Parameter:Attributenameisinvalid.
参数:attribute_name无效.
输入有效的attribute_name.
403SMN.
0047Parameter:Valueexceedsthemaximumlength.
参数:value超出最大长度.
请输入有效的value值.
400SMN.
0048Parameter:Accesspolicyisinvalid.
参数:access_policy无效.
请输入有效的access_policy值.
400SMN.
0049Parameter:Accesspolicyversionisinvalid.
参数:access_policy版本无效.
请输入accesspolicy规范的版本.
400SMN.
0050Parameter:AccesspolicyIDisinvalid.
参数:access_policyid无效.
请输入有效的access_policyid值.
400SMN.
0051Parameter:Accesspolicystatementisinvalid.
参数:access_policystatement无效.
请输入有效的access_policystatement值.
400SMN.
0052Parameter:AccesspolicystatementIDisinvalid.
参数:access_policystatementid无效.
请输入有效的access_policystatementid值.
400SMN.
0053Parameter:Accesspolicystatementresourceisinvalid.
参数:access_policystatementresource无效.
请输入有效的access_policystatementresource值.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司174状态码错误码错误信息描述处理措施400SMN.
0054Parameter:Accesspolicystatementeffectisinvalid.
参数:access_policystatementeffect无效.
请输入有效的access_policystatementeffect值.
400SMN.
0055Parameter:Accesspolicystatementactionisinvalid.
参数:access_policystatementaction无效.
请输入有效的access_policystatementaction值.
400SMN.
0056Parameter:Accesspolicystatementprincipalisinvalid.
参数:access_policystatementprincipal无效.
请输入有效的access_policystatementprincipal值.
400SMN.
0058Parameter:Accesspolicystatementconditionisinvalid.
参数:access_policystatementcondition无效.
请输入有效的access_policystatementcondition值.
400SMN.
0072Parameter:Serviceisinvalid.
参数:service无效.
请输入有效的service参数.
400SMN.
0073Parameter:Invalidaction.
参数:action无效.
请输入有效的action参数.
A.
4Cmpp发送状态描述表发送状态发送状态描述DELIVRD用户已成功收到短信.
EXPIRED短信已超时.
DELETED短信已删除.
UNDELIV短信递送失败.
ACCEPTD短信已接收.
UNKNOWN短信状态未知.
消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司175发送状态发送状态描述REJECTD短信被拒绝.
A.
5国家码和地区码国家(或地区)中文名国家(或地区)码Afghanistan阿富汗93Albania阿尔巴尼亚355Algeria阿尔及利亚213AmericanSamoa美属萨摩亚1684Andorra安道尔376Angola安哥拉244Anguilla安圭拉1264AntiguaandBarbuda安提瓜和巴布达1268Argentina阿根廷54Armenia亚美尼亚374Aruba阿鲁巴297Australia澳大利亚61Austria奥地利43Azerbaijan阿塞拜疆994Bahamas巴哈马1242Bahrain巴林973Bangladesh孟加拉国880Barbados巴巴多斯1246Belarus白俄罗斯375Belgium比利时32Belize伯利兹501Benin贝宁229Bermuda百慕大群岛1441Bhutan不丹975消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司176国家(或地区)中文名国家(或地区)码Bolivia玻利维亚591BosniaandHerzegovina波斯尼亚和黑塞哥维那387Botswana博茨瓦纳267Brazil巴西55BritishIndianOceanTerritory英属印度洋领地246Brunei文莱673Bulgaria保加利亚359BurkinaFaso布基纳法索226Burundi布隆迪257Cambodia柬埔寨855Cameroon喀麦隆237Canada加拿大1CapeVerde佛得角238CaymanIslands开曼群岛1345CentralAfricanRepublic中非共和国236Chad乍得235Chile智利56Colombia哥伦比亚57Comoros科摩罗269RepublicOfTheCongo刚果共和国242DemocraticRepublicoftheCongo刚果民主共和国243CookIslands库克群岛682CostaRica哥斯达黎加506Croatia克罗地亚385Curacao库拉索599Cyprus塞浦路斯357消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司177国家(或地区)中文名国家(或地区)码Czechia捷克420Denmark丹麦45Djibouti吉布提253Dominica多米尼克1767DominicanRepublic多米尼加共和国1809Ecuador厄瓜多尔593Egypt埃及20ElSalvador萨尔瓦多503EquatorialGuinea赤道几内亚240Eritrea厄立特里亚291Estonia爱沙尼亚372Ethiopia埃塞俄比亚251FalklandIslands福克兰群岛500FaroeIslands法罗群岛298Fiji斐济679Finland芬兰358France法国33FrenchGuiana法属圭亚那594FrenchPolynesia法属波利尼西亚689Gabon加蓬241Gambia冈比亚220Georgia格鲁吉亚995Germany德国49Ghana加纳233Gibraltar直布罗陀350Greece希腊30Greenland格陵兰岛299Grenada格林纳达1473Guadeloupe瓜德罗普岛590消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司178国家(或地区)中文名国家(或地区)码Guatemala瓜地马拉502Guernsey根西44Guinea几内亚224Guinea-Bissau几内亚比绍245Guyana圭亚那592Haiti海地509Honduras洪都拉斯504HongKong(China)中国香港852Hungary匈牙利36Iceland冰岛354India印度91Indonesia印度尼西亚62Iraq伊拉克964Ireland爱尔兰353IsleofMan马恩岛44Israel以色列972Italy意大利39IvoryCoast科特迪瓦225Jamaica牙买加1876Japan日本81Jersey泽西岛44Jordan约旦962Kazakhstan哈萨克斯坦7Kenya肯尼亚254Kuwait科威特965Kyrgyzstan吉尔吉斯斯坦996Laos老挝856Latvia拉脱维亚371Lebanon黎巴嫩961Lesotho莱索托266消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司179国家(或地区)中文名国家(或地区)码Liberia利比里亚231Libya利比亚218Liechtenstein列支敦士登423Lithuania立陶宛370Luxembourg卢森堡352Macau(China)中国澳门853Macedonia马其顿389Madagascar马达加斯加261Malawi马拉维265Malaysia马来西亚60Maldives马尔代夫960Mali马里223Malta马耳他356MarshallIslands马绍尔群岛692Martinique马提尼克596Mauritania毛里塔尼亚222Mauritius毛里求斯230Mexico墨西哥52Moldova摩尔多瓦373Monaco摩纳哥377Mongolia蒙古976Montenegro黑山382Montserrat蒙特塞拉特岛1664Morocco摩洛哥212Mozambique莫桑比克258Myanmar缅甸95Namibia纳米比亚264Nauru瑙鲁674Nepal尼泊尔977Netherlands荷兰31消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司180国家(或地区)中文名国家(或地区)码NewCaledonia新喀里多尼亚687NewZealand新西兰64Nicaragua尼加拉瓜505Niger尼日尔227Nigeria尼日利亚234Niue纽埃岛683NorfolkIsland诺福克岛672Norway挪威47Oman阿曼968Pakistan巴基斯坦92Palau帕劳680PalestinianTerritory巴勒斯坦970Panama巴拿马507PapuaNewGuinea巴布亚新几内亚675Paraguay巴拉圭595Peru秘鲁51Philippines菲律宾63Poland波兰48Portugal葡萄牙351Qatar卡塔尔974RéunionIsland留尼汪262Romania罗马尼亚40Russia俄罗斯7Rwanda卢旺达250SaintKittsandNevis圣基茨和尼维斯1869SaintLucia圣卢西亚1758SaintPierreandMiquelon圣皮埃尔和密克隆508SaintVincentandTheGrenadines圣文森特和格林纳丁斯1784消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司181国家(或地区)中文名国家(或地区)码Samoa萨摩亚685SanMarino圣马力诺378SaoTomeandPrincipe圣多美和普林西比239SaudiArabia沙特阿拉伯966Senegal塞内加尔221Serbia塞尔维亚381Seychelles塞舌尔248SierraLeone塞拉利昂232Singapore新加坡65SintMaarten(DutchPart)荷属圣马丁1721Slovakia斯洛伐克421Slovenia斯洛文尼亚386SolomonIslands所罗门群岛677Somalia索马里252SouthAfrica南非27SouthKorea韩国82Spain西班牙34SriLanka斯里兰卡94Suriname苏里南597Swaziland斯威士兰268Sweden瑞典46Switzerland瑞士41Taiwan(China)中国台湾886Tajikistan塔吉克斯坦992Tanzania坦桑尼亚255Thailand泰国66TimorL'este东帝汶670Togo多哥228Tonga汤加676消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司182国家(或地区)中文名国家(或地区)码TrinidadandTobago特立尼达和多巴哥1868Tunisia突尼斯216Turkey土耳其90Turkmenistan土库曼斯坦993TurksandCaicosIslands特克斯和凯科斯群岛1649Tuvalu图瓦卢688Uganda乌干达256Ukraine乌克兰380UnitedArabEmirates阿拉伯联合酋长国971UnitedKingdom英国44UnitedStates美国1Uruguay乌拉圭598Uzbekistan乌兹别克斯坦998Vanuatu瓦努阿图678Venezuela委内瑞拉58Vietnam越南84VirginIslands,British英属维尔京群岛1284WallisandFutuna瓦利斯和富图纳681Yemen也门967Zambia赞比亚260Zimbabwe津巴布韦263消息通知服务接口参考A附录文档版本01(2021-03-30)版权所有华为技术有限公司183B修订记录发布日期修订记录2020-09-30第十四次正式发布.
本次变更说明如下:整体优化文档.
2019-07-05第十四次正式发布.
本次变更说明如下:新增"使用前必读"和"如何调用API"章节.
2018-11-30第十三次正式发布.
2018-09-30第十二次正式发布.
本次变更说明如下:新增查询版本操作2018-04-30第十一次正式发布.
本次变更说明如下:全文新增"错误码"section.
新增使用标签管理服务章节新增批量发送不同内容的推广类短信章节新增Tags结构体、Match结构体、Resource结构体、Resource_tag结构体和Promotion_sms_commit_result结构体新增返回值"401"新增错误码说明刷新错误码"SMN.
0113"刷新批量发送推广类短信、删除短信签名、创建短信模板、查询短信模板和查询短信模板详情刷新"短信发送支持的国家码和地区码"消息通知服务接口参考B修订记录文档版本01(2021-03-30)版权所有华为技术有限公司184发布日期修订记录2018-03-30第十次正式发布.
本次变更说明如下:新增批量发送短信验证码或短信通知新增批量发送不同内容的短信验证码或短信通知新增Sms_commit_result结构体新增Sms_message结构体新增错误码说明SMNE005刷新发送短信验证码或短信通知删除PromotionSms_result结构体2018-01-30第九次正式发布.
本次变更说明如下:新增创建短信模板新增查询短信模板新增查询短信模板详情新增删除短信模板新增批量发送推广类短信刷新错误码说明新增Sms_template结构体新增PromotionSms_result结构体新增短信回调事件说明2017-11-30第八次正式发布.
本次变更说明如下:新增functiongraph订阅协议.
2017-10-30第七次正式发布.
本次变更说明如下:新增dms订阅协议.
新增查询短信的发送状态接口.
新增查询已发送短信的内容接口.
新增查询短信回调事件接口.
新增更新短信回调事件接口.
2017-08-18第六次正式发布.
本次变更说明如下:新增functionstage订阅协议.
消息通知服务接口参考B修订记录文档版本01(2021-03-30)版权所有华为技术有限公司185发布日期修订记录2017-06-30第五次正式发布.
本次变更说明如下:新增短信签名接口.
新增短信签名错误码说明.
2017-03-13第四次正式发布.
本次变更说明如下:Topic新增属性introduction2016-10-29第三次正式发布.
本次变更说明如下:新增接口名称.
修改"生成AK、SK"步骤.
新增短信直发接口.
2016-09-30第二次正式发布.
本次变更说明如下:新增查询Topic属性接口.
新增更新Topic属性接口.
新增删除指定名称的Topic属性接口.
新增删除所有Topic属性接口2016-08-25第一次正式发布.
消息通知服务接口参考B修订记录文档版本01(2021-03-30)版权所有华为技术有限公司186