Help Center/ Object Storage Service/ SDK Reference/ Android/ Bucket APIs/ Custom Domain Names/ Obtaining the Custom Domain Names of a Bucket
Updated on 2026-09-20 GMT+08:00

Obtaining the Custom Domain Names of a Bucket

Function

This API is used to obtain the custom domain name list of an OBS bucket.

Restrictions

Method

ObsClient.getBucketCustomDomain(GetBucketCustomDomainRequest request)

Request Parameters

Table 1 GetBucketCustomDomainRequest

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 attributes comply with those set in the first creation request.

Value range:

None

Default value:

None

Responses

Type

Description

BucketCustomDomainInfo

Explanation:

Information about the custom domain names of a bucket.

Table 2 BucketCustomDomainInfo

Parameter

Type

Description

domains

List<Domains>

Explanation:

Custom domain name list.

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

Table 3 Domains

Parameter

Type

Description

domainName

String

Explanation:

Custom domain name.

createTime

java.util.Date

Explanation:

Time when a custom domain name was created.

certificateId

String

Explanation:

Certificate ID on the CCM.

Sample Code

This example obtains the custom domain names of a bucket.

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

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";

        BucketCustomDomainInfo result = obsClient.getBucketCustomDomain(bucketName);
        Log.i("ObsDemo", "Obtained the custom domain names of the bucket successfully. Custom domain names: " + result.getCustomDomains());
    } catch (ObsException e) {
        Log.e("ObsDemo", "Failed to obtain the custom domain names 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();