Overview

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

SDK API Reference

For the parameters and method descriptions of all the APIs in the SDK, please see SDK API Reference.

Setting a Custom Endpoint

API description

This API is used to configure a custom endpoint for a bucket.

Sample code

Objective-C

QCloudPutBucketDomainRequest *req = [QCloudPutBucketDomainRequest new];

// Bucket name in the format: `BucketName-APPID`
req.bucket = @"examplebucket-1250000000";

QCloudDomainConfiguration *config = [QCloudDomainConfiguration new];
QCloudDomainRule *rule = [QCloudDomainRule new];

// Status of the endpoint. Valid values: QCloudDomainStatueEnabled and QCloudDomainStatueDisabled
rule.status = QCloudDomainStatueEnabled;
// Endpoint name
rule.name = @"www.baidu.com";

// Replace the existing configuration. If CNAME/TXT is specified as a valid value, the new configuration won’t be delivered until verification of endpoint ownership is complete
rule.replace = QCloudCOSDomainReplaceTypeTxt;
rule.type = QCloudCOSDomainTypeRest;

// An array of rules
config.rule = @[rule];

// Endpoint configuration rule
req.domain  = config;

[request setFinishBlock:^(id outputObject, NSError* error) {
    // `outputObject` contains all the HTTP response headers
    NSDictionary* info = (NSDictionary *) outputObject;

}];
[[QCloudCOSXMLService defaultCOSXML]PutBucketDomain:req];

Note：

For the complete sample, go to GitHub.

Swift

let req = QCloudPutBucketDomainRequest.init();

// Bucket name in the format: `BucketName-APPID`
req.bucket = "examplebucket-1250000000";

let config = QCloudDomainConfiguration.init();
let rule = QCloudDomainRule.init();
// Indicate whether the configuration is enabled. Valid values: .enabled, .disabled
rule.status = .enabled;
rule.name = "www.baidu.com";

// Replace the existing configuration. If CNAME/TXT is specified as a valid value, the new configuration won’t be delivered until verification of endpoint ownership is complete
rule.replace = .txt;
rule.type = .rest;

// An array of rules
config.rules = [rule];

// Endpoint configuration rule
req.domain = config;
req.finishBlock = {(result,error) in
    if let result = result {
        // “result” contains response headers
    } else {
        print(error!);
    }
}
QCloudCOSXMLService.defaultCOSXML().putBucketDomain(req);

Note：

For the complete sample, go to GitHub.

Error codes

The following describes some common errors that may occur when making requests using this API.

Querying a Custom Endpoint

API description

This API is used to query the custom endpoint of a bucket.

Sample code

Objective-C

QCloudGetBucketDomainRequest *getReq =  [QCloudGetBucketDomainRequest new];

// Bucket name in the format: `BucketName-APPID`
getReq.bucket = @"examplebucket-1250000000";

[getReq setFinishBlock:^(QCloudDomainConfiguration * _Nonnull result,
                         NSError * _Nonnull error) {
    // An array of rules
    NSArray *rules = result.rules;
}];
[[QCloudCOSXMLService defaultCOSXML]GetBucketDomain:getReq];

Note：

For the complete sample, go to GitHub.

Swift

let req = QCloudGetBucketDomainRequest.init();

// Bucket name in the format: `BucketName-APPID`
req.bucket = "examplebucket-1250000000";

req.finishBlock = {(result,error) in
    if let result = result {
        // “result” contains information on the endpoint
    } else {
        print(error!);
    }
}
QCloudCOSXMLService.defaultCOSXML().getBucketDomain(req);

Note：

For the complete sample, go to GitHub.

Response parameters