全部產品
Search

搜尋本產品

    Object Storage Service：綁定自訂網域名（Python SDK V2）

    文件中心

    Object Storage Service：綁定自訂網域名（Python SDK V2）

    更新時間：Aug 01, 2025

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

    注意事項

    • 本文範例程式碼以華東1（杭州）的地區IDcn-hangzhou為例，預設使用外網Endpoint，如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS地區和訪問網域名稱。

    範例程式碼

    建立CnameToken

    以下代碼用於建立CnameToken。

    import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：建立Cname Token
parser = argparse.ArgumentParser(description="create cname token sample")

# 定義命令列參數，包括必需的地區、儲存空間名稱、endpoint以及自訂網域名
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--domain', help='The custom domain name.', required=True)

def main():
    # 解析命令列參數，擷取使用者輸入的值
    args = parser.parse_args()

    # 從環境變數中載入訪問憑證資訊，用於身分識別驗證
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK預設配置建立設定物件，並設定認證提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 設定設定物件的地區屬性，根據使用者提供的命令列參數
    cfg.region = args.region

    # 如果提供了自訂endpoint，則更新設定物件中的endpoint屬性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS用戶端，準備與OSS互動
    client = oss.Client(cfg)

    # 發送請求以建立指定儲存空間的Cname Token
    result = client.create_cname_token(oss.CreateCnameTokenRequest(
            bucket=args.bucket,  # 儲存空間名
            bucket_cname_configuration=oss.BucketCnameConfiguration(
                cname=oss.Cname(
                    domain=args.domain,  # 自訂網域名
                ),
            ),
    ))

    # 列印操作結果的狀態代碼和其他相關資訊，以便確認請求狀態和Cname Token詳情
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' cname: {result.cname_token.cname if hasattr(result.cname_token, "cname") else "Not set"},'
          f' token: {result.cname_token.token if hasattr(result.cname_token, "token") else "Not set"},'
          f' expire time: {result.cname_token.expire_time.strftime("%Y-%m-%dT%H:%M:%S.000Z") if hasattr(result.cname_token, "expire_time") else "Not set"},'
          f' bucket: {result.cname_token.bucket if hasattr(result.cname_token, "bucket") else "Not set"},'
          )

# 當此指令碼被直接執行時，調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點，控製程序流程從這裡開始

    擷取CnameToken

    以下代碼用於擷取CnameToken。

    import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：擷取Cname Token資訊
parser = argparse.ArgumentParser(description="get cname token sample")

# 定義命令列參數，包括必需的地區、儲存空間名稱、endpoint以及CNAME記錄名
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--cname', help='The name of the CNAME record that is mapped to the bucket.', required=True)

def main():
    # 解析命令列參數，擷取使用者輸入的值
    args = parser.parse_args()

    # 從環境變數中載入訪問憑證資訊，用於身分識別驗證
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK預設配置建立設定物件，並設定認證提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 設定設定物件的地區屬性，根據使用者提供的命令列參數
    cfg.region = args.region

    # 如果提供了自訂endpoint，則更新設定物件中的endpoint屬性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS用戶端，準備與OSS互動
    client = oss.Client(cfg)

    # 發送請求以擷取指定儲存空間和CNAME記錄的Cname Token資訊
    result = client.get_cname_token(oss.GetCnameTokenRequest(
            bucket=args.bucket,  # 儲存空間名
            cname=args.cname,  # 自訂網域名對應的CNAME記錄名
    ))

    # 列印操作結果的狀態代碼和其他相關資訊，以便確認請求狀態和Cname Token詳情
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' cname: {result.cname_token.cname if hasattr(result.cname_token, "cname") else "Not set"},'
          f' token: {result.cname_token.token if hasattr(result.cname_token, "token") else "Not set"},'
          f' expire time: {result.cname_token.expire_time.strftime("%Y-%m-%dT%H:%M:%S.000Z") if hasattr(result.cname_token, "expire_time") else "Not set"},'
          f' bucket: {result.cname_token.bucket if hasattr(result.cname_token, "bucket") else "Not set"},'
          )

# 當此指令碼被直接執行時，調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點，控製程序流程從這裡開始

    添加CNAME記錄

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

    import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：設定自訂網域名（CNAME）
parser = argparse.ArgumentParser(description="put cname sample")

# 定義命令列參數，包括必需的地區、儲存空間名稱、endpoint以及自訂網域名
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--domain', help='The custom domain name.', required=True)

def main():
    # 解析命令列參數，擷取使用者輸入的值
    args = parser.parse_args()

    # 從環境變數中載入訪問憑證資訊，用於身分識別驗證
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK預設配置建立設定物件，並設定認證提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 設定設定物件的地區屬性，根據使用者提供的命令列參數
    cfg.region = args.region

    # 如果提供了自訂endpoint，則更新設定物件中的endpoint屬性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS用戶端，準備與OSS互動
    client = oss.Client(cfg)

    # SSL認證相關參數，用於綁定到自訂網域名上
    cert_id = '493****-cn-hangzhou'  # 認證ID
    certificate = '''-----BEGIN CERTIFICATE-----
MIIDhDCCAmwCCQCFs8ixARsyrDANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC
**** -----END CERTIFICATE-----'''  # SSL認證內容
    private_key = '''-----BEGIN CERTIFICATE-----
MIIDhDCCAmwCCQCFs8ixARsyrDANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC
**** -----END CERTIFICATE-----'''  # 私密金鑰內容
    previous_cert_id = '493****-cn-hangzhou'  # 上一個認證ID，用於替換舊認證
    force = True  # 強制覆蓋已有認證標誌

    # 發送請求以設定指定儲存空間的自訂網域名（CNAME），並關聯SSL認證
    result = client.put_cname(oss.PutCnameRequest(
            bucket=args.bucket,  # 儲存空間名
            bucket_cname_configuration=oss.BucketCnameConfiguration(
                cname=oss.Cname(
                    domain=args.domain,  # 自訂網域名
                    certificate_configuration=oss.CertificateConfiguration(
                        certificate=certificate,  # SSL認證內容
                        private_key=private_key,  # 私密金鑰內容
                        previous_cert_id=previous_cert_id,  # 上一個認證ID
                        force=force,  # 強制覆蓋已有認證標誌
                        cert_id=cert_id,  # 新認證ID
                    ),
                ),
            ),
    ))

    # 列印操作結果的狀態代碼和請求ID，以便確認請求狀態
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

    """
    # 可選部分：如果您想刪除認證，請取消下面代碼塊的注釋
    result = client.put_cname(oss.PutCnameRequest(
            bucket=args.bucket,
            bucket_cname_configuration=oss.BucketCnameConfiguration(
                cname=oss.Cname(
                    domain=args.domain,
                    certificate_configuration=oss.CertificateConfiguration(
                        delete_certificate=True,  # 指示刪除認證
                    ),
                ),
            ),
    ))
    """

# 當此指令碼被直接執行時，調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點，控製程序流程從這裡開始

    列舉CNAME記錄

    以下代碼用於列舉Bucket下的CNAME記錄。

    import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：列出儲存空間中的CNAME記錄
parser = argparse.ArgumentParser(description="list cname sample")

# 定義命令列參數，包括必需的地區、儲存空間名稱以及可選的endpoint
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令列參數，擷取使用者輸入的值
    args = parser.parse_args()

    # 從環境變數中載入訪問憑證資訊，用於身分識別驗證
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK預設配置建立設定物件，並設定認證提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 設定設定物件的地區屬性，根據使用者提供的命令列參數
    cfg.region = args.region

    # 如果提供了自訂endpoint，則更新設定物件中的endpoint屬性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS用戶端，準備與OSS互動
    client = oss.Client(cfg)

    # 發送請求以列出指定儲存空間的Cname記錄
    result = client.list_cname(oss.ListCnameRequest(
            bucket=args.bucket,  # 儲存空間名
    ))

    # 列印操作結果的狀態代碼、請求ID和其他相關資訊，以便確認請求狀態和Cname列表詳情
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' bucket: {result.bucket},'  # 儲存空間名
          f' owner: {result.owner},'  # 儲存空間所有者
          )

    # 如果存在CNAME記錄，則遍曆並列印每個CNAME記錄的詳細資料
    if result.cnames:
        for r in result.cnames:
            # 列印CNAME記錄的網域名稱、最後修改時間、狀態以及認證資訊（如果有）
            certificate_info = (f"fingerprint: {r.certificate.fingerprint}, "
                                f"valid start date: {r.certificate.valid_start_date}, "
                                f"valid end date: {r.certificate.valid_end_date}, "
                                f"type: {r.certificate.type}, "
                                f"cert id: {r.certificate.cert_id}, "
                                f"status: {r.certificate.status}, "
                                f"creation date: {r.certificate.creation_date}") if r.certificate else "No certificate"
            print(f'domain: {r.domain}, '
                  f'last modified: {r.last_modified}, '
                  f'status: {r.status}, '
                  f'certificate: {certificate_info}'
                  )

# 當此指令碼被直接執行時，調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點，控製程序流程從這裡開始

    刪除CNAME記錄

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

    import argparse
import alibabacloud_oss_v2 as oss

# 建立命令列參數解析器，並描述指令碼用途：刪除儲存空間中的CNAME記錄
parser = argparse.ArgumentParser(description="delete cname sample")

# 定義命令列參數，包括必需的地區、儲存空間名稱、endpoint以及自訂網域名
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--domain', help='The custom domain name.', required=True)

def main():
    # 解析命令列參數，擷取使用者輸入的值
    args = parser.parse_args()

    # 從環境變數中載入訪問憑證資訊，用於身分識別驗證
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK預設配置建立設定物件，並設定認證提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 設定設定物件的地區屬性，根據使用者提供的命令列參數
    cfg.region = args.region

    # 如果提供了自訂endpoint，則更新設定物件中的endpoint屬性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS用戶端，準備與OSS互動
    client = oss.Client(cfg)

    # 發送請求以刪除指定儲存空間和自訂網域名（CNAME）的綁定關係
    result = client.delete_cname(oss.DeleteCnameRequest(
            bucket=args.bucket,  # 儲存空間名
            bucket_cname_configuration=oss.BucketCnameConfiguration(
                cname=oss.Cname(
                    domain=args.domain,  # 自訂網域名
                ),
            ),
    ))

    # 列印操作結果的狀態代碼和請求ID，以便確認請求狀態
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

# 當此指令碼被直接執行時，調用main函數開始處理邏輯
if __name__ == "__main__":
    main()  # 指令碼進入點，控製程序流程從這裡開始

    相關文檔

    • 關於建立網域名稱所有權驗證所需的CnameToken的完整範例程式碼，請參見create_cname_token.py。

    • 關於擷取CnameToken的完整範例程式碼，請參見get_cname_token.py。

    • 關於添加CNAME記錄的完整範例程式碼，請參見put_cname.py。

    • 關於查看CNAME記錄的完整範例程式碼，請參見list_cname.py。

    • 關於刪除CNAME記錄的完整範例程式碼，請參見delete_cname.py。