Updated on 2026-09-20 GMT+08:00

Deleting the Custom Domain Name of a Bucket

Function

This API is used to delete the custom domain names of an OBS bucket.

Restrictions

To delete the custom domain name of a bucket, you must be the bucket owner or have the required permission (obs:bucket:DeleteBucketCustomDomainConfiguration granted using IAM or DeleteBucketCustomDomainConfiguration granted using a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

ObsClient.deleteBucketCustomDomain(DeleteBucketCustomDomainRequest request)

Request Parameters

**Table 1** DeleteBucketCustomDomainRequest
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 attributes comply with those set in the first creation request. Value range: None Default value: None
domainName	String	Yes	Explanation: Custom domain name. Restrictions: None Value range: None Default value: None

Responses

**Table 2** 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 deletes the custom domain name of a bucket.

import android.util.Log;
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.HeaderResponse;

new Thread(() -> {
    // Security warning: Hard-coded AK and SK are risky. You are advised to obtain the AK and SK from the security credential management system.
    String ak = System.getenv("ACCESS_KEY_ID");
    String sk = System.getenv("SECRET_ACCESS_KEY");
    String endPoint = "https://your-endpoint";

    ObsClient obsClient = null;
    try {
        obsClient = new ObsClient(ak, sk, endPoint);

        String bucketName = "examplebucket";
        String customDomain = "custom.example.com";

        HeaderResponse response = obsClient.deleteBucketCustomDomain(bucketName, customDomain);
        Log.i("ObsDemo", "Deleted the custom domain name of the bucket successfully. statusCode: " + response.getStatusCode());
    } catch (ObsException e) {
        Log.e("ObsDemo", "Failed to delete the custom domain name of the bucket. HTTP status code: " + e.getResponseCode()
                + ". Error code: " + e.getErrorCode()
                + ". Error message: " + e.getErrorMessage());
    } finally {
        if (obsClient != null) {
            try {
                obsClient.close();
            } catch (Exception e) {
                Log.e("ObsDemo", "Failed to close ObsClient.", e);
            }
        }
    }
}).start();

Parent topic: Custom Domain Names