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

Obtaining a DIS Notification Policy (SDK for Java)

Function

This API is used to obtain the DIS notification policy of a bucket. If the policy exists, a success message is returned with status code 200.

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

Restrictions

  • To call this API, you must be the bucket owner or 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.
  • The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

obsClient.getBucketDisPolicy(GetBucketDisPolicyRequest request)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

request

Table 2

Yes

Explanation:

Request parameters for obtaining a DIS notification policy. For details, see Table 2.

Table 2 GetBucketDisPolicyRequest

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

Responses

Table 3 GetBucketTrashResult

Parameter

Type

Description

statusCode

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

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

disPolicyConfiguration

Table 4

Explanation:

DIS notification rules. For details, see Table 4.

Table 4 DisPolicyConfiguration

Parameter

Type

Description

rules

List<Table 5>

Explanation:

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

Table 5 DisPolicyRule

Parameter

Type

Description

id

String

Explanation:

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

stream

String

Explanation:

DIS stream name

project

String

Explanation:

ID of the project to which the DIS stream belongs

events

List<String>

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)

prefix

String

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.

suffix

String

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.

agency

String

Explanation:

IAM agency name

Sample Code

This example obtains the DIS policy of bucket exampleBucket.
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.dis.DisPolicyRule;
import com.obs.services.model.dis.GetBucketDisPolicyRequest;
import com.obs.services.model.dis.GetBucketDisPolicyResult;
public class GetBucketDisPolicy {
    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";
            GetBucketDisPolicyResult result =
                obsClient.getBucketDisPolicy(new GetBucketDisPolicyRequest(exampleBucket));
            System.out.println("GetBucketDisPolicy successfully");
            for (DisPolicyRule rule : result.getDisPolicyConfiguration().getRules()) {
                System.out.println("Rule Id:"+ rule.getId());
                System.out.println("Project Id:"+ rule.getProject());
                System.out.println("Agency:"+ rule.getAgency());
                System.out.println("Events:"+ rule.getEvents());
                System.out.println("Prefix:"+ rule.getPrefix());
                System.out.println("Suffix:"+ rule.getSuffix());
            }
        } catch (ObsException e) {
            System.out.println("GetBucketDisPolicy 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("GetBucketDisPolicy failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}