Todos os produtos
Search
Central de documentação

Object Storage Service:Mapear nomes de domínio personalizados com o OSS SDK for Python 2.0

Última atualização: Jul 03, 2026

Após o upload de objetos para um bucket, o Object Storage Service (OSS) gera automaticamente URLs que incluem o endpoint público do bucket para os objetos enviados. Use essas URLs para acessar os objetos. Para acessá-los por meio de um nome de domínio personalizado, adicione um registro CNAME para mapear esse domínio ao bucket onde os objetos estão armazenados.

Observações de uso

  • O código de exemplo neste tópico usa o ID da região cn-hangzhou, correspondente à região China (Hangzhou). Por padrão, o acesso aos recursos de um bucket ocorre via endpoint público. Para acessar esses recursos com outros serviços da Alibaba Cloud na mesma região do bucket, use um endpoint interno. Para mais informações sobre regiões e endpoints do OSS, consulte Regiões e endpoints.

Exemplos

Crie um token CNAME

O código de exemplo a seguir demonstra como criar um token CNAME:

import argparse
import alibabacloud_oss_v2 as oss

# Create a command line parameter parser and describe the purpose of the script. The example describes how to create a CNAME token.
parser = argparse.ArgumentParser(description="create cname token sample")

# Specify the command line parameters, including the region, bucket name, endpoint, and custom domain name.
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():
    # Parse the command line parameters to obtain the values entered by the user.
    args = parser.parse_args()

    # Obtain the access credentials from environment variables for identity authentication.
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Use the default configurations of the SDK to create a configuration object and specify the credential provider.
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # Specify the region attribute of the configuration object based on the command line parameters provided by the user.
    cfg.region = args.region

    # If a custom endpoint is provided, modify the endpoint parameter in the configuration object.
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # Use the preceding configurations to initialize the OSSClient instance and allow the instance to interact with OSS.
    client = oss.Client(cfg)

    # Send a request to create a CNAME token for the bucket.
    result = client.create_cname_token(oss.CreateCnameTokenRequest(
            bucket=args.bucket, # The name of the bucket.
            bucket_cname_configuration=oss.BucketCnameConfiguration(
                cname=oss.Cname(
                    domain=args.domain, # The custom domain name.
                ),
            ),
    ))

    # Display the status code of the operation result and other relevant information to check the request status and CNAME token details.
    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"},'
          )

# Call the main function to start the processing logic when the script is directly run.
if __name__ == "__main__":
    main() # Specify the entry points in the functions of the script. The control program flow starts here.

Query a CNAME token

O código de exemplo a seguir demonstra como consultar um token CNAME:

import argparse
import alibabacloud_oss_v2 as oss

# Create a command line parameter parser and describe the purpose of the script. The example describes how to query a CNAME token.
parser = argparse.ArgumentParser(description="get cname token sample")

# Specify the command line parameters, including the region, bucket name, endpoint, and CNAME record.
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():
    # Parse the command line parameters to obtain the values entered by the user.
    args = parser.parse_args()

    # Obtain the access credentials from environment variables for identity authentication.
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Use the default configurations of the SDK to create a configuration object and specify the credential provider.
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # Specify the region attribute of the configuration object based on the command line parameters provided by the user.
    cfg.region = args.region

    # If a custom endpoint is provided, modify the endpoint parameter in the configuration object.
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # Use the preceding configurations to initialize the OSSClient instance and allow the instance to interact with OSS.
    client = oss.Client(cfg)

    # Send a request to query the CNAME token of the bucket and the CNAME record.
    result = client.get_cname_token(oss.GetCnameTokenRequest(
            bucket=args.bucket, # The name of the bucket.
            cname=args.cname, # The name of the CNAME record for the custom domain name.
    ))

    # Display the status code of the operation result and other relevant information to check the request status and CNAME token details.
    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"},'
          )

# Call the main function to start the processing logic when the script is directly run.
if __name__ == "__main__":
    main() # Specify the entry points in the functions of the script. The control program flow starts here.

Add a CNAME record

O código de exemplo a seguir demonstra como adicionar um registro CNAME para mapear um domínio personalizado a um bucket:

import argparse
import alibabacloud_oss_v2 as oss

# Create a command line parameter parser and describe the purpose of the script. The example describes how to add a CNAME record used to map a custom domain to a bucket.
parser = argparse.ArgumentParser(description="put cname sample")

# Specify the command line parameters, including the region, bucket name, endpoint, and custom domain name.
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():
    # Parse the command line parameters to obtain the values entered by the user.
    args = parser.parse_args()

    # Obtain the access credentials from environment variables for identity authentication.
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Use the default configurations of the SDK to create a configuration object and specify the credential provider.
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # Specify the region attribute of the configuration object based on the command line parameters provided by the user.
    cfg.region = args.region

    # If a custom endpoint is provided, modify the endpoint parameter in the configuration object.
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # Use the preceding configurations to initialize the OSSClient instance and allow the instance to interact with OSS.
    client = oss.Client(cfg)

    # Specify the SSL certificate parameters and associate the SSL certificate with the custom domain name.
    cert_id='493****-cn-hangzhou ' # The ID of the SSL certificate.
    certificate = '''-----BEGIN CERTIFICATE-----
MIIDhDCCAmwCCQCFs8ixARsyrDANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC
**** -----END CERTIFICATE-----''' # The content of the SSL certificate.
    private_key = '''-----BEGIN CERTIFICATE-----
MIIDhDCCAmwCCQCFs8ixARsyrDANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC
**** -----END CERTIFICATE-----''' # The content of the private key.
    previous_cert_id='493****-cn-hangzhou ' # The ID of the original SSL certificate.
    force = True # Forcibly overwrite the original SSL certificate.

    # Send a request to add a CNAME record used to map a custom domain to a bucket and associate the SSL certificate with the custom domain name.
    result = client.put_cname(oss.PutCnameRequest(
            bucket=args.bucket, # The name of the bucket.
            bucket_cname_configuration=oss.BucketCnameConfiguration(
                cname=oss.Cname(
                    domain=args.domain, # The custom domain name.
                    certificate_configuration=oss.CertificateConfiguration(
                        certificate=certificate, # The content of the SSL certificate.
                        private_key=private_key, # The content of the private key.
                        previous_cert_id=previous_cert_id, # The ID of the original SSL certificate.
                        force=force,  # Forcibly overwrite the original SSL certificate.
                        cert_id=cert_id, # The ID of the new SSL certificate.
                    ),
                ),
            ),
    ))

    # Display the status code of the operation result and request ID to check the request status.
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

    """
    # Optional. If you want to delete the SSL certificate, please delete the description for the following code.
    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, # Delete the SSL certificate.
                    ),
                ),
            ),
    ))
    """

# Call the main function to start the processing logic when the script is directly run.
if __name__ == "__main__":
    main() # Specify the entry points in functions of the script. The control program flow starts here.

List CNAME records

O código de exemplo a seguir demonstra como listar os registros CNAME de um bucket:

import argparse
import alibabacloud_oss_v2 as oss

# Create a command line parameter parser and describe the purpose of the script. The example describes how to list the CNAME records of a bucket.
parser = argparse.ArgumentParser(description="list cname sample")

# Specify the command line parameters, including the region, bucket name, and endpoint. The endpoint parameter is optional.
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():
    # Parse the command line parameters to obtain the values entered by the user.
    args = parser.parse_args()

    # Obtain the access credentials from environment variables for identity authentication.
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Use the default configurations of the SDK to create a configuration object and specify the credential provider.
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # Specify the region attribute of the configuration object based on the command line parameters provided by the user.
    cfg.region = args.region

    # If a custom endpoint is provided, modify the endpoint parameter in the configuration object.
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # Use the preceding configurations to initialize the OSSClient instance and allow the instance to interact with OSS.
    client = oss.Client(cfg)

    # Send a request to list the CNAME records of the bucket.
    result = client.list_cname(oss.ListCnameRequest(
            bucket=args.bucket, # The name of the bucket.
    ))

    # Display the status code of the operation result, the request ID, and other relevant information to check the request status and CNAME records.
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' bucket: {result. Bucket},' # The name of the bucket.
          f' owner: {result.owner},' # The owner of the bucket.
          )

    # If CNAME records exist, traverse and display the details of each CNAME record.
    if result.cnames:
        for r in result.cnames:
            # Display the domain name, last modified time, status, and SSL certificate information (if any) of the CNAME record.
            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}'
                  )

# Call the main function to start the processing logic when the script is directly run.
if __name__ == "__main__":
    main() # Specify the entry points in the functions of the script. The control program flow starts here.

Exclua um registro CNAME

O código de exemplo a seguir demonstra como excluir um registro CNAME usado para mapear um domínio personalizado a um bucket:

import argparse
import alibabacloud_oss_v2 as oss

# Create a command line parameter parser and describe the purpose of the script. The example describes how to delete a CNAME record used to map a custom domain to a bucket.
parser = argparse.ArgumentParser(description="delete cname sample")

# Specify the command line parameters, including the region, bucket name, endpoint, and custom domain name.
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():
    # Parse the command line parameters to obtain the values entered by the user.
    args = parser.parse_args()

    # Obtain the access credentials from environment variables for identity authentication.
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Use the default configurations of the SDK to create a configuration object and specify the credential provider.
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # Specify the region attribute of the configuration object based on the command line parameters provided by the user.
    cfg.region = args.region

    # If a custom endpoint is provided, modify the endpoint parameter in the configuration object.
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # Use the preceding configurations to initialize the OSSClient instance and allow the instance to interact with OSS.
    client = oss.Client(cfg)

    # Send a request to delete the CNAME record.
    result = client.delete_cname(oss.DeleteCnameRequest(
            bucket=args.bucket, # The name of the bucket.
            bucket_cname_configuration=oss.BucketCnameConfiguration(
                cname=oss.Cname(
                    domain=args.domain, # The custom domain name.
                ),
            ),
    ))

    # Display the status code of the operation result and request ID to check the request status.
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          )

# Call the main function to start the processing logic when the script is directly run.
if __name__ == "__main__":
    main() # Specify the entry points in the functions of the script. The control program flow starts here.

Referências

  • Para obter o código de exemplo completo usado na criação de um token CNAME para verificação de propriedade de domínio, acesse create_cname_token.py.

  • Para obter o código de exemplo completo usado na consulta de um token CNAME, acesse get_cname_token.py.

  • Para obter o código de exemplo completo usado na adição de um registro CNAME, acesse put_cname.py.

  • Para obter o código de exemplo completo usado na listagem de registros CNAME, acesse list_cname.py.

  • Para obter o código de exemplo completo usado na exclusão de um registro CNAME, acesse delete_cname.py.