Help Center/ Object Storage Service/ SDK Reference/ Python/ Bucket-Related APIs (SDK for Python)/ DIS Notification Policies (SDK for Python)/ Configuring a DIS Notification Policy (SDK for Python)
Updated on 2026-07-31 GMT+08:00
View PDF
Share

Configuring a DIS Notification Policy (SDK for Python)

Function

This API is used to configure a DIS notification policy for a specified bucket. The API is idempotent. If there is already an identical policy for the bucket, a success message is returned with status code 200. Otherwise, status code 201 is returned.

DIS notification policies are not available for fusion buckets.

Restrictions

  • To call this API, you must have the Tenant Administrator permission. To configure the Tenant Administrator permission, you need to use role/policy-based authorization (IAM v3 APIs in the old IAM version). For details, see Using IAM for Authorization.
  • A maximum of 10 DIS notification rules can be configured for a bucket.
  • For services that require responses within seconds, the notifications cannot guarantee the required latency.
  • New DIS notification rules are applied within 5 minutes.
  • DIS notification rules configured for the same bucket cannot overlap with each other. If the notification rule you are creating overlaps with an existing one, the rule creation will fail.

    A rule with both an object name prefix and a suffix left blank applies to all objects in a bucket. If such a rule has been configured for a type of events, no more rules can be configured for such events.

    For example, suppose there is already a rule A for PUT events, with the prefix set to abcd and the suffix set to .txt. If you need to create another rule B for the same PUT events, configure its prefix and suffix by referring to Table 1 to make sure that your creation is successful.

    Table 1 Prefix and suffix settings and creation results of rule B

    Prefix and Suffix of Rule A

    Prefix and Suffix of Rule B

    Rule B Creation Result

    Reason

    Prefix: abcd

    Suffix: .txt

    Prefix: abcd

    Suffix: .txt

    Failed

    Both rules have the same prefix and suffix.

    Prefix: abcd

    Suffix: left blank

    Failed

    Both rules have the same prefix, and the suffix of rule A is included in that of rule B.

    Prefix: ab

    Suffix: xt

    Failed

    The prefix and suffix of rule A are included in those of rule B.

    Prefix: abef

    Suffix: .txt

    Successful

    Both rules have the same suffix, but different prefixes.

    Prefix: abcd

    Suffix: .mp4

    Successful

    Both rules have the same prefix, but different suffixes.
  • The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

ObsClient.setBucketDisPolicy(bucketName, disPolicy, extensionHeaders)

Request Parameters

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

str

Yes

Explanation:

Bucket name

Restrictions:

  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets with the same name in the same region, no error will be reported and the bucket properties comply with those set in the first creation request.

Default value:

None

disPolicy

Table 2

Yes

Explanation:

DIS notification rules. For details, see Table 2.

extensionHeaders

dict

No

Explanation:

Extension headers

Value range:

See User-defined Headers (SDK for Python).

Default value:

None
Table 2 DisPolicy

Parameter

Type

Mandatory (Yes/No)

Description

rules

list of Table 3

Yes

Explanation:

List of DIS notification rules. For details, see Table 3.

Restrictions:

For the same bucket, prefixes of different rules cannot be the same or contain each other. The same agency is recommended.

Value range:

The size of the array is from 1 to 10.

Default value:

N/A
Table 3 DisPolicyRule

Parameter

Type

Mandatory (Yes/No)

Description

id

str

Yes

Explanation:

Rule ID. It is the unique identifier of the DIS policy rule configured for the bucket.

Restrictions:

The rule ID allows letters (a–z, A–Z), digits (0–9), hyphens (-), and underscores (_).

Value range:

The value can be up to 256 characters long.

Default value:

None

stream

str

Yes

Explanation:

DIS stream name

Restrictions:

You need to create a DIS stream first.

Default value:

None

project

str

Yes

Explanation:

ID of the project to which the DIS stream belongs

Value range:

N/A

Default value:

None

events

list

Yes

Explanation:

OBS event list

Value range:

A valid value must contain 0 to 1,023 characters. Any characters are allowed. The following event types are supported:

  • ObjectCreated:* (all upload operations)
  • ObjectCreated:Put (uploading an object)
  • ObjectCreated:Post (uploading an object with a browser)
  • ObjectCreated:Copy (copying an object)
  • ObjectCreated:CompleteMultipartUpload (completing a multipart upload)
  • ObjectRemoved:* (all deletion operations)
  • ObjectRemoved:Delete (deleting an object with a specified version ID)
  • ObjectRemoved:DeleteMarkerCreated (deleting an object without a specified version ID)

Default value:

None

prefix

str

No

Explanation:

Object name prefix. Enter the prefix (which serves as the keyword) to filter object names. The longer the prefix string, the higher the matching accuracy.

Restrictions:

The total length of the prefix and suffix cannot exceed 1,024 characters.

Value range:

The value can be up to 1,024 characters long.

Default value:

None

suffix

str

No

Explanation:

Object name suffix. Enter the suffix (which serves as the keyword) to filter object names. The longer the suffix string, the higher the matching accuracy.

Restrictions:

The total length of the prefix and suffix cannot exceed 1,024 characters.

Value range:

The value can be up to 1,024 characters long.

Default value:

None

agency

str

Yes

Explanation:

IAM agency name

Restrictions:

The delegated party must include OBS and be granted the DIS Administrator or DIS User permission.

Default value:

None

Responses

Type

Description

GetResult

Explanation:

SDK common results
Table 4 GetResult

Parameter

Type

Description

status

int

Explanation:

HTTP status code

Value range:

A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For more information, see Status Code.

Default value:

None

reason

str

Explanation:

Reason description

Default value:

None

errorCode

str

Explanation:

Error code returned by the OBS server. If the value of status is less than 300, this parameter is left blank.

Default value:

None

errorMessage

str

Explanation:

Error message returned by the OBS server. If the value of status is less than 300, this parameter is left blank.

Default value:

None

requestId

str

Explanation:

Request ID returned by the OBS server

Default value:

None

indicator

str

Explanation:

Error indicator returned by the OBS server

Default value:

None

hostId

str

Explanation:

Requested server ID. If the value of status is less than 300, this parameter is left blank.

Default value:

None

resource

str

Explanation:

Error source (a bucket or an object). If the value of status is less than 300, this parameter is left blank.

Default value:

None

header

list

Explanation:

Response header list, composed of tuples. Each tuple consists of two elements, respectively corresponding to the key and value of a response header.

Default value:

None

body

object

Explanation:

Result content returned after the operation is successful. If the value of status is larger than 300, this parameter is left blank. The value varies with the API being called. For details, see the sections "Bucket-Related APIs" and "Object-Related APIs".

Default value:

None

Sample Code

This example configures a DIS notification policy for bucket examplebucket.

 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
51
 
from obs import ObsClient, DisPolicyRule, DisPolicy
import os
import traceback

# Obtain an AK/SK pair using environment variables (recommended) or import it in other ways. Using hard coding may result in leakage.
# Obtain an AK and SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# If you use a temporary AK/SK pair and a security token to access OBS, obtain them from environment variables.
# security_token = os.getenv("SecurityToken")
# Set server to the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
server = "https://obs.ap-southeast-1.myhuaweicloud.com" 

# Create an obsClient instance.
# If you use a temporary AK/SK pair and a security token to access OBS, you must specify security_token when creating an instance.
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucket_name = 'examplebucket'
    rule1 = DisPolicyRule(
        # The ID of a DIS notification rule
        id='rule_id',
        # DIS stream name
        stream='your_stream',
        # The ID of the project to which the DIS stream belongs
        project='your_project_id',
        # OBS event list
        events=['ObjectCreated:*'],
        # IAM agency name. The agency must have the permission to access OBS. The granted permission must be DIS Administrator or DIS User.
        agency='your_agency',
        # Object name prefix. Enter the prefix (which serves as the keyword) to filter object names. The longer the prefix string, the higher the matching accuracy.
        prefix='test/',
        # Object name suffix. Enter the suffix (which serves as the keyword) to filter object names. The longer the suffix string, the higher the matching accuracy.
        suffix='.txt'
    )
    dis_policy = DisPolicy(rules=[rule1])

    # Configure a DIS notification policy for the bucket.
    resp = obsClient.setBucketDisPolicy(bucket_name, dis_policy)

    # If status code 2xx is returned, the API call succeeds. Otherwise, the API call fails.
    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())