获取桶的事件通知配置(Python SDK)
功能介绍
OBS事件通知功能帮助您对桶的重要的操作进行实时监控,重要操作触发时可及时通知到您,确保您安全、及时知道发生在桶上的关键事件。
调用获取桶的事件通知配置接口,可获取指定桶的事件通知配置。
接口约束
- 您必须是桶拥有者或拥有获取桶的事件通知配置的权限,才能获取桶的事件通知配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketNotification权限,如果使用桶策略则需授予GetBucketNotification权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
方法定义
ObsClient.getBucketNotification(bucketName, extensionHeaders)
请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| bucketName | str | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
| extensionHeaders | dict | 可选 | 参数解释: 接口的拓展头域。 取值范围: 参考自定义头域。 默认取值: 无 |
返回结果说明
| 类型 | 说明 |
|---|---|
| 参数解释: SDK公共结果对象。 |
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| 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。 |
代码样例
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()) 相关链接
- 获取桶的事件通知配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
- 事件通知相关常见问题请参见事件通知相关常见问题。