获取DIS通知策略(Python SDK)
功能介绍
本接口用于查询指定桶的DIS通知策略信息。如果策略存在,则返回成功,status code返回值为200。
融合桶不支持设置DIS通知策略。
接口约束
- 您必须是桶拥有者或者拥有Tenant Administrator权限,才能调用本接口。配置Tenant Administrator权限,需要使用角色与策略授权(旧版IAM,即IAM v3接口),授权操作请参考使用IAM授权。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
方法定义
ObsClient.getBucketDisPolicy(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类型 | 说明 |
|---|---|
| 参数解释: DIS通知策略,详见表2 DisPolicy。 |
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| id | str | 参数解释: 规则ID。当前桶上配置的DIS策略规则的唯一标识。 |
| stream | str | 参数解释: DIS服务通道名称。 |
| project | str | 参数解释: DIS服务通道所属的项目ID。 |
| events | list | 参数解释: OBS事件列表。 取值范围: 有效值:长度[0, 1023],值允许为任意字符,支持如下事件类型:
|
| prefix | str | 参数解释: 对象名前缀,用于指定的对象名关键字,根据定义的前缀,输入需要过滤的对象的关键字信息,字符越长匹配精度越高。 |
| suffix | str | 参数解释: 对象名后缀。用于指定的对象名关键字,根据定义的后缀,输入需要过滤的对象的关键字信息,字符越长匹配精度越高。 |
| agency | str | 参数解释: IAM委托名。 |
代码样例
本示例用于获取examplebucket桶的DIS通知策略。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | from obs import ObsClient import os import traceback # 推荐通过环境变量获取AK/SK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险 # 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # 如需使用临时AK/SK和SecurityToken访问OBS,则同样推荐通过环境变量获取 # security_token = os.getenv("SecurityToken") # server填写Bucket对应的Endpoint,这里以华北-北京四为例,其他地区请按实际情况填写 server = "https://obs.cn-north-4.myhuaweicloud.com" # 创建obsClient实例 # 如果使用临时AK/SK和SecurityToken访问OBS,需要在创建实例时通过security_token参数指定securityToken值 obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) try: bucketName = "examplebucket" # 获取桶的DIS通知策略 resp = obsClient.getBucketDisPolicy(bucketName) # 返回码为2xx时,接口调用成功,否则接口调用失败 if resp.status < 300: print('Get Bucket DisPolicy Succeeded') print('rules:', resp.body.rules) else: print('Get Bucket DisPolicy Failed') print('requestId:', resp.requestId) print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) except Exception: print('Get Bucket DisPolicy Failed') print(traceback.format_exc()) |