Help Center/ Object Storage Service/ SDK Reference/ Android/ Bucket APIs/ Custom Domain Names/ Configuring a Custom Domain Name for a Bucket
Updated on 2026-09-20 GMT+08:00
View PDF
Share

Configuring a Custom Domain Name for a Bucket

Function

This API is used to configure a custom domain name for an OBS bucket.

Restrictions

Method

ObsClient.setBucketCustomDomain(SetBucketCustomDomainRequest request)

Request Parameters

Table 1 SetBucketCustomDomainRequest

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 of 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.

Value range:

None

Default value:

None

domainName

String

Yes

Explanation:

Custom domain name.

Restrictions:

None

Value range:

None

Default value:

None

customDomainCertificateConfig

CustomDomainCertificateConfig

No

Explanation:

Custom domain name certificate configuration.

Restrictions:

Only HTTPS requests are supported.

Value range:

CustomDomainCertificateConfig

Default value:

None
Table 2 CustomDomainCertificateConfig

Parameter

Type

Mandatory (Yes/No)

Description

name

String

Yes

Explanation:

Certificate name

Restrictions:

None

Value range:

The value must contain 3 to 63 characters.

Default value:

None

certificateId

String

No

Explanation:

Certificate ID on the CCM.

Restrictions:

None

Value range:

The value must contain 16 characters.

Default value:

None

certificate

String

Yes

Explanation:

Certificate content, which can contain intermediate and root certificates. If certificateChain contains a certificate chain, only the certificate itself will be extracted from certificate.

Restrictions:

Use escape characters \n or \r\n to replace line breaks.

Value range:

None

Default value:

None

certificateChain

String

No

Explanation:

Certificate chain, which is optional and can be passed through the certificate parameter.

Restrictions:

Use escape characters \n or \r\n to replace line breaks.

Value range:

None

Default value:

None

privateKey

String

Yes

Explanation:

Private key of a certificate.

Restrictions:

  • Private keys protected by passwords cannot be uploaded.
  • Use escape characters \n or \r\n to replace line breaks.

Value range:

None

Default value:

None

Responses

Type

Description

HeaderResponse

Explanation:

SDK common results
Table 3 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 custom domain name for a bucket.

import android.util.Log;
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketCustomDomainInfo;
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";

        BucketCustomDomainInfo customDomainInfo = new BucketCustomDomainInfo();
        customDomainInfo.setCustomDomain("custom.example.com");

        HeaderResponse response = obsClient.setBucketCustomDomain(bucketName, customDomainInfo);
        Log.i("ObsDemo", "Configured the custom domain name for the bucket successfully. statusCode: " + response.getStatusCode());
    } catch (ObsException e) {
        Log.e("ObsDemo", "Failed to configure the custom domain name for 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