Updated on 2026-08-14 GMT+08:00

Configuring a DIS Notification Policy (SDK for Java)

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.

If you have any questions during development, post them on the Issues page of GitHub.

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(SetBucketDisPolicyRequest request)

Request Parameters

Table 2 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

request

Table 3

Yes

Explanation:

Request parameters for configuring a DIS notification policy. For details, see Table 3.

Table 3 SetBucketDisPolicyRequest

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

String

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

disPolicyConfiguration

Table 4

Yes

Explanation:

DIS notification rules. For details, see Table 4.

Table 4 DisPolicyConfiguration

Parameter

Type

Mandatory (Yes/No)

Description

rules

List<Table 5>

Yes

Explanation:

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

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 5 DisPolicyRule

Parameter

Type

Mandatory (Yes/No)

Description

id

String

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

String

Yes

Explanation:

DIS stream name

Restrictions:

You need to create a DIS stream first.

Default value:

None

project

String

Yes

Explanation:

ID of the project to which the DIS stream belongs

Value range:

N/A

Default value:

None

events

List<String>

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

String

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

String

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

String

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

Table 6 Common response headers

Parameter

Type

Description

statusCode

int

Explanation:

HTTP status code.

Value range:

A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response.

For more information, see Status Code.

Default value:

None

responseHeaders

Map<String, Object>

Explanation:

HTTP response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header.

Default value:

None

Sample Code

This example configures a DIS policy for bucket exampleBucket.
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.dis.DisPolicyConfiguration;
import com.obs.services.model.dis.DisPolicyRule;
import com.obs.services.model.dis.SetBucketDisPolicyRequest;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
public class SetBucketDisPolicy {
    public static void main(String[] args) {
        // Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
        // Obtain an AK/SK pair on the management console.
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are not advised to use hard coding, which may result in information leakage.
        // Obtain an AK/SK pair and a security token using environment variables or import them in other ways.
        String securityToken = System.getenv("SECURITY_TOKEN");
        // Enter the endpoint corresponding to the bucket. CN North-Beijing4 is used here as an example. Replace it with the one currently in use.
        // Obtain an endpoint using environment variables or import it in other ways.
        String endPoint = System.getenv("ENDPOINT");
        ObsConfiguration obsConfiguration = new ObsConfiguration();
        obsConfiguration.setEndPoint(endPoint);
        ObsClient obsClient = new ObsClient(ak, sk, securityToken, obsConfiguration);
        try {
            String exampleBucket = "exampleBucket";
            String ruleId = "rule-001";
            // DIS stream name
            String stream = "your_stream";
            // ID of the project to which the DIS stream belongs
            String projectId = "your_project_id";
            // IAM agency name. The agency must have the permission to access OBS. The granted permission must be DIS Administrator or DIS User.
            String agency = "your_agency";
            // Trigger event type
            List<String> events = Arrays.asList("ObjectCreated:*");
            // 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.
            String 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.
            String suffix = ".zip";
            DisPolicyRule rule = new DisPolicyRule(ruleId, stream, projectId, events, agency);
            rule.setPrefix(prefix);
            rule.setSuffix(suffix);
            DisPolicyConfiguration config = new DisPolicyConfiguration(Collections.singletonList(rule));
            SetBucketDisPolicyRequest setRequest = new SetBucketDisPolicyRequest(exampleBucket, config);
            obsClient.setBucketDisPolicy(setRequest);
            System.out.println("SetBucketDisPolicy successfully");
        } catch (ObsException e) {
            System.out.println("SetBucketDisPolicy failed");
            // Request failed. Print the HTTP status code.
            System.out.println("HTTP Code:" + e.getResponseCode());
            // Request failed. Print the server-side error code.
            System.out.println("Error Code:" + e.getErrorCode());
            // Request failed. Print the error details.
            System.out.println("Error Message:" + e.getErrorMessage());
            // Request failed. Print the request ID.
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("SetBucketDisPolicy failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}