tencent cloud

Feedback

Custom Domain

Last updated: 2024-02-02 17:35:18

    Overview

    This document provides an overview of APIs and SDK code samples related to custom domain names.
    API
    Operation
    Description
    PUT Bucket domain
    Setting a custom domain name
    Sets a custom domain name for a bucket
    GET Bucket domain
    Querying a custom domain name
    Queries the custom domain name of a bucket
    DELETE Bucket domain
    Deleting a custom domain name
    Deletes the custom domain name of a bucket

    Setting custom domain names

    Feature description

    This API is used to bind a custom domain name to an existing bucket.

    Sample request

    cos.putBucketDomain({
    Bucket: 'examplebucket-1250000000', /* Required */
    Region: 'ap-beijing', /* Required */
    DomainRule: [{
    Status: "DISABLED",
    Name: "www.example.com",
    Type: "REST"
    },
    {
    Status: "DISABLED",
    Name: "www.example.net",
    Type: "WEBSITE",
    }]
    }, function(err, data) {
    console.log(err || data);
    });

    Parameter description

    Parameter Name
    Description
    Type
    Required
    Bucket
    Name of the bucket for which the custom domain name is configured in the format: BucketName-APPID
    String
    Yes
    Region
    Bucket region. For the enumerated values, see Regions and Access Domain Names
    String
    Yes
    DomainRule
    Custom domain name configuration
    Object
    Yes
    - Status
    Domain name status; enumerated values: Enabled, Disabled
    String
    Yes
    - Name
    User-defined domain name
    String
    Yes
    - Type
    Type of the bound origin server. Enumerated values: REST, WEBSITE
    String
    Yes
    - ForcedReplacement
    Replaces an existing configuration. Enumerated values: CNAME, TXT. Should this parameter be configured, validation will be forced on the ownership of the domain name before the configuration is delivered.
    String
    No

    Callback function description

    function(err, data) { ... }
    Parameter Name
    Description
    Type
    err
    Object returned when an error (network error or service error) occurs. If the request is successful, this is null. For more information, see Error Codes
    Object
    - statusCode
    HTTP status code returned by the request, such as 200, 403, and 404
    Number
    - headers
    Header information returned by the request
    Object
    data
    Data returned when the request is successful. If the request fails, this is null
    Object
    - statusCode
    HTTP status code returned by the request, such as 200, 403, and 404
    Number
    - headers
    Header information returned by the request
    Object

    Querying custom domain names

    Feature description

    This API is used to query the custom domain name associated with a bucket.

    Sample request

    cos.getBucketDomain({
    Bucket: 'examplebucket-1250000000', /* Required */
    Region: 'ap-beijing', /* Required */
    }, function(err, data) {
    console.log(err || data);
    });

    Sample response

    {
    "DomainRule": [{
    "Status": "DISABLED",
    "Name": "www.example.com",
    "Type": "REST"
    }, {
    "Status": "DISABLED",
    "Name": "www.example.net",
    "Type": "WEBSITE"
    }],
    "statusCode": 200,
    "headers": {}
    }

    Parameter description

    Parameter Name
    Description
    Type
    Required
    Bucket
    Name of the bucket for which the custom domain name is queried in the format: BucketName-APPID
    String
    Yes
    Region
    Bucket region. For the enumerated values, see Regions and Access Domain Names
    String
    Yes

    Callback function description

    function(err, data) { ... }
    Parameter Name
    Description
    Type
    err
    Object returned when an error (network error or service error) occurs. If the request is successful, this is null. For more information, see Error Codes
    Object
    - statusCode
    HTTP status code returned by the request, such as 200, 403, and 404
    Number
    - headers
    Header information returned by the request
    Object
    data
    Data returned when the request is successful. If the request fails, this is null
    Object
    - statusCode
    HTTP status code returned by the request, such as 200, 403, and 404
    Number
    - headers
    Header information returned by the request
    Object
    - DomainRule
    Custom domain name configuration
    Object
    - - Status
    Domain name status; enumerated values: Enabled, Disabled
    String
    - - Name
    User-defined domain name
    String
    - - Type
    Type of the bound origin server. Enumerated values: REST, WEBSITE
    String
    - - ForcedReplacement
    Replaces an existing configuration. Enumerated values: CNAME, TXT. Should this parameter be configured, validation will be forced on the ownership of domain name before the configuration is delivered.
    String

    Deleting custom domain names

    Feature description

    This API is used to delete the custom domain name configured for a bucket.

    Sample request

    cos.deleteBucketDomain({
    Bucket: 'examplebucket-1250000000', /* Required */
    Region: 'ap-beijing', /* Required */
    }, function(err, data) {
    console.log(err || data);
    });

    Parameter description

    Parameter Name
    Description
    Type
    Required
    Bucket
    Name of the bucket for which the custom domain name is deleted in the format: BucketName-APPID
    String
    Yes
    Region
    Bucket region. For the enumerated values, see Regions and Access Domain Names
    String
    Yes

    Callback function description

    function(err, data) { ... }
    Parameter Name
    Description
    Type
    err
    Object returned when an error (network error or service error) occurs. If the request is successful, this is null. For more information, see Error Codes
    Object
    - statusCode
    HTTP status code returned by the request, such as 200, 403, and 404
    Number
    - headers
    Header information returned by the request
    Object
    data
    Data returned when the request is successful. If the request fails, this is null
    Object
    - statusCode
    HTTP status code returned by the request, such as 200, 403, and 404
    Number
    - headers
    Header information returned by the request
    Object
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support