Configuring a Custom Domain Name for a Bucket (SDK for Java)
Function
This API sets a custom domain name for an OBS bucket.
Restrictions
- To use this API, you must be the bucket owner or have the required permission (obs:bucket:SetBucketCustomDomain in IAM or SetBucketCustomDomain in a bucket policy).
Method
ObsClient.setBucketCustomDomain(SetBucketCustomDomainRequest request)
Request Parameters
|
Parameter |
Type |
Mandatory (Yes/No) |
Description |
|---|---|---|---|
|
bucketName |
String |
Yes |
Explanation: Bucket name. Restrictions:
Value range: None Default value: None |
|
domainName |
String |
Yes |
Explanation: Custom domain name. Restrictions: None Value range: None Default value: None |
|
customDomainCertificateConfig |
No |
Explanation: Custom domain name certificate configuration. Restrictions: Only HTTPS requests are supported. Value range: Default value: None |
|
Parameter |
Type |
Mandatory (Yes/No) |
Description |
|---|---|---|---|
|
name |
String |
Yes |
Explanation: Certificate name Restrictions: None Value range: The value can 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. Use escape characters \n or \r\n to replace line breaks. Restrictions: None Value range: None Default value: None |
|
certificateChain |
String |
No |
Explanation: Certificate chain, which is optional and can be passed through the certificate parameter. Use escape characters \n or \r\n to replace line breaks. Restrictions: None Value range: None Default value: None |
|
privateKey |
String |
Yes |
Explanation: Private key of a certificate. An encrypted private key cannot be uploaded. Use escape characters \n or \r\n to replace line breaks. Restrictions: None Value range: None Default value: None |
Responses
|
Type |
Description |
|---|---|
|
Explanation: SDK common results |
|
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. 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 |
Code Examples
import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.CustomDomainCertificateConfig; import com.obs.services.model.HeaderResponse; import com.obs.services.model.SetBucketCustomDomainRequest; import java.util.Map; public class SetBucketCustomDomain { public static void main(String[] args) { // Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage. // Obtain an AK/SK pair on the management console. String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage. // Obtain an AK/SK pair and a security token using environment variables or import them in other ways. String securityToken = System.getenv("SECURITY_TOKEN"); // Enter the endpoint corresponding to the bucket. CN North-Beijing4 is used here as an example. Replace it with the one currently in use. // Obtain an endpoint using environment variables or import it in other ways. // String endPoint = System.getenv("ENDPOINT_S"); String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // Create an ObsClient instance. ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { // Example bucket name String exampleBucket = "example-bucket"; // Example custom domain name String exampleDomainName = "example.domain.name.com"; // Example name of the certificate configured for the custom domain name String exampleDomainCertificateName = "exampleCertName"; // Example ID of the certificate configured for the custom domain name String exampleDomainCertificateId = "1234512345123450"; // Example custom domain name certificate String exampleDomainCertificate = "exampleDomainCertificate"; // Example certificate chain of the custom domain name String exampleDomainCertificateChain = "exampleDomainCertificateChain"; // Example private key of the custom domain name certificate String exampleDomainCertificatePrivateKey = "exampleDomainCertificatePrivateKey"; CustomDomainCertificateConfig customDomainCertificateConfig = new CustomDomainCertificateConfig(); customDomainCertificateConfig.setName(exampleDomainCertificateName); customDomainCertificateConfig.setCertificateId(exampleDomainCertificateId); customDomainCertificateConfig.setCertificate(exampleDomainCertificate); customDomainCertificateConfig.setCertificateChain(exampleDomainCertificateChain); customDomainCertificateConfig.setPrivateKey(exampleDomainCertificatePrivateKey); SetBucketCustomDomainRequest setBucketCustomDomainRequest = new SetBucketCustomDomainRequest(exampleBucket, exampleDomainName, customDomainCertificateConfig); // Configure the custom domain name for the bucket. HeaderResponse response = obsClient.setBucketCustomDomain(setBucketCustomDomainRequest); System.out.println("StatusCode:" + response.getStatusCode()); System.out.println("RequestId:" + response.getRequestId()); System.out.println("SetBucketCustomDomain successfully"); } catch (ObsException e) { System.out.println("SetBucketCustomDomain failed"); // Request failed. Print the HTTP status code. System.out.println("HTTP Code:" + e.getResponseCode()); // Request failed. Print the server-side error code. System.out.println("Error Code:" + e.getErrorCode()); // Request failed. Print the error details. System.out.println("Error Message:" + e.getErrorMessage()); // Request failed. Print the request ID. System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); // Check all Map entries and print all headers associated with the error. Map<String, String> headers = e.getResponseHeaders(); if(headers != null){ for (Map.Entry<String, String> header : headers.entrySet()) { System.out.println(header.getKey()+":"+header.getValue()); } } e.printStackTrace(); } catch (Exception e) { System.out.println("SetBucketCustomDomain failed"); // Print other error information. e.printStackTrace(); } } }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot