功能描述

此接口用于获取指定存储桶（Bucket）设置的事件通知规则。

注意事项

调用此接口您必须为桶所有者，或被授权当前桶的 GetBucketNotification 权限。

分层桶暂不支持 GetBucketNotificationV2 接口。

请求消息样式

GET /?notification_v2 HTTP/1.1​
Host: bucketname.tos-cn-beijing.volces.com​
Date: GMT Date​
Authorization: authorization string​

请求参数与消息头

名称	位置	参数类型	是否必选	示例值	说明
notification_v2	Query	String	是	-	代表 GetBucketNotificationV2 请求的特殊标识。

请求元素

该请求无消息元素。

响应消息头

该请求返回的公共响应消息头，请参见公共参数。

响应元素

名称	参数类型	示例值	说明
Rules	Array	-	事件通知规则信息。
Events	Array	["tos:ObjectCreated:", "tos:ObjectRemoved:"]	事件类型。TOS 支持的事件列表，请参见事件列表。父节点：Rules
Filter	Container	-	过滤规则。父节点：Rules
TOSKey	Container	-	对象的过滤信息。父节点：Filter
FilterRules	Array	[ {"Name": "prefix", "Value": "test_" }, { "Name": "suffix", "Value": ".jpg" } ]	对象需要匹配的过滤规则。支持设置 prefix 和 suffix，即分别根据前缀和后缀规则对事件对象过滤。如果同时设置了前缀与后缀规则，则事件需要同时满足二者，才会被通知。如果前后缀均未设置，则会匹配存储桶内所有对象。父节点：TOSKey
Name	String	prefix	匹配条件。取值说明如下: prefix：前缀。 suffix：后缀。父节点：FilterRules
Value	String	test_	匹配的前后缀信息。父节点：FilterRules
RuleId	String	TestNotification	事件通知规则名称，命名规范如下：同一存储桶下创建的事件名称不能重复。长度不超过 255 个字符。如果未设置，则 TOS 将自动生成规则名称。父节点：Rules
Destination	Container	-	事件通知推送目标，至少包含一个目标，最多支持5个不同目标。父节点：Rules
ServiceManaged	Boolean	true	默认值为 true，表明该规则为托管规则。
ServiceManagedBy	String	ServiceCode	托管方的 Service Code，标识该规则归属的管理服务。
VeFaaS	Array	[ {"FunctionId": "l2u0****"} ]	事件投递的目标为函数服务。父节点：Destination
FunctionId	String	l2u0****	事件投递的函数 ID。您可以登录函数服务控制台，在函数配置页面查看函数 ID。父节点：VeFaaS
Kafka	Array	"Kafka":[ { "Role":"trn:iam::214748**:role/aaa", "InstanceId":"kafka-cnoeb1pq83rs**", "Topic":"test-aaa", "User":"bbbbb" } ]	事件投递的目标为消息队列 Kafka 版。父节点：Destination
Role	String	trn:iam::214748****:role/aaa	角色 TRN，用于授权 TOS 访问 Kafka 服务。父节点：Kafka
InstanceId	String	kafka-cnoeb1pq83rs****	Kafka 实例 ID。父节点：Kafka
Topic	String	test-aaa	Kafka Topic 的名称。父节点：Kafka
User	String	bbb	Kafka 用户名称。父节点：Kafka
Version	string	1698031811529301000	事件通知规则的版本号。与 Rules 同级。

请求示例

GET /?notification_v2= HTTP/1.1​
Host: bucketname.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 13:53:55 +0000​
Authorization: authorization string​

响应示例

事件通知投递的目标为函数服务

HTTP/1.1 200 OK
Content-Length: 259
Content-Type: application/json
Date: Wed, 17 May 2023 12:18:08 GMT
Server: TosServer
X-Tos-Id-2: b2cb0164c600cacd6464c600-ac1023d1-1pzG6a-GBN-cgb-tos
X-Tos-Request-Id: b2cb0164c600cacd6464c600-ac1023d1-1pzG6a-GBN-cgb-tos
X-Tos-Server-Time: 7
{
"Rules":[
{
"Events":[
"tos:ObjectCreated:*",
"tos:ObjectRemoved:*"
],
"Filter":{
"TOSKey":{
"FilterRules":[
{
"Name":"prefix",
"Value":"test_"
},
{
"Name":"suffix",
"Value":".jpg"
}
]
}
},
"RuleId":"TestNotification",
"Destination":{
"VeFaaS":[
{
"FunctionId":"l2u0****"
}
]
},
"ServiceManaged": true,
"ServiceManagedBy": "ServiceCode"
}
],
"Version": "1698031811529301000"
}

事件通知投递的目标为消息队列 Kafka 版

HTTP/1.1 200 OK
Content-Length: 414
Content-Type: application/json
Date: Wed, 17 May 2023 12:18:08 GMT
Server: TosServer
X-Tos-Id-2: b2cb0164c600cacd6464c600-ac1023d1-1pzG6a-GBN-cgb-tos
X-Tos-Request-Id: b2cb0164c600cacd6464c600-ac1023d1-1pzG6a-GBN-cgb-tos
X-Tos-Server-Time: 7

{
"Rules": [
{
"Events": [
"tos:ObjectCreated:*",
"tos:ObjectRemoved:*"
],
"Filter": {
"TOSKey": {
"FilterRules": [
{
"Name": "prefix",
"Value": "test_"
},
{
"Name": "suffix",
"Value": ".jpg"
}
]
}
},
"RuleId": "event",
"Destination": {
"Kafka": [
{
"Role": "trn:iam::214748****:role/aaa",
"InstanceId": "kafka-cnoeb1pq83rs****",
"Topic": "test-aaa",
"User": "bbbbb"
}
]
},
"ServiceManaged": true,
"ServiceManagedBy": "ServiceCode"
}
],
"Version": "1755056218115649299"
}

对象存储