tencent cloud

All product documents
Tencent Cloud EdgeOne
DocumentationTencent Cloud EdgeOneAPI DocumentationDNS Record APIsCreateDnsRecord
CreateDnsRecord
Download PDF
Last updated: 2025-02-19 19:33:29
CreateDnsRecord
Last updated: 2025-02-19 19:33:29
Download PDF

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

After creating a site and the site is accessed in NS mode, you can create DNS records through this API.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateDnsRecord.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
ZoneId Yes String Zone id.
Name Yes String DNS record name. if the domain name is in chinese, korean, or japanese, it needs to be converted to punycode before input.
Type Yes String DNS record type. valid values are:
  • a: points the domain name to an external ipv4 address, such as 8.8.8.8;
  • aaaa: points the domain name to an external ipv6 address;
  • mx: used for email servers. when there are multiple mx records, the lower the priority value, the higher the priority;
  • cname: points the domain name to another domain name, which then resolves to the final ip address;
  • txt: identifies and describes the domain name, commonly used for domain verification and spf records (anti-spam);
  • ns: if you need to delegate the subdomain to another dns service provider for resolution, you need to add an ns record. the root domain cannot add ns records;
  • caa: specifies the ca that can issue certificates for this site;
  • srv: identifies a server using a service, commonly used in microsoft's directory management.
    • .
    Different record types, such as srv and caa records, have different requirements for host record names and record value formats. for detailed descriptions and format examples of each record type, please refer to: introduction to dns record types.
    Content Yes String DNS record content. fill in the corresponding content according to the type value. if the domain name is in chinese, korean, or japanese, it needs to be converted to punycode before input.
    Location No String DNS record resolution route. if not specified, the default is default, which means the default resolution route and is effective in all regions.

    - resolution route configuration is only applicable when type (dns record type) is a, aaaa, or cname.
    - resolution route configuration is only applicable to standard version and enterprise edition packages. for valid values, please refer to: resolution routes and corresponding code enumeration.
    TTL No Integer Cache time. users can specify a value range of 60-86400. the smaller the value, the faster the modification records will take effect in all regions. default value: 300. unit: seconds.
    Weight No Integer DNS record weight. users can specify a value range of -1 to 100. a value of 0 means no resolution. if not specified, the default is -1, which means no weight is set. weight configuration is only applicable when type (dns record type) is a, aaaa, or cname.
    note: for the same subdomain, different dns records with the same resolution route should either all have weights set or none have weights set.
    Priority No Integer MX record priority, which takes effect only when type (dns record type) is mx. the smaller the value, the higher the priority. users can specify a value range of 0–50. the default value is 0 if not specified.

    3. Output Parameters

    Parameter Name Type Description
    RecordId String DNS record id.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 This API Is Used To Create a DNS Record

    Create a DNS record with the record name www.example.com, record type A, record content 1.2.3.4, and cache time 60 seconds under the site with ZoneId zone-225qgrnvbi9w.

    Input Example

    POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDnsRecord
<Common request parameters>

{
    "ZoneId": "zone-225qgrnvbi9w",
    "Name": "www.example.com",
    "Type": "A",
    "Content": "1.2.3.4",
    "TTL": 60
}

    Output Example

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707",
        "RecordId": "record-225rcy8bw85g"
    }
}

    Example2 Creating a DNS Record With Assigned Weights

    Create a DNS record with the record name www.example.com, record type A, record content 1.2.3.4, cache time 60 seconds, and record weight 100 under the site with ZoneId zone-225qgrnvbi9w.

    Input Example

    POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDnsRecord
<Common request parameters>

{
    "ZoneId": "zone-225qgrnvbi9w",
    "Name": "www.example.com",
    "Type": "A",
    "Content": "1.2.3.4",
    "TTL": 60,
    "Weight": 100
}

    Output Example

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707",
        "RecordId": "record-225rcy8bw85g"
    }
}

    Example3 Creating a DNS Record With Assigned Resolution Routes

    Create a DNS record with the record name www.example.com, record type A, resolution route Beijing (CN.BJ), record content 1.2.3.4, and cache time 60 seconds under the site with ZoneId zone-225qgrnvbi9w.

    Input Example

    POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDnsRecord
<Common request parameters>

{
    "ZoneId": "zone-225qgrnvbi9w",
    "Name": "www.example.com",
    "Type": "A",
    "Location": "CN.BJ",
    "Content": "1.2.3.4",
    "TTL": 60
}

    Output Example

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707",
        "RecordId": "record-225rcy8bw85g"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

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

    Contact Us
    Technical Support

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

    Submit a Ticket
    7x24 Phone Support