设置Bucket通知规则
更新时间：2021-12-29
接口说明
本接口用于指定bucket上增加通知规则。
注意：
- 只有bucket owner或者full control权限才能获取这个bucket的配置。
- 如果不是bucket owner则返回403，如果对应的文件不存在则返回404。
请求URI
PUT /v1/{bucketName}/?notification
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| bucketName | String | 是 | bucket的名称 | "bucketName_example" | Path |
请求体参数
请求体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| notifications | List<Notifications> | 否 |
Notifications字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| id | String | 是 | 规则id | notify-id-1 |
| name | String | 否 | 规则名称 | rule-name |
| appId | String | 是 | 注册本条规则的产品id | app-id-1 |
| status | String | 是 | 可选值：{"disabled", "enabled"} | enabled |
| encryption | Encryption | 否 | 加密方式 | |
| resources | List<String> | 是 | 订阅的资源，${bucketname}/path1/.jpg或者/path1/_.jpg，最多只能有1个* | |
| events | List<String> | 是 | 订阅的事件 | |
| apps | List<Apps> | 是 | 订阅消息的产品 |
Encryption字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| key | String | 否 | 加密密钥，如果不为空，则用IAM的算法对通知的请求进行签名，key对应IAM签名中的SecretAccessKey | 06a62b70f47dc4a0a7da349609f1a1ac |
Apps字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| id | String | 否 | 被通知的产品id | app-id-3 |
| eventUrl | String | 否 | 处理事件通知的url，可选值：{"http", "https", "brn", "app"}，http/https为自定义应用，brn为cfc的通知，app为官方应用 | app:ImageOcr |
| xVars | String | 否 | 透传的自定义参数，对框架透明，用于业务自我回传的值，如果是官方AI应用，则是一个字符串化的json，并包含一个saveUrl的地址，用于接收处理结果 | {"saveUrl": "http://xxx.com/ocr\"} |
响应体参数
响应体字段数据结构说明
请求示例
PUT /v1/bucketName_example/?notification
<公共请求头>
{
"notifications" : [ {
"encryption" : {
"key" : "06a62b70f47dc4a0a7da349609f1a1ac"
},
"appId" : "app-id-1",
"name" : "rule-name",
"resources" : [ "bucket-a/path1" ],
"id" : "notify-id-1",
"events" : [ "PutObject" ],
"status" : "enabled",
"apps" : [ {
"eventUrl" : "app:ImageOcr",
"xVars" : "{\"saveUrl\": \"http://xxx.com/ocr\"}",
"id" : "app-id-3"
} ]
} ]
}响应示例
HTTP/1.1 200 OK
<公共响应头>
{ }错误码
请参考通用错误码