推送事件消息
所有文档

          对象存储 BOS

          推送事件消息

          接口说明

          将事件消息推送到配置的url上。

          如果规则中配置了encryption字段,那么请求中会包含Authorization的签名,保证消息不会被伪造或篡改。

          注意:

          • Status Code: 200 OK才会认为消息推送成功,否则将会重试;
          • 对于过载保护的情况,支持Status Code: 429 Too Many Requests返回值,会间隔一段时间再重试;

          请求URI

          POST /v1/{bucketName}/?event

          参数名称 参数类型 是否必须 描述 示例值 参数位置
          bucketName String bucket的名称 "bucketName_example" Path

          请求体参数

          请求体字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          events List<Events>

          Events字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          version String 事件版本,当前为1.0 1.0
          eventId String 事件唯一标识 2a513199-bbb9-4ac7-b12a-60213c26810d
          eventOrigin String 事件触发源,当前支持增量(bos:realtime) bos:realtime
          eventTime String 事件发生时间(GMT格式) 2018-09-05T02:28:49Z
          eventType String 事件类型 PutObject
          content Content 事件具体信息

          Content字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          userId String 用户id c7ac82ae14ef42d1a4ffa3b2ececa17f
          domain String 所属的domain bj.bcebos.com
          bucket String 所属的bucket bucket-test
          object String object名字 images/test.jpg
          eTag String object的eTag,如果object可能被覆盖,则需要用eTag判断是哪个版本的object触发的事件 977b9623a15e520c663ac5ff6647e881
          contentType String object的Content-Type application/octet-stream
          filesize Integer 文件大小 24414
          lastModified String 文件更新时间 2018-09-05T02:28:49Z
          credentials Credentials 相关资源的临时授权,具体使用参考临时授权访问
          xVars String 用户设置通知中的xVars原文 {"saveUrl": "http://xxx.com/ocr\"}

          Credentials字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          accessKeyId String 临时授权的Access Key ID f3ade7c6b1a911e8bb6821a724cc157d
          secretAccessKey String 临时授权的Secret Access Key 07381a56d35e4b1193a418362221de81
          sessionToken String 临时授权的Session Token ZGZiM2M3MmU4Mjk4NGQ2MGEzYTNhYTAyMDE3NTZmZmV8AAAAAIcCAADaE18IR6jSaVWlMHxZG5wzb/7AQas3Y6V
          expiration String 临时授权的的有效时间 2018-02-22T11:22:33Z

          响应体参数

          响应体字段数据结构说明

          请求示例

          POST /v1/bucketName_example/?event
          <公共请求头>
          
          
          {
            "events" : [ {
              "eventId" : "2a513199-bbb9-4ac7-b12a-60213c26810d",
              "eventTime" : "2018-09-05T02:28:49Z",
              "eventType" : "PutObject",
              "version" : "1.0",
              "content" : {
                "bucket" : "bucket-test",
                "credentials" : {
                  "accessKeyId" : "f3ade7c6b1a911e8bb6821a724cc157d",
                  "secretAccessKey" : "07381a56d35e4b1193a418362221de81",
                  "sessionToken" : "ZGZiM2M3MmU4Mjk4NGQ2MGEzYTNhYTAyMDE3NTZmZmV8AAAAAIcCAADaE18IR6jSaVWlMHxZG5wzb/7AQas3Y6V",
                  "expiration" : "2018-02-22T11:22:33Z"
                },
                "domain" : "bj.bcebos.com",
                "xVars" : "{\"saveUrl\": \"http://xxx.com/ocr\"}",
                "eTag" : "977b9623a15e520c663ac5ff6647e881",
                "filesize" : 24414,
                "lastModified" : "2018-09-05T02:28:49Z",
                "userId" : "c7ac82ae14ef42d1a4ffa3b2ececa17f",
                "contentType" : "application/octet-stream",
                "object" : "images/test.jpg"
              },
              "eventOrigin" : "bos:realtime"
            } ]
          }

          响应示例

          HTTP/1.1 200 OK
          <公共响应头>
          
          { }

          错误码

          请参考通用错误码

          上一篇
          推送ImageOcr和ImageClassify消息
          下一篇
          删除Bucket的通知规则