事件通知

更新时间：2026-09-21

put_notification

本接口用于指定 bucket 上增加通知规则。

注意：

只有 bucket owner 或者 full control 权限才能获取这个 bucket 的配置。

如果不是 bucket owner 则返回 403，如果对应的文件不存在则返回 404。

相关参数的详细解释请参见 PutNotification 接口。

                Python
                
            

                from baidubce.auth.bce_credentials import BceCredentials
from baidubce.bce_client_configuration import BceClientConfiguration
from baidubce.services.bos.bos_client import BosClient

access_key_id = "your-access-key-id"
secret_access_key = "your-secret-access-key"
endpoint = "bj.bcebos.com"
bucket_name = "your-bucket-name"

config = BceClientConfiguration(
    credentials=BceCredentials(access_key_id, secret_access_key),
    endpoint=endpoint
)
bos_client = BosClient(config)

notifications = list()
notifications.append(
    {
        "resources": [
            "/"
        ],
        "encryption": {
            "key": "0123456789abcdef0123456789abcdef"
        },
        "status": "enabled",
        "name": "example-rule",
        "id": "example-rule-id",
        "appId": "example-app",
        "events": [
            "AppendObject",
            "CompleteMultipartUpload",
            "CopyObject",
            "PutObject",
            "PostObject",
            "FetchObject",
            "DeleteObject"
        ],
        "apps": [
            {
                "eventUrl": "http://www.example.com/event",
                "id": "example-app",
                "xVars": "{\"saveUrl\": \"http://www.example.com/ocr\"}"
            }
        ]
    }
)
response = bos_client.put_notification(bucket_name, notifications)
            

参数说明

参数	类型	必填	说明
`bucket_name`	`str` / `bytes`	是	需要增加通知规则的 bucket 名称。
`notifications`	`list[dict]`	是	通知规则列表。SDK 会将该参数封装为 `{"notifications": notifications}` 后提交。
`config`	`BceClientConfiguration`	否	可选请求配置。不传时使用客户端初始化配置。

notifications 中常用字段说明：

参数	类型	必填	说明
`resources`	`list[str]`	是	通知规则生效的资源路径，例如 `"/"` 表示 bucket 下的资源。
`encryption`	`dict`	否	通知规则的加密配置，可包含 `key` 字段。
`status`	`str`	是	通知规则状态，例如 `enabled`。
`name`	`str`	是	通知规则名称。
`id`	`str`	是	通知规则 ID。
`appId`	`str`	是	接收通知的应用 ID。
`events`	`list[str]`	是	触发通知的事件列表，例如 `PutObject`、`DeleteObject` 等。
`apps`	`list[dict]`	是	应用配置列表，可包含 `eventUrl`、`id`、`xVars` 等字段。

返回说明：

调用成功后返回 BceResponse 对象。可通过 response.status_code 查看 HTTP 状态码，通过 response.metadata 查看响应头信息。实际请求成功时，服务端返回 200 OK，响应体为空。

get_notification

本接口用于获取指定 bucket 上的通知规则。

                Python
                
            

                from baidubce.auth.bce_credentials import BceCredentials
from baidubce.bce_client_configuration import BceClientConfiguration
from baidubce.services.bos.bos_client import BosClient

access_key_id = "your-access-key-id"
secret_access_key = "your-secret-access-key"
endpoint = "bj.bcebos.com"
bucket_name = "your-bucket-name"

config = BceClientConfiguration(
    credentials=BceCredentials(access_key_id, secret_access_key),
    endpoint=endpoint
)
bos_client = BosClient(config)

response = bos_client.get_notification(bucket_name)
            

参数说明

参数	类型	必填	说明
`bucket_name`	`str` / `bytes`	是	需要获取通知规则的 bucket 名称。
`config`	`BceClientConfiguration`	否	可选请求配置。不传时使用客户端初始化配置。

返回说明：

调用成功后返回 BceResponse 对象。可通过 response.status_code 查看 HTTP 状态码，通过 response.get_body_map() 获取响应体内容。响应体中包含 notifications 列表，每个元素为一条通知规则配置。

如果指定 bucket 上不存在通知规则，服务端返回 404 NoNotificationConfiguration。

delete_notification

本接口用于删除指定 bucket 上的通知规则。

注意：

该接口为一次性全部删除当前 bucket 下全部规则。

                Python
                
            

                from baidubce.auth.bce_credentials import BceCredentials
from baidubce.bce_client_configuration import BceClientConfiguration
from baidubce.services.bos.bos_client import BosClient

access_key_id = "your-access-key-id"
secret_access_key = "your-secret-access-key"
endpoint = "bj.bcebos.com"
bucket_name = "your-bucket-name"

config = BceClientConfiguration(
    credentials=BceCredentials(access_key_id, secret_access_key),
    endpoint=endpoint
)
bos_client = BosClient(config)

response = bos_client.delete_notification(bucket_name)
            

参数说明

参数	类型	必填	说明
`bucket_name`	`str` / `bytes`	是	需要删除通知规则的 bucket 名称。
`config`	`BceClientConfiguration`	否	可选请求配置。不传时使用客户端初始化配置。

返回说明：

调用成功后返回 BceResponse 对象。可通过 response.status_code 查看 HTTP 状态码，通过 response.metadata 查看响应头信息。实际删除成功时，服务端返回 204 No Content，响应体为空。

评价此篇文章

有帮助没帮助

用户额度管理

原图保护

百度智能云

BOS 对象存储

BOS 对象存储

事件通知

put_notification

get_notification

delete_notification