更新时间:2026-07-13 GMT+08:00
分享

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

功能介绍

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

调用获取桶的事件通知配置接口,可获取指定桶的事件通知配置。

接口约束

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

方法定义

ObsClient.getBucketNotification(bucketName, extensionHeaders)

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释

桶名。

约束限制:

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

默认取值:

extensionHeaders

dict

可选

参数解释:

接口的拓展头域。

取值范围:

参考自定义头域

默认取值:

返回结果说明

类型

说明

GetResult

参数解释:

SDK公共结果对象。

表1 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时为空。该值根据调用接口的不同而不同,参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值:

GetResult.body类型

说明

Notification

参数解释:

桶事件通知配置,详情参见Notification

代码样例

try:
    resp = obsClient.getBucketNotification('bucketname') 
      
    if resp.status < 300: 
        print('requestId:', resp.requestId) 
        for topicConfiguration in resp.body.topicConfigurations:
            print('id:', topicConfiguration.id)
            print('topic:', topicConfiguration.topic)
            print('events:', topicConfiguration.events)
            index = 1
            for rule in topicConfiguration.filterRules:
                print('rule [' + str(index) + ']')
                print('name:', rule.name)
                print('value:', rule.value)

        for functionGraphConfiguration in resp.body.functionGraphConfigurations:
            print('id:', functionGraphConfiguration.id)
            print('functionGraph:', functionGraphConfiguration.functionGraph)
            print('events:', functionGraphConfiguration.events)
            index = 1
            for rule in functionGraphConfiguration.filterRules:
                print('rule [' + str(index) + ']')
                print('name:', rule.name)
                print('value:', rule.value)

    else: 
        print('errorCode:', resp.errorCode) 
        print('errorMessage:', resp.errorMessage)
except:
    import traceback
    print(traceback.format_exc())

相关链接

相关文档