全部產品
Search

搜尋本產品

    Object Storage Service：Python綁定自訂網域名

    文件中心

    Object Storage Service：Python綁定自訂網域名

    更新時間：Oct 26, 2024

    檔案（Object）上傳至儲存空間（Bucket）後，OSS會自動組建檔案URL，您可以直接通過檔案URL（即Bucket外網訪問網域名稱）訪問該檔案。如果您希望通過自訂網域名訪問這些Object，需要添加CNAME記錄將自訂網域名綁定至Object所在的Bucket。

    注意事項

    • 本文以華東1（杭州）外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS訪問網域名稱、資料中心、開放連接埠。

    • 本文以從環境變數讀取存取憑證為例。如何配置訪問憑證，請參見配置訪問憑證。

    • 本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient，請參見初始化。

    建立CnameToken

    以下代碼用於建立CnameToken。

    # -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 填寫自訂網域名。
test_domain = 'www.example.com'
# 建立CnameToken。
result = bucket.create_bucket_cname_token(test_domain)
# 列印綁定的Cname名稱。
print(result.cname)
# 列印OSS返回的CnameToken。
print(result.token)
# 列印CnameToken的到期時間。
print(result.expire_time)

    擷取CnameToken

    以下代碼用於擷取CnameToken。

    # -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 填寫自訂網域名。
test_domain = 'www.example.com'
# 擷取CnameToken。
result = bucket.get_bucket_cname_token(test_domain)
# 列印綁定的Cname名稱。
print(result.cname)
# 列印OSS返回的CnameToken。
print(result.token)
# 列印CnameToken的到期時間。
print(result.expire_time)

    添加CNAME記錄

    以下代碼用於添加CNAME記錄。

    # -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 填寫自訂網域名。
test_domain = 'www.example.com'
# 填寫舊版認證ID。
previous_cert_id = '001'
certificate = '''-----BEGIN CERTIFICATE-----
MIIDWzCCAkOgA******KTgnwyOGU9cv+mxA=
-----END CERTIFICATE-----'''
# 設定認證私密金鑰。
private_key = '''-----BEGIN PRIVATE KEY-----
MIIEvQIBADAN******1i2t41Q/SC3HUGC5mJjpO8=
-----END PRIVATE KEY-----
'''

cert = oss2.models.CertInfo(certificate=certificate, private_key=private_key)
# 通過force=True設定強制覆蓋舊版認證。
# 通過delete_certificate選擇是否刪除認證。設定為delete_certificate=True表示刪除認證，設定為delete_certificate=False表示不刪除認證。
# cert = oss2.models.CertInfo(certificate=certificate, private_key=private_key, force=True, delete_certificate=False)
input = oss2.models.PutBucketCnameRequest(test_domain, cert)
bucket.put_bucket_cname(input)

    查看CNAME記錄

    以下代碼用於查看CNAME記錄。

    # -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

list_result = bucket.list_bucket_cname()
for c in list_result.cname:
    # 列印認證ID。
    print(c.certificate.cert_id)
    # 列印認證來源。
    print(c.certificate.type)
    # 列印認證狀態。
    print(c.certificate.status)
    # 列印自訂網域名。
    print(c.domain)
    # 列印綁定自訂網域名的時間。
    print(c.last_modified)
    # 列印網域名稱所處狀態。
    print(c.status)

    刪除CNAME記錄

    以下代碼用於刪除CNAME記錄。

    # -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊，例如cn-hangzhou。注意，v4簽名下，必須填寫該參數
region = "cn-hangzhou"

# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)

# 填寫自訂網域名。
test_domain = 'www.example.com'
# 刪除CNAME記錄。
bucket.delete_bucket_cname(test_domain)

    相關文檔

    • 關於建立網域名稱所有權驗證所需的CnameToken的API介面說明，請參見CreateCnameToken。

    • 關於擷取CnameToken的API介面說明，請參見GetCnameToken。

    • 關於添加CNAME記錄的API介面說明，請參見PutCname。

    • 關於查看CNAME記錄的API介面說明，請參見ListCname。

    • 關於刪除CNAME記錄的API介面說明，請參見DeleteCname。