获取Bucket的通知规则
更新时间:2021-12-29
接口说明
本接口用于获取指定bucket上的通知规则。
请求URI
GET /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 |
resources | List<String> | 订阅的资源 | |
events | List<String> | 订阅的事件 | |
apps | List<Apps> | 订阅消息的产品 |
Apps字段数据结构说明
参数名称 | 参数类型 | 描述 | 示例值 |
---|---|---|---|
id | String | app-id-3 | |
eventUrl | String | app:ImageOcr | |
xVars | String | {"saveUrl": "http://xxx.com/ocr\"} |
请求示例
GET /v1/bucketName_example/?notification
<公共请求头>
{ }
响应示例
HTTP/1.1 200 OK
<公共响应头>
{
"notifications" : [ {
"appId" : "app-id-1",
"name" : "rule-name",
"resources" : [ "bucket-a/path1", "bucket-a/path1" ],
"id" : "notify-id-1",
"events" : [ "PutObject", "PutObject" ],
"status" : "enabled",
"apps" : [ {
"eventUrl" : "app:ImageOcr",
"xVars" : "{\"saveUrl\": \"http://xxx.com/ocr\"}",
"id" : "app-id-3"
}, {
"eventUrl" : "app:ImageOcr",
"xVars" : "{\"saveUrl\": \"http://xxx.com/ocr\"}",
"id" : "app-id-3"
} ]
}, {
"appId" : "app-id-1",
"name" : "rule-name",
"resources" : [ "bucket-a/path1", "bucket-a/path1" ],
"id" : "notify-id-1",
"events" : [ "PutObject", "PutObject" ],
"status" : "enabled",
"apps" : [ {
"eventUrl" : "app:ImageOcr",
"xVars" : "{\"saveUrl\": \"http://xxx.com/ocr\"}",
"id" : "app-id-3"
}, {
"eventUrl" : "app:ImageOcr",
"xVars" : "{\"saveUrl\": \"http://xxx.com/ocr\"}",
"id" : "app-id-3"
} ]
} ]
}
错误码
请参考通用错误码