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, see Api Documentation.

Setting a Custom Endpoint

API description

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

Sample code

try
{
  String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID

  DomainConfiguration domain = new DomainConfiguration();
  domain.rule = new DomainConfiguration.DomainRule();
  domain.rule.Name = "www.qq.com";
  domain.rule.Status = "ENABLED";
  domain.rule.Type = "WEBSITE";

  PutBucketDomainRequest request = new PutBucketDomainRequest(bucket, domain);   
  // Execute the request
  PutBucketDomainResult result = cosXml.putBucketDomain(request);

  // Request successful
  Console.WriteLine(result.GetResultInfo());
}
catch (COSXML.CosException.CosClientException clientEx)
{
  // Request failed
  Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
  // Request failed
  Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}

Note：

For more samples, please visit 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

try
{
  String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
  GetBucketDomainRequest request = new GetBucketDomainRequest(bucket);   
  // Execute the request
  GetBucketDomainResult result = cosXml.getBucketDomain(request);

  // Request successful
  Console.WriteLine(result.domainConfiguration);
}
catch (COSXML.CosException.CosClientException clientEx)
{
  // Request failed
  Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
  // Request failed
  Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}

Note：

For more samples, please visit GitHub.

Response parameters