华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • URI DELETE /v2/{project_id}/notifications/message_template/{message_template_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考 获取项目ID。 message_template_id 是 String 模板唯一的资源标识,可通过查询消息模板列表获取该标识。
  • URI DELETE /v2/{project_id}/{resource_type}/{resource_id}/tags/{key} 表1 路径参数 参数 是否必选 参数类型 描述 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。您可在控制台获取。 key 是 String 待删除标签的key值。
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID 状态码: 400 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • URI DELETE /v2/{project_id}/notifications/topics/{topic_urn}/attributes/{name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考 获取项目ID。 topic_urn 是 String Topic的唯一的资源标识,可通过查询主题列表获取该标识。 name 是 String 主题策略名称。只支持特定的策略名称,请参见Topic属性表。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • URI GET /v2/{project_id}/notifications/applications/{application_urn} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取项目ID请参考 获取项目ID。 application_urn 是 String Application的唯一资源标识,可通过查询Application获取该标识。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 application_id String Application的唯一标识ID。 attributes attributes object Application的属性列表。 表4 attributes 参数 参数类型 描述 enabled String 应用平台是否启用。 apple_certificate_expiration_date String 苹果证书过期时间,APNS、APNS_SANDBOX平台特有属性 时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • 响应示例 状态码: 200 OK { "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085", "application_id" : "b1b8643dc12b4g77ad6e35a16003119b", "attributes" : { "enabled" : "true", "apple_certificate_expiration_date" : "2018-03-09T12:21:40Z" }}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 attributes attributes object 属性列表。 表4 attributes 参数 参数类型 描述 enabled String 设备是否可用。 token String 设备token。 user_data String 用户数据。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • URI GET /v2/{project_id}/notifications/endpoints/{endpoint_urn} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取项目ID请参考 获取项目ID。 endpoint_urn 是 String Endpoint的唯一资源标识,可通过查询Application的Endpoint列表获取该标识。
  • 错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 200 SMN.0025 Template already exists. 模板已经存在。 请不要重复创建相同的模板 201 SMN.0121 An application with the same name but different properties already exists. 具有相同名称但属性不同的应用程序已存在。 请输入有效的application名称 201 SMN.0190 This endpoint already exists. endpoint已存在。 该endpoint在列表中已经存在。 400 SMN.0002 Parameter: Name is invalid. 参数:name无效。 请输入有效的topic名称 400 SMN.0003 Parameter: DisplayName is invalid. 参数:displayname无效。 请输入有效的topic显示名 400 SMN.0005 Parameter: TopicUrn is invalid. 参数:topic_urn无效 请输入有效的topic_urn参数。 400 SMN.0011 Parameter: Protocol is invalid. 参数:protocol无效。 请输入正确的协议类型 400 SMN.0012 Parameter: Endpoint is invalid. 参数:endpoint无效。 请输入正确格式的终端。 400 SMN.0014 Parameter: SubscriptionUrn is invalid. 参数:SubscriptionUrn 无效。 请输入有效的subscription_urn。 400 SMN.0015 Parameter: Offset or limit is invalid. 参数:offset or limit无效。 请输入有效的offset和limit 400 SMN.0017 Parameter: Remark is invalid. 参数:remark无效。 请输入有效的remark参数 400 SMN.0019 Producer Exceptions. 生成器异常。 如遇到请联系技术支持。 400 SMN.0021 MessageStructure is invalid. 消息结构无效。 请输入有效的message_structure参数 400 SMN.0024 Parameter: content is invalid. 参数: content无效。 请输入有效的content参数。 400 SMN.00290 SubscriberUrn is unavailable. SubscriberUrn不可用。 检查SubscriberUrn是否正确。 400 SMN.0031 Parameter: template_id is invalid. 参数:template_id 无效。 请输入有效的template_id参数。 400 SMN.0032 Parameter: message_template_name is invalid. 参数:message_template_name 无效。 请输入有效的message_template_name参数。 400 SMN.0033 Parameter: push_policy is invalid. 参数:push_policy 无效。 请输入有效的push_policy参数。 400 SMN.0034 Parameter: subscription_auth_policy is invalid. 参数:subscription_auth_policy 无效。 请输入有效的subscription_auth_policy参数。 400 SMN.0035 Parameter: validation_policy is invalid. 参数:validation_policy 无效。 请输入有效的validation_policy参数。 400 SMN.0036 Parameter: xdomain_type is invalid. 参数:xdomain_type 无效。 请输入有效的xdomain_type参数。 400 SMN.0038 Parameter: tag is invalid. 参数:tag无效。 请输入有效的tag参数。 400 SMN.0042 Parameter: Message_template_name is invalid. 参数:message_template_name无效。 请输入有效的message_template_name参数。 400 SMN.0043 Parameter: subscription is invalid. 参数:subscription无效。 请输入有效的subscription参数。 400 SMN.0044 Exceeded template limit. 模板数量超过限制。 消息模板数量超过限制。每个用户可以创建100个消息模板。 400 SMN.0046 Parameter: Attribute name is invalid. 参数:attribute_name无效。 输入有效的attribute_name。 400 SMN.0048 Parameter: Access policy is invalid. 参数:access_policy无效。 请输入有效的access_policy值。 400 SMN.0049 Parameter: Access policy version is invalid. 参数:access_policy版本无效。 请输入access policy 规范的版本。 400 SMN.0050 Parameter: Access policy ID is invalid. 参数:access_policy id无效。 请输入有效的access_policy id值。 400 SMN.0051 Parameter: Access policy statement is invalid. 参数:access_policy statement无效。 请输入有效的access_policy statement值。 400 SMN.0052 Parameter: Access policy statement ID is invalid. 参数:access_policy statement id无效。 请输入有效的access_policy statement id值。 400 SMN.0053 Parameter: Access policy statement resource is invalid. 参数:access_policy statement resource无效。 请输入有效的access_policy statement resource值。 400 SMN.0054 Parameter: Access policy statement effect is invalid. 参数:access_policy statement effect无效。 请输入有效的access_policy statement effect值。 400 SMN.0055 Parameter: Access policy statement action is invalid. 参数:access_policy statement action无效。 请输入有效的access_policy statement action值。 400 SMN.0056 Parameter: Access policy statement principle is invalid. 参数:access_policy statement principle无效。 请输入有效的access_policy statement principle值。 400 SMN.0058 Parameter: Access policy statement condition is invalid. 参数:access_policy statement condition无效。 请输入有效的access_policy statement condition值。 400 SMN.0059 Parameter: job_id is invalid. 参数:job_id无效。 如遇到请联系技术支持。 400 SMN.0061 Parameter: Service name is invalid. 参数:Service name无效。 如遇到请联系技术支持。 400 SMN.0062 Parameter: Show name is invalid. 参数:Show name无效。 如遇到请联系技术支持。 400 SMN.0066 Parameter: System parameter name is invalid. 参数:系统参数名称无效。 如遇到请联系技术支持。 400 SMN.0067 Parameter: System parameter value is invalid. 参数:系统参数值无效。 如遇到请联系技术支持。 400 SMN.0072 Parameter: Service is invalid. 参数:service无效。 请输入有效的service参数。 400 SMN.0073 Parameter: Invalid action. 参数:action无效。 请输入有效的action参数。 400 SMN.0074 Failed to add permission. 添加权限失败。 如遇到请联系技术支持。 400 SMN.0077 Parameter: Status is invalid. 参数:status无效。 请输入有效的status参数。 400 SMN.0080 The signId parameter is invalid. 参数:sign_id无效。 请输入有效的sign_id参数。 400 SMN.0081 The signName parameter is invalid. 参数:sign_name无效。 请输入有效的sign_name参数,签名只能由中文、英文字母和数字组成,长度为2到8个字符。 400 SMN.0082 The length of the remark parameter value has reached the maximum allowed. remark参数超过长度限制。 请输入有效的remark参数。 400 SMN.0087 The SMS message signature has not been approved. 短信签名未被审批通过。 请输入已经审批通过的签名。 400 SMN.0090 Invalid domain ID. 无效的domain_id。 请输入有效的domain_id。获取方法请参见获取项目ID。 400 SMN.0092 The kafka_id parameter is invalid. 参数:kafka_id无效。 如遇到请联系技术支持。 400 SMN.0093 The address_list parameter is invalid. 参数:address_list无效。 如遇到请联系技术支持。 400 SMN.0094 The type of queue parameter is invalid. 队列参数类型无效。 如遇到请联系技术支持。 400 SMN.0095 The count of queue parameter is invalid. 队列参数统计数量无效。 如遇到请联系技术支持。 400 SMN.0097 The names parameter is invalid. names参数无效。 如遇到请联系技术支持。 400 SMN.0100 The eventType parameter is invalid. 参数:event_type无效。 请输入有效的event_type参数。 400 SMN.0102 Parameter: message_id is invalid. 参数:message_id无效。 请输入有效的message_id参数。 400 SMN.0103 The start_time parameter value is invalid. start_time参数值无效。 请输入有效的start_time参数。 400 SMN.0104 The end_time parameter value is invalid. end_time参数值无效。 请输入有效的end_time参数。 400 SMN.0108 Parameter: Type is invalid. 参数:type无效。 请输入有效的type参数。 400 SMN.0110 Parameter: Start date is invalid. 参数:start_date无效。 请输入有效的start_date参数。 400 SMN.0112 Parameter: End date is invalid. 参数:end_date无效。 请输入有效的end_date参数。 400 SMN.0113 The start time and end time must be within the past 3 months. 开始时间和结束时间必须在过去3个月内。 开始时间和结束时间必须在过去3个月内。 400 SMN.0114 The end time must be later than the start time. 结束时间必须大于开始时间。 结束时间必须大于开始时间。 400 SMN.0115 Parameter: Application name is invalid. 参数:application name无效。 请输入有效的application name。 400 SMN.0118 Wrong Certificate. 证书错误。 请输入有效证书。 400 SMN.0123 Parameter: ApplicationUrn is invalid. 参数:application_urn无效。 请输入有效的application_urn参数。 400 SMN.0124 Parameter: application attribute is invalid. 参数:application_attributes无效。 请输入有效的attributes参数。 400 SMN.0126 ContentType is wrong. Content类型错误。 如遇到请联系技术支持。 400 SMN.0129 Certificate type is wrong. 证书类型错误。 如遇到请联系技术支持。 400 SMN.0132 The value of the User_data parameter is invalid. user_data无效。 请输入有效的user_data。 400 SMN.0133 The device token already exists. device_token已存在。 device_token不能重复创建 400 SMN.0134 The endpoint URN is invalid. endpoint_urn无效。 请输入有效的endpoint_urn。 400 SMN.0135 The endpoint does not exist. endpoint不存在。 请使用存在的endpoint 400 SMN.0136 The value of the enabled parameter is invalid. enabled无效。 请输入有效的enabled参数。 400 SMN.0137 The application URN is invalid. application_urn无效。 请输入有效的application_urn参数。 400 SMN.0140 The topic URN configured for the message sending failure event is invalid. 配置发送消息失败回调事件的topic_urn无效。 配置发送消息失败回调事件的topic_urn无效,请输入有效的topic_urn。 400 SMN.0141 The topic configured for the message sending failure event does not exist. 配置发送消息失败回调事件的topic_urn不存在。 配置发送消息失败回调事件的topic_urn不存在,请输入有效的topic_urn。 400 SMN.0142 The topic URN configured for the message sending success event is invalid. 配置发送消息成功回调事件的topic_urn无效。 配置发送消息成功回调事件的topic_urn无效,请输入有效的topic_urn。 400 SMN.0143 The topic configured for the message sending success event does not exist. 配置发送消息成功回调事件的topic_urn不存在。 配置发送消息成功回调事件的topic_urn不存在,请输入有效的topic_urn。 400 SMN.0144 The topic URN configured for the response message event is invalid. 配置回复消息回调事件的topic_urn无效。 配置回复消息回调事件的topic_urn无效,请输入有效的topic_urn。 400 SMN.0145 The topic configured for the response message event does not exist. 配置回复消息回调事件的topic_urn不存在。 配置回复消息回调事件的topic_urn不存在,请输入有效的topic_urn。 400 SMN.0148 Parameter: user_id is invalid. 参数:user_id无效。 请输入有效的user_id参数。 400 SMN.0150 Complete real-name registration using your company's certificate. 使用贵公司的证书完成实名注册。 如遇到请联系技术支持。 400 SMN.0151 The message signature type cannot be promotional. 不能是推广类消息签名。 请输入通知验证码类短信签名。 400 SMN.0152 The number allocated to the SMS template has reached the maximum allowed. 分配的短信模板数量已达限额。 创建的短信模板超过限额,每个用户可以创建100个短信模板。 400 SMN.0155 Parameter: SmsTemplateType is invalid. 参数:sms_template_type无效。 请输入有效的sms_template_type,请参见创建短信模板。 400 SMN.0156 Parameter: SmsTemplateName is invalid. 参数:sms_template_name无效。 请输入有效的sms_template_name,请参见创建短信模板。 400 SMN.0157 Parameter: SmsTemplateContent is invalid. 参数:sms_template_content无效。 请输入有效的sms_template_content,请参见创建短信模板。 400 SMN.0159 The number of endpoints has reached the maximum allowed. 终端数量已达配额。 发送号码个数超过限额,手机号码个数不能超过1000。 400 SMN.0160 Invalid endpoint. endpoint无效。 请输入有效的endpoint。 400 SMN.0161 Invalid SMS template ID. 短信模板ID无效。 请输入有效的sms_template_id。 400 SMN.0188 Invalid SMS template type. 短信模板类型无效。 当前的短信模板类型不存在,必须是推广模板。 400 SMN.0189 Failed to obtain the certificate required for reviewing the SMS message template function. 获取查看sms消息模板功能所需的证书失败。 如遇到请联系技术支持。 400 SMN.0191 Parameter: Invalid enterprise name. 公司名称无效。 如遇到请联系技术支持。 400 SMN.0192 Parameter: Invalid enterprise certificate ID. 公司证书无效。 如遇到请联系技术支持。 400 SMN.0204 Promotional SMS messages must contain the way to unsubscribe in the end, for example, by replying "TD", or "T". 推广短信末尾必须包含取消订阅的方式,例如, 通过回复 "TD" 或 "T"。 在推广短信内容末尾必须包含退订方式,比如在内容末尾添加“退订回TD”。 400 SMN.0215 The SMS message signature ID does not match the signature name in the SMS message template content. sms 消息签名 id 与 sms 消息模板内容中的签名名称不匹配。 请传入与sms_template_content内容中的签名名称一致的签名ID。 400 SMN.0216 The template content does not include any valid SMS message signature. 模板内容不包括任何有效的 sms 消息签名。 请在内容填入有效的签名。 400 SMN.0217 The template content does not include any SMS message signature. 模板内容不包括任何 sms 消息签名。 sms_template_content内容必须要包含有效的签名名称,如【XX商城】。 400 SMN.0224 The SMS message template is invalid because the associated signature has been deleted. 短信模板因关联签名删除已失效。 请传入有效的sms_template_id。 400 SMN.0227 The message contains sensitive words. 消息中包含敏感关键词。 当前传入的message中包含敏感关键词,请根据返回提示修改message内容。 400 SMN.0230 Parameter: Invalid title. 参数title无效。 请输入合法的title参数 400 SMN.0261 Check whether your account balance is sufficient and top up your account if necessary. 请检查账户余额是否充足,如余额不足请尽快充值。 请检查账户余额是否充足,如余额不足请尽快充值。 403 SMN.0001 No permission to request resources. 没有请求资源的权限。 添加相应的权限 403 SMN.0004 Exceeded topic limit. 主题数量超过限制。 topic数量超过了限制,每个用户可以最多创建3000个主题。 403 SMN.0007 Exceeded subscription limit. 订阅数量超过限制。 每个主题最多支持10000个订阅者。 403 SMN.0008 Parameter: Subject is invalid. 参数: subject无效。 请输入有效的subject参数。 403 SMN.0009 Parameter: Message is invalid. 参数:message无效。 请输入有效的message参数 403 SMN.0022 Parameter: token is invalid. 参数:token无效。 请输入有效token。 403 SMN.00308 Policy doesn't allow {} to be performed. 策略不允许执行。 请检查SMN权限。 403 SMN.0047 Parameter: Value exceeds the maximum length. 参数:value 超出最大长度。 请输入有效的 value值 403 SMN.0057 The number of SMS messages exceeds the limit. SMS消息的数量超过了限制。 短信直发时,同一个手机号码限制1小时内最多发送60条短信,12小时最多发200条短信。 403 SMN.0065 The number of email messages exceeds the limit. 邮件的数量超过了限制。 如遇到请联系技术支持。 403 SMN.0069 Not authorized to subscribe internal endpoints. 订阅内部终端未授权。 检查http(s)终端地址,请填写正确的https(s)终端地址。 403 SMN.0070 No permission to request resources. The role is op_restricted. Contact customer service. 没有请求资源的权限。操作受限。 请检查余额是否充足,余额不足请尽快充值。如未解决,请联系客服技术支持。 403 SMN.0071 No permission to request resources.Role is op_suspended. 没有请求资源的权限。角色被 挂起。 请检查账号是否被挂起冻结。 403 SMN.0075 Parameter: tags are too many. 参数: 标签数过多。 超过消息模板的最大非重复标签数,模板内容中允许最多90个不重复的标签。 403 SMN.0078 The maximum number of subscriptions has been reached. 已达到订阅的最大数量。 订阅者列表超过数量限制。 403 SMN.0083 Finish real-name authentication before continuing. 请先完成实名认证。 如遇到请联系技术支持。 403 SMN.0086 The number allocated to the SMS message signature has reached the maximum allowed. 分配给 sms 消息签名的数字已达限额。 创建签名超过限额,您最多可以创建10个短信签名。 403 SMN.0099 The SMN service has not been authorized to send messages to this queue. SMN服务未被授权将消息发送到此队列。 请在该队列策略里面授权smn服务相关权限。 403 SMN.0116 PlatForm do not support yet. 平台暂不支持。 该平台暂不支持。 403 SMN.0117 Certificate type is not supported. 证书类型暂不支持。 该证书类型暂不支持。 403 SMN.0119 PlatformPrinciple must be at most 8192 bytes long in UTF-8 encoding. UTF-8编码的platform_principle不得超过8192bytes。 请输入有效platform_principle参数,不超过8192bytes,且为UTF-8编码。 403 SMN.0120 PlatformCredential must be at most 8192 bytes long in UTF-8 encoding. platform_credential不超过8192bytes,且为UTF-8编码。 请输入有效platform_credential参数,不超过8192bytes,且为UTF-8编码。 403 SMN.0127 File is too large. 文件过大。 如遇到请联系技术支持。 403 SMN.0128 Password is empty. 密码为空。 如遇到请联系技术支持。 403 SMN.0131 The value of the Token parameter is invalid. token无效。 请输入有效的token。 403 SMN.0147 Only enterprise users who use the certificate images for authentication can create message signatures. 只有使用证书进行身份验证的企业用户才能创建消息签名。 如遇到请联系技术支持。 403 SMN.0153 Only enterprise users can create SMS message Template. 只有企业用户才能创建短信模板。 请完成企业身份认证。 403 SMN.0154 Only enterprise users who use the certificate images for authentication can create sms message templates. 只有使用证书进行身份验证的企业用户才能创建短信模板。 如遇到请联系技术支持。 403 SMN.0165 Parameter: tenant_token is invalid. 参数:tenant_token无效。 请输入有效的tenant_token参数。 403 SMN.0195 Complete enterprise real-name authentication first. 请先完成实名认证。 请进行实名认证。 403 SMN.0228 Do not have permission to use this API. Contact customer service to apply for permission. 当前接口没有使用权限,如需使用请联系客服申请。 当前接口目前没有权限访问,如需使用请联系技术支持申请。 404 SMN.0006 Topic not found. 未查询到该主题。 topic不存在。 404 SMN.0013 Subscription resource not found. 查询不到订阅资源。 请使用正确的订阅资源 404 SMN.0027 Template not found. 找不到模板。 请使用存在的模版。 404 SMN.0045 Attribute not found. 未查询到attribute 。 请使用存在的属性。 404 SMN.0060 Job not found. 查询不到Job 。 如遇到请联系技术支持。 404 SMN.0063 Cloud service not found. 找不到云服务。 如遇到请联系技术支持。 404 SMN.0068 System parameter not found. 找不到系统参数。 如遇到请联系技术支持。 404 SMN.0076 Default message template not found. 默认消息模板不存在。 请先创建一个default模板。 404 SMN.0084 The SMS message signature could not be found. 找不到SMS短信签名。 请输入已经审批通过的签名。 404 SMN.0091 Default system message template not found. 不存在默认系统消息模板。 请先创建一个默认模板。 404 SMN.0096 Kafka not found. 找不到Kafka。 如遇到请联系技术支持。 404 SMN.0098 This queue does not exist. 队列不存在。 请输入有效的DMS队列。 404 SMN.0101 The graph does not exist in the functiongraph service. 函数在functiongraph服务中不存在。 请检查functiongraph终端是否输入正确。 404 SMN.0109 Start date is not found. 找不到参数start_date。 请输入有效的start_date参数,不能为空。 404 SMN.0111 End date is not found. 找不到参数end_date。 请输入有效的end_date参数,不能为空。 404 SMN.0122 Application not found. 找不到应用程序。 请输入有效的application名称 404 SMN.0125 Endpoint does not exist. 终端不存在。 请输入存在的application endpoint 404 SMN.0130 The application does not exist. 平台不存在。 请输入有效的application_urn。 404 SMN.0162 SMS template not found. 短信模板不存在。 短信模板不存在,请输入有效的短信模板。 404 SMN.0167 Phone number does not exist. 手机号码不存在。 用户注册的手机号码不存在。 404 SMN.0168 Email Address does not exist. 邮件地址不存在。 用户注册的邮件地址不存在。 429 SMN.00359 Topic publishing exceeds the flow control limit, please try again later. 主题发布超过流控限制。 请稍后重试。 429 SMN.00362 Topic publishing exceeds the global flow control limit, please try again later. 主题发布超过全局流控限制。 请稍后重试。 500 SMN.0016 Database Exceptions. 数据库异常。 如遇到请联系技术支持。 500 SMN.0018 Service internal error. 服务内部错误。 如遇到请联系技术支持。 500 SMN.0089 An error occurred in the BSS system. Try again later. BSS系统中出现错误。请稍后再试。 如遇到请联系技术支持。 500 SMN.0158 Failed to upload the file. 上传文件失败。 如遇到请联系技术支持。 父主题: 附录
  • 响应示例 状态码: 200 OK { "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" : "no user data", "enabled" : "true", "token" : "1f2fda4c1013c47ac4c59bd22379d88e14b07b0ebf47f2f79d1a6b06ed03390d" } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 next_page_flag Boolean 是否有下一页标识。 endpoints Array of ApplicationEndpoint objects Application_endpoint结构体数。 表5 ApplicationEndpoint 参数 参数类型 描述 create_time String 创建application的时间 时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 endpoint_urn String Application endpoint的唯一资源标识。 user_data String 用户自定义数据 最大长度支持UTF-8编码后2048字节。 enabled String endpoint启用开关 true或false字符串。 token String 设备token 最大长度512个字节。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表8 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • URI GET /v2/{project_id}/notifications/applications/{application_urn}/endpoints 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取项目ID请参考 获取项目ID。 application_urn 是 String Application的唯一资源标识,可通过查询Application获取该标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。 偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0。 缺省值:0 limit 否 Integer 查询的数量限制。 取值范围:1~100,取值一般为10,20,50。功能说明:每页返回的资源个数。默认值为100。 缺省值:100 enabled 否 String 设备是否可用,值为true或false字符串。 token 否 String 设备token,最大长度512个字节。 user_data 否 String 用户数据,最大长度2048个字节。
  • 响应示例 状态码: 200 OK { "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", "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" } ]}
  • URI GET /v2/{project_id}/notifications/applications 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取项目ID请参考 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。 偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0。 缺省值:0 limit 否 Integer 查询的数量限制。 取值范围:1~100,取值一般为10,20,50。功能说明:每页返回的资源个数。默认值为100。 缺省值:100 name 否 String 检索应用名称。 支持后向模糊匹配,长度不得超过64个字符,只能包含英文字母、下划线和数字。 platform 否 String 应用平台。 目前仅支持HMS、APNS、APNS_SANDBOX。 HMS是为开发者提供的消息推送平台。 APNS和APNS_SANDBOX是用于推送iOS消息的服务平台。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 application_count Integer 返回的Application个数。该参数不受offset和limit影响,即返回的是您帐户下所有的Application个数。 applications Array of ApplicationItem objects Application列表。 表5 ApplicationItem 参数 参数类型 描述 name String 创建application的名字。 platform String 应用平台。 create_time String 创建application的时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 application_urn String Application的唯一资源标识。 application_id String Application的唯一标识ID。 enabled String 应用平台是否启用。 apple_certificate_expiration_date String 苹果证书过期时间APNS、APNS_SANDBOX平台特有属性时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表8 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 message_template_id String 模板ID。 message_template_name String 模板名称。 protocol String 模板支持的协议类型。 目前支持的协议包括: “default”:默认协议。 “email”:邮件传输协议。 “sms”:短信传输协议。 “functionstage”:FunctionGraph(函数)传输协议。 “dms”:DMS传输协议。 “http”、“https”:HTTP/HTTPS传输协议。 tag_names Array of strings 模板tag列表。 是消息模板“{}”内的字段,在具体使用消息模板时,可根据实际情况替为该字段赋值。 create_time String 模板创建时间。 时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 update_time String 模板最后更新时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 content String 模板内容。 request_id String 请求的唯一标识ID。
  • URI GET /v2/{project_id}/notifications/message_template/{message_template_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考 获取项目ID。 message_template_id 是 String 模板唯一的资源标识,可通过查询消息模板列表获取该标识。
  • 响应示例 状态码: 200 OK { "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)You are invited to subscribe to topic({topic_id_id4}). Click the following URL to confirm subscription:(If you do not want to subscribe to this topic, ignore this message.)", "request_id" : "ba79ca8f794f4f50985ce7b98a401b47"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识 count Integer 云日志信息数量 logtanks Array of LogtankItem objects 云日志信息列表 表4 LogtankItem 参数 参数类型 描述 id String 云日志信息唯一的资源标识。 最小长度:32 最大长度:32 log_group_id String 云日志服务日志组ID。 最小长度:36 最大长度:36 log_stream_id String 云日志服务日志流ID。 最小长度:36 最大长度:36 create_time String 创建时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 update_time String 更新时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标示ID。 error_code String 返回信息对应的代码。 error_msg String 服务异常错误信息描述。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标示ID。 error_code String 返回信息对应的代码。 error_msg String 服务异常错误信息描述。 状态码: 404 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标示ID。 error_code String 返回信息对应的代码。 error_msg String 服务异常错误信息描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标示ID。 error_code String 返回信息对应的代码。 error_msg String 服务异常错误信息描述。
  • 响应示例 状态码: 200 OK { "request_id" : "f5c05cb70d264ca58d1080202ceba284", "count" : 1, "logtanks" : [ { "id" : "4ea80c8a68b840e19b4efd3a8f0d62ed", "log_group_id" : "d1b6c352-ee45-4196-9230-c74b7894e356", "log_stream_id" : "114960b4-1c26-48dd-93c2-4caae24aec49", "create_time" : "2022-10-10T09:00:00Z", "update_time" : "2022-10-10T09:00:00Z" } ]}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of ResourceTags objects 资源标签列表。 表4 ResourceTags 参数 参数类型 描述 key String 键。 最大长度127个unicode字符。 key不能为空。 values Array of strings 值列表。 最多10个value。 value不允许重复。 每个值最大长度255个unicode字符。 如果values为空则表示any_value。 value之间为或的关系。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • 响应示例 状态码: 200 OK { "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" }, { "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" } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 message_template_count Integer 返回的模板个数。 message_templates Array of MessageTemplate objects Message_template结构体数组。 表5 MessageTemplate 参数 参数类型 描述 message_template_id String 模板ID。 message_template_name String 模板名称。 protocol String 模板协议类型。 目前支持的协议包括: “email”:邮件传输协议。 “sms”:短信传输协议。 “functionstage”:FunctionGraph(函数)传输协议。 “dms”:DMS传输协议。 “http”、“https”:HTTP/HTTPS传输协议。 tag_names Array of strings 模板tag列表 create_time String 模板创建时间 时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 update_time String 模板最后更新时间 时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表8 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • URI GET /v2/{project_id}/notifications/message_template 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源,默认值为0。 缺省值:0 limit 否 Integer 取值范围:1~100,取值一般为10,20,50。功能说明:每页返回的资源个数。默认值为100。 缺省值:100 message_template_name 否 String 模板的名称。 只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度在1到64个字符之间。 protocol 否 String 模板支持的协议类型。 目前支持的协议包括: “default”:默认协议。 “email”:邮件传输协议。 “sms”:短信传输协议。 “functionstage”:FunctionGraph(函数)传输协议。 “dms”:DMS传输协议。 “http”、“https”:HTTP/HTTPS传输协议。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 log_group_id 是 String 云日志服务日志组ID。 最小长度:36 最大长度:36 log_stream_id 是 String 云日志服务日志流ID。 最小长度:36 最大长度:36
共100000条