Overview

This document provides an overview of APIs and SDK code samples related to custom domain name.

Setting Custom Domain Name

Feature description

This API (PUT Bucket domain) is used to configure a custom domain name for a bucket.

Method prototype

PutBucketDomainResult putBucketDomain(PutBucketDomainRequest request) throws CosXmlClientException, CosXmlServiceException;

void putBucketDomainAsync(PutBucketDomainRequest request, CosXmlResultListener cosXmlResultListener);

Sample request

String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
PutBucketDomainRequest putBucketDomainRequest = new PutBucketDomainRequest(bucket);
DomainConfiguration.DomainRule domainRule = new DomainConfiguration.DomainRule(
        DomainConfiguration.STATUS_ENABLED,
        "www.example.com",
        DomainConfiguration.TYPE_REST
);
domainRule.forcedReplacement = DomainConfiguration.REPLACE_CNAME;
putBucketDomainRequest.addDomainRule(domainRule);

// Use the sync method
try {
    PutBucketDomainResult putBucketDomainResult = cosXmlService.putBucketDomain(putBucketDomainRequest);
} catch (CosXmlClientException e) {
    e.printStackTrace();
} catch (CosXmlServiceException e) {
    e.printStackTrace();
}

// Use the async callback to request
cosXmlService.putBucketDomainAsync(putBucketDomainRequest, new CosXmlResultListener() {
    @Override
    public void onSuccess(CosXmlRequest request, CosXmlResult result) {
        PutBucketDomainResult putBucketDomainResult = (PutBucketDomainResult) result;
    }

    @Override
    public void onFail(CosXmlRequest cosXmlRequest, CosXmlClientException clientException, CosXmlServiceException serviceException)  {
    }
});

Parameter description

Response description

Error codes

Some frequent special errors that may occur with this request are listed below:

Querying Custom Domain Name

Feature description

This API (GET Bucket domain) is used to query the custom domain name information of a bucket.

Method prototype

GetBucketDomainResult getBucketDomain(GetBucketDomainRequest request) throws CosXmlClientException, CosXmlServiceException;

void getBucketDomainAsync(GetBucketDomainRequest request, CosXmlResultListener cosXmlResultListener);

Sample request

String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
GetBucketDomainRequest getBucketDomainRequest = new GetBucketDomainRequest(bucket);
// Set signature verification host. All headers are to be verified by default
Set<String> headerKeys = new HashSet<>();
headerKeys.add("Host");
// Use the sync method
try {
    GetBucketDomainResult getBucketTaggingResult = cosXmlService.getBucketDomain(getBucketDomainRequest);
} catch (CosXmlClientException e) {
    e.printStackTrace();
} catch (CosXmlServiceException e) {
    e.printStackTrace();
}

// Use the async callback to request
cosXmlService.getBucketDomainAsync(getBucketDomainRequest, new CosXmlResultListener() {
    @Override
    public void onSuccess(CosXmlRequest request, CosXmlResult result) {
        GetBucketDomainResult getBucketTaggingResult = (GetBucketDomainResult)result;
    }

    @Override
    public void onFail(CosXmlRequest cosXmlRequest, CosXmlClientException clientException, CosXmlServiceException serviceException)  {
    }
});

Parameter description

Response description

Response parameters