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

设置DIS通知策略(Python SDK)

功能介绍

本接口用于为指定桶配置DIS通知策略。接口是幂等的，如果桶上已存在相同策略内容，则返回成功，status code返回值为200；否则status code返回值为201。

融合桶不支持设置DIS通知策略。

接口约束

  • 您必须是拥有Tenant Administrator权限，才能调用本接口。配置Tenant Administrator权限，需要使用角色与策略授权（旧版IAM，即IAM v3接口），授权操作请参考使用IAM授权。
  • 一个桶中最多同时配置10条DIS通知规则。
  • 对于时延敏感（秒级）的业务，消息通知无法保证时延。
  • 新创建的DIS通知将在5分钟之内生效。
  • 一个桶的多条DIS通知规则不允许重复，即任意对象在发生任意事件时都不能同时匹配两条以上的DIS通知规则，重复规则会创建失败。

    针对同一事件，如果配置了一条前后缀都为空的规则，则不允许再配置第二条规则。前后缀都为空表示对所有对象生效。

    例如：针对Put事件，已存在一条规则A，定义的前缀是“abcd”，后缀是“.txt”。如果要创建另外一条针对Put事件的规则B，则规则B配置不同前后缀的结果如表1所示。

    表1 规则B前后缀配置场景及结果

    规则A前后缀配置

    规则B前后缀配置

    规则B创建结果

    原因

    前缀：abcd

    后缀：.txt

    前缀：abcd

    后缀：.txt

    失败

    前后缀相同

    前缀：abcd

    后缀：空

    失败

    前缀相同，后缀B包含A

    前缀：ab

    后缀：xt

    失败

    前缀B包含A，后缀B包含A

    前缀：abef

    后缀：.txt

    成功

    前缀不同，后缀相同

    前缀：abcd

    后缀：.mp4

    成功

    前缀相同，后缀不同
  • OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。

方法定义

ObsClient.setBucketDisPolicy(bucketName, disPolicy, extensionHeaders)

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

disPolicy

表2 DisPolicy

必选

参数解释：

DIS通知规则，详见表2 DisPolicy。

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无
表2 DisPolicy

参数名称

参数类型

是否必选

描述

rules

list of 表3 DisPolicyRule

必选

参数解释：

DIS通知规则列表，详见表3 DisPolicyRule。

约束限制：

同一个桶下的不同策略前缀不能重复和起始包含，委托建议使用同一个。

取值范围：

数组大小的取值范围为[1, 10]。

默认取值：

不涉及
表3 DisPolicyRule

参数名称

参数类型

是否必选

描述

id

str

必选

参数解释：

规则ID。当前桶上配置的DIS策略规则的唯一标识。

约束限制：

必须由以下字符组成"a-z"、"A-Z"、"0-9"、"-"、"_"

取值范围：

长度最长为256的字符串。

默认取值：

无

stream

str

必选

参数解释：

DIS服务通道名称。

约束限制：

需要先在DIS服务创建此通道。

默认取值：

无

project

str

必选

参数解释：

DIS服务通道所属的项目ID。

取值范围：

不涉及

默认取值：

无

events

list

必选

参数解释：

OBS事件列表。

取值范围：

有效值：长度[0, 1023]，值允许为任意字符，支持如下事件类型：

  • ObjectCreated:* （所有上传操作）
  • ObjectCreated:Put （上传对象）
  • ObjectCreated:Post （使用浏览器上传对象）
  • ObjectCreated:Copy （拷贝对象）
  • ObjectCreated:CompleteMultipartUpload （合并段）
  • ObjectRemoved:* （所有删除操作）
  • ObjectRemoved:Delete （指定对象版本号删除对象）
  • ObjectRemoved:DeleteMarkerCreated （不指定对象版本号删除对象）

默认取值：

无

prefix

str

可选

参数解释：

对象名前缀，用于指定的对象名关键字，根据定义的前缀，输入需要过滤的对象的关键字信息，字符越长匹配精度越高。

约束限制：

prefix和suffix加起来长度最大为1024个字符。

取值范围：

长度最长为1024的字符串。

默认取值：

无

suffix

str

可选

参数解释：

对象名后缀。用于指定的对象名关键字，根据定义的后缀，输入需要过滤的对象的关键字信息，字符越长匹配精度越高。

约束限制：

prefix和suffix加起来长度最大为1024个字符。

取值范围：

长度最长为1024的字符串。

默认取值：

无

agency

str

必选

参数解释：

IAM委托名。

约束限制：

被委托方必须包含OBS服务，赋予的权限必须是DIS服务的DIS Administrator或DIS User。

默认取值：

无

返回结果说明

类型

说明

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

默认取值：

无

代码样例

本示例用于设置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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
from obs import ObsClient, DisPolicyRule, DisPolicy
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:
    bucket_name = 'examplebucket'
    rule1 = DisPolicyRule(
        # 设置DIS通知策略的规则ID
        id='rule_id',
        # DIS服务通道名称
        stream='your_stream',
        # DIS服务通道所属的项目ID
        project='your_project_id',
        # OBS事件列表
        events=['ObjectCreated:*'],
        # IAM委托名，被委托方必须包含对OBS的访问权限，赋予的权限必须是DIS服务的DIS Administrator或DIS User
        agency='your_agency',
        # 对象名前缀。用于指定的对象名关键字，根据定义的前缀，输入需要过滤的对象的关键字信息，字符越长匹配精度越高
        prefix='test/',
        # 对象名后缀。用于指定的对象名关键字，根据定义的后缀，输入需要过滤的对象的关键字信息，字符越长匹配精度越高
        suffix='.txt'
    )
    dis_policy = DisPolicy(rules=[rule1])

    # 设置桶的DIS通知策略
    resp = obsClient.setBucketDisPolicy(bucket_name, dis_policy)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Set Bucket DisPolicy Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Set Bucket DisPolicy Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except Exception:
    print('Set Bucket DisPolicy Failed')
    print(traceback.format_exc())

相关文档