Obtaining the Custom Domain Names of a Bucket (SDK for Java)
Function
This API obtains the custom domain names of a bucket.
Restrictions
- To use this API, you must be the bucket owner or have the required permission (obs:bucket:GetBucketCustomDomain in IAM or GetBucketCustomDomain in a bucket policy).
Method
ObsClient.getBucketCustomDomain(GetBucketCustomDomainRequest request)
Request Parameters
|
Parameter |
Type |
Mandatory (Yes/No) |
Description |
|---|---|---|---|
|
bucketName |
String |
Yes |
Explanation: Bucket name. Restrictions:
Value range: None Default value: None |
Responses
|
Type |
Description |
|---|---|
|
Explanation: Information about the custom domain names of a bucket. |
|
Parameter |
Type |
Description |
|---|---|---|
|
domains |
List<Domains> |
Explanation: Custom domain name list. |
|
statusCode |
int |
Explanation: HTTP status code. Value range: A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). 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.BucketCustomDomainInfo; import com.obs.services.model.GetBucketCustomDomainRequest; import java.util.Map; public class GetBucketCustomDomain { 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"); String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; // Create an ObsClient instance. try (ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint)) { // Example bucket name String exampleBucket = "example-bucket"; // Obtain the custom domain name of the bucket. GetBucketCustomDomainRequest getBucketCustomDomainRequest = new GetBucketCustomDomainRequest(exampleBucket); BucketCustomDomainInfo bucketCustomDomainInfo = obsClient.getBucketCustomDomain(getBucketCustomDomainRequest); System.out.println("StatusCode:" + bucketCustomDomainInfo.getStatusCode()); System.out.println("RequestId:" + bucketCustomDomainInfo.getRequestId()); for(BucketCustomDomainInfo.Domains domain : bucketCustomDomainInfo.getDomains()) { System.out.println("DomainName:" + domain.getDomainName()); System.out.println("CertificateId:" + domain.getCertificateId()); System.out.println("CreateTime:" + domain.getCreateTime()); System.out.println(); } System.out.println("GetBucketCustomDomain successfully"); } catch (ObsException e) { System.out.println("GetBucketCustomDomain 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("GetBucketCustomDomain 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