文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 桶相关接口(Python SDK)/ 消息通知(Python SDK)/ 设置桶的事件通知配置(Python SDK)
更新时间：2026-07-13 GMT+08:00
查看PDF
分享

设置桶的事件通知配置(Python SDK)

功能介绍

OBS事件通知功能帮助您对桶的重要的操作进行实时监控，重要操作触发时可及时通知到您，确保您安全、及时知道发生在桶上的关键事件。

调用设置桶的事件通知配置接口，可为指定桶设置事件通知配置。

接口约束

  • 您必须是桶拥有者或拥有设置桶的事件通知配置的权限，才能设置桶的事件通知配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketNotification权限，如果使用桶策略则需授予PutBucketNotification权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

ObsClient.setBucketNotification(bucketName, notification, extensionHeaders)

请求参数说明

参数名

类型

约束

说明

bucketName

str

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

notification

Notification

可选

参数解释：

桶事件通知配置。如果为空，则清除桶的事件通知配置。详见Notification。

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无
表1 TopicConfiguration

参数名称

参数类型

是否必选

描述

id

str

作为请求参数时可选

事件通知配置ID。

topic

str

作为请求参数时必选

事件通知主题的URN，当OBS检测到桶中发生特定的事件后，将会发布通知消息至该主题。

events

list of str

作为请求参数时必选

需要发布通知消息的事件类型列表。

filterRules

list of FilterRule

作为请求参数时可选

过滤规则列表。
表2 EventType

常量值

说明

OBJECT_CREATED_ALL

所有创建对象操作的事件。包含PUT上传对象、POST上传对象、复制对象、合并段。

OBJECT_CREATED_PUT

PUT上传对象的事件。

OBJECT_CREATED_POST

POST上传对象的事件。

OBJECT_CREATED_COPY

复制对象的事件。

OBJECT_CREATED_COMPLETE_MULTIPART_UPLOAD

合并段的事件。

OBJECT_REMOVED_ALL

所有调用删除、取消段接口的对象操作的事件。

包含指定对象版本号删除对象；多版本开启后，不指定对象版本号删除对象。

OBJECT_REMOVED_DELETE

指定对象版本号删除对象的事件。

OBJECT_REMOVED_DELETE_MARKER_CREATED

多版本开启后，不指定对象版本号删除对象的事件。
表3 FilterRule

参数名称

参数类型

是否必选

描述

name

str

作为请求参数时可选

指定规则按对象名前缀或者后缀进行过滤，支持的值：

  • prefix
  • suffix

value

str

作为请求参数时可选

指定的对象名关键字，用以按照前缀或者后缀过滤对象。

返回结果说明

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表4 GetResult

参数名称

参数类型

描述

status

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

reason

str

参数解释：

HTTP文本描述。

默认取值：

无

errorCode

str

参数解释：

OBS服务端错误码，当status参数小于300时为空。

默认取值：

无

errorMessage

str

参数解释：

OBS服务端错误描述，当status参数小于300时为空。

默认取值：

无

requestId

str

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

indicator

str

参数解释：

OBS服务端返回的错误定位码。

默认取值：

无

hostId

str

参数解释：

请求的服务端ID，当status参数小于300时为空。

默认取值：

无

resource

str

参数解释：

发生错误时相关的桶或对象，当status参数小于300时为空。

默认取值：

无

header

list

参数解释：

响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。

默认取值：

无

body

object

参数解释：

操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无

代码样例

try:
    from obs import Notification, TopicConfiguration,FilterRule, EventType, FunctionGraphConfiguration
     
    fr1 = FilterRule(name='prefix', value='smn') 
    fr2 = FilterRule(name='suffix', value='.jpg') 
    topicConfiguration= TopicConfiguration(id='001',topic='your topic',events=[EventType.OBJECT_CREATED_ALL], filterRules=[fr1,fr2]) 
    
    fr3 = FilterRule(name='prefix', value='function')
    fr4 = FilterRule(name='suffix', value='.mp4') 
    functionConfiguration = FunctionGraphConfiguration(id='002', functionGraph='your function', events=[EventType.OBJECT_CREATED_ALL], filterRules=[fr3, fr4])
   
    resp = obsClient.setBucketNotification('bucketname', Notification(topicConfigurations=[topicConfiguration], functionGraphConfigurations=[functionConfiguration]))

    if resp.status < 300: 
        print('requestId:', resp.requestId) 
    else: 
        print('errorCode:', resp.errorCode) 
        print('errorMessage:', resp.errorMessage)
except:
    import traceback
    print(traceback.format_exc())

相关链接

相关文档