华为云用户手册

  • 响应示例 状态码: 200 OK { "version" : { "id" : "v2", "links" : [ { "href" : "https://127.0.0.1/v2", "rel" : "self" } ], "min_version" : "", "status" : "CURRENT", "updated" : "2018-09-19T00:00:00Z", "version" : "" }}
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 version VersionItem object 描述V2相关对象的列表。 表3 VersionItem 参数 参数类型 描述 id String 版本ID(版本号),如v2。 min_version String 若该版本API支持微版本,则返回支持的最小微版本号;若不支持微版本,则返回空。 status String 版本状态,为如下3种: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String 版本发布时间,要求用UTC时间格式表示。如v2发布的时间2014-06-28T12:20:21Z。 version String 若该版本API支持微版本,则返回支持的最大微版本号;若不支持微版本,则返回空。 links Array of LinksItem objects API的URL地址。 表4 LinksItem 参数 参数类型 描述 href String 对应快捷链接。 rel 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 服务异常错误信息描述。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 versions Array of VersionItem objects 描述version相关对象的列表。 表3 VersionItem 参数 参数类型 描述 id String 版本ID(版本号),如v2。 min_version String 若该版本API支持微版本,则返回支持的最小微版本号;若不支持微版本,则返回空。 status String 版本状态,为如下3种: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String 版本发布时间,要求用UTC时间格式表示。如v2发布的时间2014-06-28T12:20:21Z。 version String 若该版本API支持微版本,则返回支持的最大微版本号;若不支持微版本,则返回空。 links Array of LinksItem objects API的URL地址。 表4 LinksItem 参数 参数类型 描述 href String 对应快捷链接。 rel 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 服务异常错误信息描述。
  • 响应示例 状态码: 200 OK { "versions" : { "id" : "v2", "links" : [ { "href" : "https://127.0.0.1/v2", "rel" : "self" } ], "min_version" : "", "status" : "CURRENT", "updated" : "2018-09-19T00:00:00Z", "version" : "" }}
  • 响应示例 状态码: 200 OK { "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" : "test create topic v2", "request_id" : "6837531fd3f54550927b930180a706bf", "enterprise_project_id" : "0", "topic_id" : "84698185946d44d08431aa441d8e2cf2"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 update_time String 更新时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 push_policy Integer 消息推送的策略。0表示发送失败,保留到失败队列,1表示直接丢弃发送失败的消息。 create_time String 创建时间。时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ。 name String 创建Topic的名字。 topic_urn String Topic的唯一的资源标识。可以通过查看主题列表获取该标识。 display_name String Topic的显示名,推送邮件消息时,作为邮件发件人显示。 request_id String 请求的唯一标识ID。 enterprise_project_id String 企业项目ID。 topic_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 OK { "request_id" : "6837531fd3f54550927b930180a706bf", "attributes" : { "access_policy" : { "version" : "2016-09-07", "Id" : "__default_policy_ID", "Statement" : [ { "Sid" : "__user_pub_0", "Effect" : "Allow", "Principal" : [ { " CS P" : [ "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" } ] } }}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 attributes TopicAttribute object 属性的键值对。access_policy:topic的访问策略。introduction:topic的简介。 表5 TopicAttribute 参数 参数类型 描述 access_policy AccessPolicy object topic的访问策略 introduction String topic的简介 表6 AccessPolicy 参数 参数类型 描述 Version String 访问策略规范版本。目前只支持“2016-09-07”。 Id String 策略的唯一标识。不能为空。 Statement Array of Statement objects 访问策略是通过Statement语句来定义的。一个访问策略可包含一条或多条Statement语句。通过Statement语句向其他用户或云服务授权对主题的操作。 表7 Statement 参数 参数类型 描述 Sid String Statement语句的ID。 Statement语句ID必须是唯一的,例如statement01、statement02。 Effect String Statement语句的效果。“Allow”或者“Deny”。 Principal String Statement语句作用的对象。 目前支持“CSP”和“Service”两类对象。 “CSP”对象指的是其他用户,可以作用于多个用户。 “Service”对象指的是云服务,可以作用于多个云服务。 Principal元素和NotPrincipal元素两者任选其一。选定后, “CSP”对象填写内容的格式为urn:csp:iam::domainId:root或“*”,其中domainId为其他用户的“账号ID”,“*”指作用于所有人。 “Service”对象填写内容的格式为小写的云服务名称缩写。 NotPrincipal String NotPrincipal:Statement语句排除作用的对象。 目前支持“CSP”和“Service”两类对象。 “CSP”对象指的是其他用户,可以作用于多个用户。 “Service”对象指的是云服务,可以作用于多个云服务。 Principal元素和NotPrincipal元素两者任选其一。选定后, “CSP”对象填写内容的格式为urn:csp:iam::domainId:root或“*”,其中domainId为其他用户的“账号ID”,“*”指作用于所有人。 “Service”对象填写内容的格式为小写的云服务名称缩写。 Action String Statement语句作用的操作。允许使用通配符来表示一类操作,例如:SMN:Update*、SMN:Delete*。如果只填写“*”,表示Statement语句作用的操作为该资源支持的所有操作。Action元素和NotAction元素两者任选其一。目前支持的操作有:SMN:UpdateTopicSMN:DeleteTopicSMN:QueryTopicDetailSMN:ListTopicAttributesSMN:UpdateTopicAttributeSMN:DeleteTopicAttributesSMN:DeleteTopicAttributeByNameSMN:ListSubscriptionsByTopicSMN:SubscribeSMN:UnsubscribeSMN:Publish NotAction String Statement语句排除作用的操作。允许使用通配符来表示一类操作,例如:SMN:Update*、SMN:Delete*。如果只填写“*”,表示Statement语句作用的操作为该资源支持的所有操作。Action元素和NotAction元素两者任选其一。目前支持的操作有:SMN:UpdateTopicSMN:DeleteTopicSMN:QueryTopicDetailSMN:ListTopicAttributesSMN:UpdateTopicAttributeSMN:DeleteTopicAttributesSMN:DeleteTopicAttributeByNameSMN:ListSubscriptionsByTopicSMN:SubscribeSMN:UnsubscribeSMN:Publish Resource String Statement语句作用的主题。 Resource和NotResource两者任选其一。选定后,填写内容为主题URN。 NotResource String Statement语句排除作用的主题。 Resource和NotResource两者任选其一。选定后,填写内容为主题URN。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 403 表9 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 404 表10 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表11 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • URI GET /v2/{project_id}/notifications/topics/{topic_urn}/attributes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考 获取项目ID。 topic_urn 是 String Topic的唯一的资源标识,可通过查询主题列表获取该标识。 表2 Query参数 参数 是否必选 参数类型 描述 name 是 String 主题策略名称。只支持特定的策略名称,请参见Topic属性表。
  • 请求示例 App消息发布 POST https://{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" : "hello world", "content" : "hello world" }, "type" : 3 } } }, "time_to_live" : 3600} 使用消息结构体方式的App消息发布 POST https://{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" : "hello world", "content" : "hello world" }, "type" : 3 } } } }, "time_to_live" : 3600}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 message_id String 唯一的消息ID。 request_id String 请求的唯一标识ID。 状态码: 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 POST /v2/{project_id}/notifications/endpoints/{endpoint_urn}/publish 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取项目ID请参考 获取项目ID。 endpoint_urn 是 String Endpoint的唯一资源标识,可通过查询Application的Endpoint列表获取该标识
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 message 否 String message与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": "Push message content", "title": "Push message content" }, "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": "hello world" } } message_structure 否 String app推送的消息内容,当前支持的推送平台有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": "Push message content", "title": "Push message content" }, "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": "hello world" } } } time_to_live 否 String 消息发送的生存时间,是相对于发布时间的。 SMN系统将移动推送消息转交给推送平台前,会计算该消息在系统消耗的时间。只有消耗的时间小于time_to_live时,SMN才会将消息转交给推送平台,并将time_to_live减去消耗的时间传递给推送平台,否则消息废弃。 time _to_live的单位是s,变量默认值是3600s,即一小时。值为正整数且小于等于3600*24。 缺省值:3600
  • 请求示例 消息发布 POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/publish{ "subject" : "test message v2", "message" : "Message test message v2", "time_to_live" : "3600"} 使用消息结构体方式的消息发布 POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/publish{ "subject" : "test message v2", "message_structure" : "{\n \"default\": \"xxx\",\n \"APNS\": \"{\\\"aps\\\":{\\\"alert\\\":{\\\"title\\\":\\\"xxx\\\",\\\"body\\\":\\\"xxx\\\"}}}\"\n}", "time_to_live" : "3600"} 使用消息模板方式的消息发布 POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/publish{ "subject" : "test message template v2", "message_template_name" : "confirm_message", "time_to_live" : "3600", "tags" : { "topic_urn" : "topic_urn3331", "topic_id" : "topic_id3332" }}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 message_id String 唯一的消息ID。 状态码: 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 服务异常错误信息描述。 状态码: 429 表8 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 code String 服务异常错误信息编码。 message String 服务异常错误信息描述。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 状态码: 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 PUT /v2/{project_id}/notifications/applications/{application_urn} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取项目ID请参考获取项目ID。 application_urn 是 String Application的唯一资源标识,可通过查询Application获取该标识。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 platform_principal 是 String 对于HMS平台是APP ID,只能包含英文字母和数字,最大20个字符。 对于苹果APNS、APNS_SandBox平台是推送证书,大小不超过8K,且是Base64编码。 platform_credential 是 String 对于HMS平台是APP SECRET, 只能包含英文字母和数字,32到64个字符。 对于苹果APNS、APNS_SandBox平台是推送证书的私钥(private key), 大小不超过8K,且是Base64编码。
  • 请求示例 更新消息模板内容 PUT https://{SMN_Endpoint}/v2/{project_id}/notifications/message_template/b3ffa2cdda574168826316f0628f774f{ "content" : "(1/22)You are invited to subscribe to topic({topic_id_id1}). Click the following URL to confirm subscription:(If you do not want to subscribe to this topic, ignore this message.)"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 状态码: 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 服务异常错误信息描述。
  • 概述 欢迎使用 消息通知 服务(Simple Message Notification,SMN)。消息通知服务是可靠的、可扩展的、海量的消息处理服务。它可以依据您的需求主动推送通知消息,最终您可以通过短信、电子邮件、应用等方式接收。您也可以在应用之间通过SMN实现应用的功能集成,降低系统的复杂性。 您可以使用本文档提供的API对消息通知服务进行相关操作,如创建、查询、删除、更新等。支持的全部操作请参见API概览。 在调用消息通知服务API之前,请确保已经充分了解消息通知服务相关概念,详细信息请参见《消息通知服务用户指南》的“产品介绍”。 父主题: 使用前必读
  • URI PUT /v2/{project_id}/notifications/message_template/{message_template_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取项目ID请参考 获取项目ID。 message_template_id 是 String 模板唯一的资源标识,可通过查询消息模板列表获取该标识。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识。 最小长度:32 最大长度:32 logtank LogtankItem object 云日志 信息 表5 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 表6 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标示ID。 error_code String 返回信息对应的代码。 error_msg String 服务异常错误信息描述。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标示ID。 error_code String 返回信息对应的代码。 error_msg String 服务异常错误信息描述。 状态码: 404 表8 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标示ID。 error_code String 返回信息对应的代码。 error_msg String 服务异常错误信息描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标示ID。 error_code String 返回信息对应的代码。 error_msg String 服务异常错误信息描述。
  • 请求示例 更新云日志 PUT https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2/logtanks/4ea80c8a68b840e19b4efd3a8f0d62ed{ "log_group_id" : "d1b6c352-ee45-4196-9230-c74b7894e356", "log_stream_id" : "114960b4-1c26-48dd-93c2-4caae24aec49"}
  • 请求参数 表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
  • 响应示例 状态码: 200 OK { "request_id" : "761bd2658f92411b9b01ae13e7961b11", "logtank" : { "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" }}
  • URI PUT /v2/{project_id}/notifications/topics/{topic_urn}/logtanks/{logtank_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取项目ID请参考 获取项目ID。 topic_urn 是 String Topic的唯一的资源标识,可通过查询主题列表获取该标识。 logtank_id 是 String 云日志信息唯一的资源标识。可通过查询云日志获取该标识。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 enabled 否 String 设备是否可用,值为true或false字符串。 user_data 否 String 用户自定义数据,最大长度支持UTF-8编码后2048字节。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID。 状态码: 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 服务异常错误信息描述。
  • 请求示例 更新Application endpoint POST https://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}/endpoints{ "enabled" : "false", "user_data" : "This is an APNS token for user001"}
共100000条