1. API Description
Domain name for API request: dnspod.intl.tencentcloudapi.com.
This API is used to add a domain.
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: CreateDomain. |
| Version | Yes | String | Common Params. The value used for this API: 2021-03-23. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Domain | Yes | String | Domain |
| GroupId | No | Integer | The group ID of the domain. You can view the group information of this domain via the DescribeDomainGroupList API. |
| IsMark | No | String | Whether the domain is starred. Valid values: yes, no. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| DomainInfo | DomainCreateInfo | Domain information |
| 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 Adding a domain
Input Example
POST / HTTP/1.1
Host: dnspod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDomain
<Common request parameters>
{
"Domain": "dnspod.com",
"IsMark": "no",
"GroupId": 2
}
Output Example
{
"Response": {
"RequestId": "ab4f1426-ea15-42ea-8183-dc1b44151166",
"DomainInfo": {
"Id": 62,
"Punycode": "dnspod.com",
"Domain": "dnspod.com",
"GradeNsList": [
"source.dnspod.net",
"low.dnspod.net"
]
}
}
}
Example2 CreateDomain_success
Input Example
POST / HTTP/1.1
Host: dnspod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDomain
<Common request parameters>
{
"Domain": "iceice.club"
}
Output Example
{
"Response": {
"RequestId": "674a208e-4829-4c2d-a519-a85f2f9bb223",
"DomainInfo": {
"GradeNsList": [
"eunice.dnspod.net",
"country.dnspod.net"
],
"Id": 15,
"Punycode": "iceice.club",
"Domain": "iceice.club"
}
}
}
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
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | The operation failed. |
| FailedOperation.DomainExists | The domain is already in your list. There is no need to add it again. |
| FailedOperation.DomainInEnterpriseMailAccount | |
| FailedOperation.DomainOwnedByOtherUser | This domain has been added by another account and can be reclaimed in the domain list. |
| FailedOperation.UnknowError | The operation has no response. Try again later. |
| InvalidParameter.AccountIsBanned | Your account is banned by the system. Please contact us if you have any questions. |
| InvalidParameter.DomainInBlackList | |
| InvalidParameter.DomainInvalid | The domain is incorrect. Enter a top-level domain such as dnspod.cn. |
| InvalidParameter.DomainIsAliaser | This domain is an alias of another domain. |
| InvalidParameter.DomainIsMyAlias | |
| InvalidParameter.DomainNotReged | The domain has not been registered and cannot be added. |
| InvalidParameter.EmailNotVerified | Sorry, the email address of your account has not been verified. |
| InvalidParameter.OperateFailed | Operation failed. Please try again later. |
| InvalidParameter.QuhuiTxtNotMatch | |
| InvalidParameter.QuhuiTxtRecordWait | The TXT record was not set or has not taken effect. Try again later. |
| InvalidParameter.ToolsDomainInvalid | The domain is invalid. |
| InvalidParameter.UnrealNameUser | Your account identity has not been verified. Complete identity verification first before performing this operation. |
Yes
No
Was this page helpful?