Obtaining the Custom Domain Name of a Bucket (SDK for Python)

Function

This API obtains the custom domain name of a bucket.

Restrictions

To obtain the custom domain name of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketCustomDomainConfiguration in IAM or GetBucketCustomDomainConfiguration in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

ObsClient.getBucketCustomDomain(bucketName, extensionHeaders)

Request Parameters

Parameter	Type	Mandatory (Yes/No)	Description
bucketName	str	Yes	Explanation: Bucket name. Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request. Value range: None Default value: None
extensionHeaders	dict	No	Explanation: Extension headers. Restrictions: None Value range: See User-defined Headers. Default value: None

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

str

Yes

Explanation:

Bucket name.

Restrictions:

A bucket name must be unique across all accounts and regions.
A bucket name:
- Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
- Cannot be an IP address.
- Cannot start or end with a hyphen (-) or period (.).
- Cannot contain two consecutive periods (..), for example, my..bucket.
- Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request.

Value range:

None

Default value:

None

extensionHeaders

dict

Explanation:

Extension headers.

Restrictions:

None

Value range:

See User-defined Headers.

Default value:

None

Responses

**Table 1** Responses
Type	Description
GetResult	Explanation: SDK common result objects

**Table 2** GetResult
Parameter	Type	Description
status	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). For more information, see Status Code. Default value: None
reason	str	Explanation: Reason description. Default value: None
errorCode	str	Explanation: Error code returned by the OBS server. If the value of status is less than 300, this parameter is left blank. Default value: None
errorMessage	str	Explanation: Error message returned by the OBS server. If the value of status is less than 300, this parameter is left blank. Default value: None
requestId	str	Explanation: Request ID returned by the OBS server Default value: None
indicator	str	Explanation: Error indicator returned by the OBS server. Default value: None
hostId	str	Explanation: Requested server ID. If the value of status is less than 300, this parameter is left blank. Default value: None
resource	str	Explanation: Error source (a bucket or an object). If the value of status is less than 300, this parameter is left blank. Default value: None
header	list	Explanation: Response header list, composed of tuples. Each tuple consists of two elements, respectively corresponding to the key and value of a response header. Default value: None
body	object	Explanation: Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python). Default value: None

**Table 3** Response result
GetResult.body Type	Description
GetBucketCustomDomainResponse	Explanation: Response result of obtaining the custom domain name of a bucket. For details, see GetBucketCustomDomainResponse.

**Table 4** GetBucketCustomDomainResponse
Parameter	Type	Description
domains	list of Domain	Explanation: The bucket's custom domain name list. Value range: For details, see Domain.

**Table 5** Domain
Parameter	Type	Description
name	str	Explanation: Name of the certificate bound to the custom domain name. Value range: The value is a string of 3 to 63 characters.
domain_name	str	Explanation: Custom domain name. Value range: The value is a string of 0 to 256 characters.
create_time	str	Explanation: Time when a custom domain name was created. Value range: The value must be a UTC time that complies with the ISO 8601 standard. Example: 2018-01-01T00:00:00.000Z The value is a string of 24 characters.
certificate_id	str	Explanation: ID of the certificate bound to the custom domain name. Value range: The value is a string of 16 characters.
certificateType	str	Explanation: Type of the certificate bound to the custom domain name. Value range: server: server certificate server_sm: server SM certificate client: client CA certificate
expiredTime	str	Explanation: If the certificate type is server or server_sm, the expiration time of the certificate bound to the custom domain name is returned. Value range: The value must be a UTC time that complies with the ISO 8601 standard. Example: 2018-01-01T00:00:00.000Z

Code Examples

This example obtains the custom domain name of bucket examplebucket.

    
     
       
       
         from obs import ObsClient
import os
import traceback

# Obtain an AK and SK pair using environment variables (recommended) or import it in other ways. Using hard coding may result in leakage.
# Obtain an AK and SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# (Optional) If you use a temporary AK and SK pair and a security token to access OBS, obtain them using environment variables.
# security_token = os.getenv("SecurityToken")
# Set server to the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
server = "https://obs.ap-southeast-1.myhuaweicloud.com" 

# Create an obsClient instance.
# If you use a temporary AK and SK pair and a security token to access OBS, you must specify security_token when creating an instance.
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = "examplebucket"
    # Obtain the custom domain name of the bucket.
    resp = obsClient.getBucketCustomDomain(bucketName)

    # If status code 2xx is returned, the API was called successfully. Otherwise, the call failed.
    if resp.status < 300:
        print('Get Bucket CustomDomain Succeeded')
        print('requestId:', resp.requestId)
        for domin in resp.body.domains:
            print('domainName:', domin.domainName)
            print('createTime:', domin.createTime)
    else:
        print('Get Bucket CustomDomain Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Get Bucket CustomDomain Failed')
    print(traceback.format_exc())

        

      

    
   