CreateDnsRecord
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: 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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.