推送事件消息
更新时间：2021-12-29
接口说明
将事件消息推送到配置的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 |
响应体参数
响应体字段数据结构说明
请求示例
JSON
1POST /v1/bucketName_example/?event
2<公共请求头>
3
4
5{
6 "events" : [ {
7 "eventId" : "2a513199-bbb9-4ac7-b12a-60213c26810d",
8 "eventTime" : "2018-09-05T02:28:49Z",
9 "eventType" : "PutObject",
10 "version" : "1.0",
11 "content" : {
12 "bucket" : "bucket-test",
13 "credentials" : {
14 "accessKeyId" : "f3ade7c6b1a911e8bb6821a724cc157d",
15 "secretAccessKey" : "07381a56d35e4b1193a418362221de81",
16 "sessionToken" : "ZGZiM2M3MmU4Mjk4NGQ2MGEzYTNhYTAyMDE3NTZmZmV8AAAAAIcCAADaE18IR6jSaVWlMHxZG5wzb/7AQas3Y6V",
17 "expiration" : "2018-02-22T11:22:33Z"
18 },
19 "domain" : "bj.bcebos.com",
20 "xVars" : "{\"saveUrl\": \"http://xxx.com/ocr\"}",
21 "eTag" : "977b9623a15e520c663ac5ff6647e881",
22 "filesize" : 24414,
23 "lastModified" : "2018-09-05T02:28:49Z",
24 "userId" : "c7ac82ae14ef42d1a4ffa3b2ececa17f",
25 "contentType" : "application/octet-stream",
26 "object" : "images/test.jpg"
27 },
28 "eventOrigin" : "bos:realtime"
29 } ]
30}响应示例
JSON
1HTTP/1.1 200 OK
2<公共响应头>
3
4{ }错误码
请参考通用错误码