Domains

Domains
API Documentation
Product Documentation©2013-2022 Tencent Cloud. All rights reserved.

Page 1 of 178

Domains

Copyright Notice©2013-2024 Tencent Cloud. All rights reserved.
Copyright in this document is exclusively owned by Tencent Cloud. You must not reproduce, modify, copy or distributein any way, in whole or in part, the contents of this document without Tencent Cloud's the prior written consent.
Trademark Notice

All trademarks associated with Tencent Cloud and its services are owned by Tencent Cloud Computing (Beijing)
Company Limited and its affiliated companies. Trademarks of third parties referred to in this document are owned bytheir respective proprietors.
Service Statement
This document is intended to provide users with general information about Tencent Cloud's products and services
only and does not form part of Tencent Cloud's terms and conditions. Tencent Cloud's products or services are
subject to change. Specific products and services and the standards applicable to them are exclusively provided for in
Tencent Cloud's applicable terms and conditions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 2 of 178

Domains

Contents
API Documentation
History
Introduction
API Category
Making API Requests
Request Structure
Common Params
Signature v3
Signature
Responses
Domain Management APIs
DescribeIntlBatchOperationLogs
DescribeIntlDomainBatchDetails
Domain Query APIs
CheckIntlDomainNew
DescribeIntlDomainPriceNewList
Bulk Operation APIs
BatchModifyIntlDomainDNS
BatchModifyIntlDomainInfo
CreateIntlDomainBatch
TransferInIntlDomainBatch
Registrant Profile APIs
CreateIntlTemplate
DescribeIntlTemplateList
Other APIs
CreateIntlPhoneEmailDeleteIntlPhoneEmailDeleteIntlTemplate
DescribeIntlBatchDetailStatus
DescribeIntlDomain
DescribeIntlDomainList
DescribeIntlPhoneEmailList
DescribeIntlTemplate
ModifyOwnerIntlBatch
RenewIntlDomainBatch©2013-2022 Tencent Cloud. All rights reserved.

Page 3 of 178

Domains

SendIntlPhoneEmailCode
SetIntlDomainAutoRenew
TransferProhibitionIntlBatch
UpdateProhibitionIntlBatch
Data Types
Error Codes©2013-2022 Tencent Cloud. All rights reserved.

Page 4 of 178

Domains

API Documentation
History：

Last updated 2023-04-03 18:06:22

Release 2
Release time: 2023-04-03 18:05:15
Release updates:
Improvement to existing documentation.
Modified APIs:
CreateIntlDomainBatch
New input parameters:CustomDns

Release 1
Release time: 2023-03-28 10:35:36
Release updates:
Improvement to existing documentation.
New APIs:
BatchModifyIntlDomainDNS
BatchModifyIntlDomainInfo
CheckIntlDomainNew
CreateIntlDomainBatch
CreateIntlPhoneEmailCreateIntlTemplate
DeleteIntlPhoneEmailDeleteIntlTemplate
DescribeIntlBatchDetailStatus
DescribeIntlBatchOperationLogs
DescribeIntlDomain
DescribeIntlDomainBatchDetails©2013-2022 Tencent Cloud. All rights reserved.

Page 5 of 178

Domains

DescribeIntlDomainList
DescribeIntlDomainPriceNewList
DescribeIntlPhoneEmailList
DescribeIntlTemplate
DescribeIntlTemplateList
ModifyOwnerIntlBatch
RenewIntlDomainBatch
SendIntlPhoneEmailCode
SetIntlDomainAutoRenew
TransferInIntlDomainBatch
TransferProhibitionIntlBatch
UpdateProhibitionIntlBatch
New data structures:
AdminContact
BatchDomainBuyDetails
BatchDomainBuyLog
BillingContact
IntlBatchDetails
IntlContactInfo
IntlDomainInfo
IntlPhoneEmailLists
IntlTemplate
IntlTemplateInfo
PriceInfoNew
RegistrantContact
TechnicalContact©2013-2022 Tencent Cloud. All rights reserved.

Page 6 of 178

Domains

Introduction：

Last updated 2023-03-28 10:48:32
There are tens of millions of hosts on the internet. An IP address is allocated to each host to distinguish them from one
another. However, an IP address doesn't have any actual meaning to it, which makes it hard to remember, and this is
why domain names come into play.
A domain name, comprised of letters, digits, - , . , and other symbols, is an easy-to-remember server address(such as website, email, and FTP) designed for better communication.
A domain name corresponds to an IP. A specialized domain name system (DNS) server on the internet is used totranslate between domain names and IPs. When you enter a domain name in your browser, DNS will translate it into
an IP to locate the appropriate server and open the requested page.
If you want to set up a server to publish information on the internet, you need to register a domain name first, which isa basic for establishing services on the internet. Since domain names are registered on a "first-come, first-served"
basis and every registered domain name must be unique on the internet, you are advised to register your domainnames as soon as possible.

©2013-2022 Tencent Cloud. All rights reserved.

Page 7 of 178

Domains

API Category：

Last updated 2023-04-03 18:06:22

Domain Management APIs
API Name

FeatureFrequency Limit

DescribeIntlBatchOperationLogs

Queries the logs of bulk domain purchase20

DescribeIntlDomainBatchDetails

Gets the log details of bulk domain purchase20

Domain Query APIs
API Name

FeatureFrequency Limit

CheckIntlDomainNew

Checks whether a domain is available for registration

20

DescribeIntlDomainPriceNewList

Gets the price list by domain suffix

20

Other APIs
Frequency

API Name

FeatureCreateIntlPhoneEmail

Verifies a mobile number or an email address via averification code

20

DeleteIntlPhoneEmailDeletes a mobile number or an email address

20

DeleteIntlTemplate

Deletes a registrant profile

20

DescribeIntlBatchDetailStatus

Queries the status of a bulk task

20

DescribeIntlDomain

Queries domain information

20

DescribeIntlDomainList

Queries the "My domains" list

20

DescribeIntlPhoneEmailList

Gets the list of verified mobile numbers and email
addresses

20©2013-2022 Tencent Cloud. All rights reserved.

Limit

Page 8 of 178

Domains

DescribeIntlTemplate

Gets the details of a registrant profile

20

ModifyOwnerIntlBatch

Bulk transfers domains to another account20

RenewIntlDomainBatch

Bulk renews domains

20

SendIntlPhoneEmailCode

Sends a verification code to a mobile number or an email

20

address

SetIntlDomainAutoRenew

Sets auto-renewal

20

TransferProhibitionIntlBatch

Bulk sets transfer prohibition for domains

20

UpdateProhibitionIntlBatch

Bulk sets update prohibition for domains

20

Bulk Operation APIs
API Name

FeatureFrequency Limit

BatchModifyIntlDomainDNS

Bulk modifies DNS servers for domains

20

BatchModifyIntlDomainInfo

Bulk modifies registrant information

20

TransferInIntlDomainBatch

Bulk transfers domains in

20

CreateIntlDomainBatch

Bulk registers domains

20

Registrant Profile APIs
API Name

FeatureFrequency Limit

CreateIntlTemplate

Adds a registrant profile

20

DescribeIntlTemplateList

Gets the list of registrant profiles

20©2013-2022 Tencent Cloud. All rights reserved.

Page 9 of 178

Domains

Making API Requests
Request Structure：

Last updated 2023-03-28 10:48:32

1. Service Address
The API supports access from either a nearby region (at domain.tencentcloudapi.com) or a specified region (atdomain.ap-guangzhou.tencentcloudapi.com for Guangzhou, for example).
We recommend using the domain name to access the nearest server. When you call an API, the request is
automatically resolved to a server in the region nearest to the location where the API is initiated. For example, when
you initiate an API request in Guangzhou, this domain name is automatically resolved to a Guangzhou server, theresult is the same as that of specifying the region in the domain like "domain.ap-guangzhou.tencentcloudapi.com".
Note: For latency-sensitive businesses, we recommend that you specify the region in the domain name.
Tencent Cloud currently supports the following regions:
Hosted region

Domain nameLocal access region (recommended, only for non-financial
availability zones)

domain.tencentcloudapi.com

South China (Guangzhou)

domain.apguangzhou.tencentcloudapi.com

East China (Shanghai)

domain.apshanghai.tencentcloudapi.com

North China (Beijing)domain.ap-beijing.tencentcloudapi.com

Southwest China (Chengdu)

domain.apchengdu.tencentcloudapi.com

Southwest China (Chongqing)domain.apchongqing.tencentcloudapi.com

Hong Kong, Macao, Taiwan (Hong Kong, China)

Southeast Asia (Singapore)©2013-2022 Tencent Cloud. All rights reserved.

domain.aphongkong.tencentcloudapi.com
domain.apsingapore.tencentcloudapi.com

Page 10 of 178

Domains

Southeast Asia (Bangkok)

domain.apbangkok.tencentcloudapi.com

South Asia (Mumbai)

domain.apmumbai.tencentcloudapi.com

Northeast Asia (Seoul)domain.ap-seoul.tencentcloudapi.com

Northeast Asia (Tokyo)

domain.ap-tokyo.tencentcloudapi.com

U.S. East Coast (Virginia)

domain.naashburn.tencentcloudapi.com

U.S. West Coast (Silicon Valley)
North America (Toronto)
Europe (Frankfurt)

domain.nasiliconvalley.tencentcloudapi.com
domain.na-toronto.tencentcloudapi.com
domain.eufrankfurt.tencentcloudapi.com

2. Communications Protocol
All the Tencent Cloud APIs communicate via HTTPS, providing highly secure communication tunnels.

3. Request Methods
Supported HTTP request methods:
POST (recommended)GETThe Content-Type types supported by POST requests:
application/json (recommended). The TC3-HMAC-SHA256 signature algorithm must be used.
application/x-www-form-urlencoded. The HmacSHA1 or HmacSHA256 signature algorithm must be used.
multipart/form-data (only supported by certain APIs). You must use TC3-HMAC-SHA256 to calculate the signature.
The size of a GET request packet is up to 32 KB. The size of a POST request is up to 1 MB when the HmacSHA1 or
HmacSHA256 signature algorithm is used, and up to 10 MB when TC3-HMAC-SHA256 is used.

©2013-2022 Tencent Cloud. All rights reserved.

Page 11 of 178

Domains

4. Character Encoding
Only UTF-8 encoding is used.

©2013-2022 Tencent Cloud. All rights reserved.

Page 12 of 178

Domains

Common Params：

Last updated 2023-03-28 10:48:33
Common parameters are used for all APIs authenticating requestors. Common parameters must be included in all API
requests, and they will not be described in individual API documents.
The exact contents of the common parameters will vary depending on the version of the signature method you use.

Common parameters for Signature Algorithm v3
When the TC3-HMAC-SHA256 algorithm is used, the common parameters should be uniformly placed in the HTTP
request header, as shown below:
Parameter
Name

Type

Required

Description
The name of the API for the desired operation. For the specific value, see

X-TC-Action

X-TCRegion

X-TCTimestamp

StringStringYes

Yes

description of common parameter Action in the input parameters in r
documentation. For example, the API for querying the CVM instance list is
DescribeInstances .
Region parameter, which is used to identify the region to which the data ywork with belongs. For values supported for an API, see the description oparameter Region in the input parameters in related API documentati
parameter is not required for some APIs (which will be indicated in related
documentation), and will not take effect even it is passed.

Integer

X-TCVersion

StringAuthorization

StringYes

Yes

The current UNIX timestamp that records the time when the API request w
for example, 1529223702. Note: If the difference between the UNIX times
server time is greater than 5 minutes, a signature expiration error may occ
API version of the action. For the valid values, see the description of the cparameter Version in the API documentation. For example, the versi
2017-03-12.

Yes

The HTTP authentication request header, for example:
TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/Date/service/tc3_requ
SignedHeaders=content-type;host,Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc96317
Here:- TC3-HMAC-SHA256: Signature method, currently fixed as this value;- Credential: Signature credential; AKIDEXAMPLE is the SecretId; Date is
UTC time, and this value must match the value of X-TC-Timestamp (a co©2013-2022 Tencent Cloud. All rights reserved.

Page 13 of 178

Domains

parameter) in UTC time format; service is the name of the product/service
generally a domain name prefix. For example, a domain name cvm.tencen
refers to the CVM product and the value would be cvm;
- SignedHeaders: The headers that contains the authentication informatio
type and host are the required headers;- Signature: Signature digest.

X-TC-Token

String

No

The token used for a temporary certificate. It must be used with a tempora
can obtain the temporary key and token by calling a CAM API. No token ia long-term key.

Assuming you want to query the list of Cloud Virtual Machine instances in the Guangzhou region, the request structurein the form of request URL, request header and request body may be as follows:
Example of an HTTP GET request structure:https://cvm.tencentcloudapi.com/?Limit=10&Offset=0
Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE/20
18-10-09/cvm/tc3_request, SignedHeaders=content-type;host, Signature=5da7a33f6993
f0614b047e5df4582db9e9bf4672ba50567dba16c6ccf174c474
Content-Type: application/x-www-form-urlencoded
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1539084154
X-TC-Region: ap-guangzhou
The following example shows you how to structure an HTTP POST (application/json) request:
https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/2018-05-30/cvm/tc3_request,
SignedHeaders=content-type;host, Signature=582c400e06b5924a6f2b5d7d672d79c15b1316
2d9279b0855cfba6789a8edb4c
Content-Type: application/json
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1527672334
X-TC-Region: ap-guangzhou{"Offset":0,"Limit":10}
Example of an HTTP POST (multipart/form-data) request structure (only supported by specific APIs):©2013-2022 Tencent Cloud. All rights reserved.

Page 14 of 178

Domains

https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/2018-05-30/cvm/tc3_request,
SignedHeaders=content-type;host, Signature=582c400e06b5924a6f2b5d7d672d79c15b1316
2d9279b0855cfba6789a8edb4c
Content-Type: multipart/form-data; boundary=58731222010402
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1527672334
X-TC-Region: ap-guangzhou--58731222010402
Content-Disposition: form-data; name="Offset"
0--58731222010402
Content-Disposition: form-data; name="Limit"
10--58731222010402--

Common parameters for Signature Algorithm v1
To adopt the HmacSHA1 and HmacSHA256 signature methods, common parameters must be put into the request
string, as shown below:
Parameter NameType

Required

Description
The name of the API for the desired operation. For the specificvalue, see the description of common parameter Action in the

ActionStringYes

input parameters in related API documentation. For example, theAPI for querying the CVM instance list is
DescribeInstances .
Region parameter, which is used to identify the region to which
the data you want to work with belongs. For values supported for
an API, see the description of common parameter Region in

RegionStringYes

the input parameters in related API documentation. Note: Thisparameter is not required for some APIs (which will be indicated inrelated API documentation), and will not take effect even if it ispassed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 15 of 178

Domains

Timestamp

IntegerYes

The current UNIX timestamp that records the time when the API
request was initiated, for example, 1529223702. If the difference
between the value and the current system time is too large, asignature expiration error may occur.
A random positive integer used along with Timestamp to

Nonce

Integer

Yes

SecretId

StringYes

The identifying SecretId obtained on the Cloud API Key page. A
SecretId corresponds to a unique SecretKey which is used togenerate the request signature (Signature).

Yes

Request signature used to verify the validity of this request. This iscalculated based on the actual input parameters. For more
information about how this is calculated, see the API
authentication documentation.

Signature

VersionStringStringYes

prevent replay attacks.

API version of the action. For the valid values, see the descriptionof the common input parameter Version in the API
documentation. For example, the version of CVM is 2017-03-12.

SignatureMethod

StringNo

Signature method. Currently, only HmacSHA256 and HmacSHA1
are supported. The HmacSHA256 algorithm is used to verify thesignature only when this parameter is specified as HmacSHA256.
In other cases, the signature is verified with HmacSHA1.

Token

String

No

The token used for a temporary certificate. It must be used with atemporary key. You can obtain the temporary key and token bycalling a CAM API. No token is required for a long-term key.

Assuming you want to query the list of Cloud Virtual Machine instances in the Guangzhou region, the request structurein the form of request URL, request header and request body may be as follows:
Example of an HTTP GET request structure:https://cvm.tencentcloudapi.com/?Action=DescribeInstances&Version=2017-03-12&Sign
atureMethod=HmacSHA256&Timestamp=1527672334&Signature=37ac2f4fde00b0ac9bd9eadeb45
9b1bbee224158d66e7ae5fcadb70b2d181d02&Region=ap-guangzhou&Nonce=23823223&SecretId=AKIDEXAMPLE
Host: cvm.tencentcloudapi.com
Content-Type: application/x-www-form-urlencoded
Example of an HTTP POST request structure:©2013-2022 Tencent Cloud. All rights reserved.

Page 16 of 178

Domains

https://cvm.tencentcloudapi.com/
Host: cvm.tencentcloudapi.com
Content-Type: application/x-www-form-urlencoded
Action=DescribeInstances&Version=2017-03-12&SignatureMethod=HmacSHA256&Timestamp=
1527672334&Signature=37ac2f4fde00b0ac9bd9eadeb459b1bbee224158d66e7ae5fcadb70b2d18
1d02&Region=ap-guangzhou&Nonce=23823223&SecretId=AKIDEXAMPLE©2013-2022 Tencent Cloud. All rights reserved.

Page 17 of 178

Domains

Signature v3：

Last updated 2023-03-28 10:48:33
TencentCloud API authenticates every single request, i.e., the request must be signed using the security credentials inthe designated steps. Each request has to contain the signature information (Signature) in the common request
parameters and be sent in the specified way and format.

Applying for Security Credentials
The security credential used in this document is a key, which includes a SecretId and a SecretKey. Each user canhave up to two pairs of keys.
SecretId: Used to identify the API caller, which is just like a username.
SecretKey: Used to authenticate the API caller, which is just like a password.
You must keep your security credentials private and avoid disclosure; otherwise, your assets may becompromised. If they are disclosed, please disable them as soon as possible.
You can apply for the security credentials through the following steps:
1. Log in to the Tencent Cloud Console.
2. Go to the TencentCloud API Key console page.
3. On the TencentCloud API Key page, click Create to create a SecretId/SecretKey pair.

Using the Resources for Developers
TencentCloud API comes with SDKs for seven commonly used programming languages, including Python, Java,
PHP, Go, NodeJS and .NET. In addition, it provides API Explorer which enables online call, signature verification, andSDK code generation. If you have any troubles calculating a signature, consult these resources.

TC3-HMAC-SHA256 Signature Algorithm
Compatible with the previous HmacSHA1 and HmacSHA256 signature algorithms, the TC3-HMAC-SHA256
signature algorithm is more secure and supports larger requests and JSON format with better performance. We
recommend using TC3-HMAC-SHA256 to calculate the signature.
TencentCloud API supports both GET and POST requests. For the GET method, only the Content-Type:application/x-www-form-urlencoded protocol format is supported. For the POST method, two protocol formats,©2013-2022 Tencent Cloud. All rights reserved.

Page 18 of 178

Domains

Content-Type: application/json and Content-Type: multipart/form-data, are supported. The JSON format is supported
by default for all business APIs, and the multipart format is supported only for specific business APIs. In this case, theAPI cannot be called in JSON format. See the specific business API documentation for more information. The POST
method is recommended, as there is no difference in the results of both the methods, but the GET method only
supports request packets up to 32 KB.
The following uses querying the list of CVM instances in the Guangzhou region as an example to describe the steps ofsignature splicing. We chose this API because:
1. CVM is activated by default, and this API is often used;
2. It is read-only and does not change the status of existing resources;
3. It covers many types of parameters, which allows it to be used to demonstrate how to use arrays containing data
structures.
In the example, we try to choose common parameters and API parameters that are prone to mistakes. When you
actually call an API, please use parameters based on the actual conditions. The parameters vary by API. Do not copy
the parameters and values in this example.
Assuming that your SecretId and SecretKey are AKIDz8krbsJ5yKBZQpn74WFkmLPx3******* andGu5t9xGARNpq86cd98joQYCN3******* , respectively, if you want to view the status of the instance in the
Guangzhou region whose CVM instance name is "unnamed" and have only one data entry returned, then the request
may be:curl -X POST https://cvm.tencentcloudapi.com \-H "Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/2019-02-25/cvm/tc3_request, SignedHeaders=content-type;host, Signature=c492e8e4
1437e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff" \-H "Content-Type: application/json; charset=utf-8" \-H "Host: cvm.tencentcloudapi.com" \-H "X-TC-Action: DescribeInstances" \-H "X-TC-Timestamp: 1551113065" \-H "X-TC-Version: 2017-03-12" \-H "X-TC-Region: ap-guangzhou" \-d '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}'The signature calculation process is explained in detail below.

1. Concatenating the CanonicalRequest String
Concatenate the canonical request string (CanonicalRequest) in the following pseudocode format:
CanonicalRequest =HTTPRequestMethod + '\n' +CanonicalURI + '\n' +©2013-2022 Tencent Cloud. All rights reserved.

Page 19 of 178

Domains

CanonicalQueryString + '\n' +CanonicalHeaders + '\n' +SignedHeaders + '\n' +HashedRequestPayload
Field Name

Explanation

HTTPRequestMethod

HTTP request method (GET or POST). This example uses POST .

CanonicalURI

URI parameter. Slash ("/") is used for API 3.0.
The query string in the URL of the originating HTTP request. This is always an empty st“” for POST requests, and is the string after the question mark (?) for GET requests. Fo

CanonicalQueryString。

example: Limit=10&Offset=0
Note: CanonicalQueryString must be URL-encoded, referencing RFC3986, theUTF8 character set. We recommend using the programming language library. All specia
characters must be encoded and capitalized.
Header information for signature calculation, including at least two headers of host
content-type . Custom headers can be added to participate in the signature proce
improve the uniqueness and security of the request.
Concatenation rules:
1. Both the key and value of the header should be converted to lowercase with the lead

CanonicalHeaders

and trailing spaces removed, so they are concatenated in the format of key:value\nformat;2. If there are multiple headers, they should be sorted in ASCII ascending order by theheader keys (lowercase).
The calculation result in this example is content-type:application/json;
charset=utf-8\nhost:cvm.tencentcloudapi.com\n .
Note: content-type must match the actually sent content. In some programming
languages, a charset value would be added even if it is not specified. In this case, therequest sent is different from the one signed, and the sever will return an error indicating
signature verification failed.
Header information for signature calculation, indicating which headers of the request
participate in the signature process (they must each individually correspond to the headin CanonicalHeaders). Content-type and host are required headers.

SignedHeaders

Concatenation rules:
1. Both the key and value of the header should be converted to lowercase;
2. If there are multiple headers, they should be sorted in ASCII ascending order by theheader keys (lowercase) and separated by semicolons (;).
The value in this example is content-type;hostHashedRequestPayload

Hash value of the request payload (i.e., the body, such as {"Limit": 1, "Filter©2013-2022 Tencent Cloud. All rights reserved.

Page 20 of 178

Domains[{"Values": ["unnamed"], "Name": "instance-name"}]} in this example
The pseudocode for calculation is
Lowercase(HexEncode(Hash.SHA256(RequestPayload))) by SHA256 hashing the payof the HTTP request, performing hexadecimal encoding, and finally converting the enco
string to lowercase letters. For GET requests, RequestPayload is always an empt
string. The calculation result in this example is
99d58dfbc6745f6747f36bfca17dee5e6881dc0428a0a36f96199342bc5b49

According to the rules above, the CanonicalRequest string obtained in the example is as follows:

POST/
content-type:application/json; charset=utf-8
host:cvm.tencentcloudapi.com
content-type;host
99d58dfbc6745f6747f36bfca17dee5e6881dc0428a0a36f96199342bc5b4907

2. Concatenating the String to Be Signed
The string to sign is concatenated as follows:
StringToSign =Algorithm + \n +RequestTimestamp + \n +CredentialScope + \n +HashedCanonicalRequest
Field Name

Explanation

Algorithm

Signature algorithm, which is currently always TC3-HMAC-SHA256 .
Request timestamp, i.e., the value of the common parameter X-TC-Timestamp in

RequestTimestamp

request header, which is the UNIX timestamp of the current time in seconds, such as1551113065 in this example.
Scope of the credential in the format of Date/service/tc3_request , including
date, requested service and termination string (tc3_request). Date is a date in UT

CredentialScopetime, whose value should match the UTC date converted by the common
parameter X-TC-Timestamp ; service is the product name, which should mthe domain name of the product called. The calculation result in this example is 201
25/cvm/tc3_request .

©2013-2022 Tencent Cloud. All rights reserved.

Page 21 of 178

Domains

HashedCanonicalRequest

Hash value of the CanonicalRequest string concatenated in the steps above. The
pseudocode for calculation is Lowercase(HexEncode(Hash.SHA256(CanonicalRequ
The calculation result in this example is2815843035062fffda5fd6f2a44ea8a34818b0dc46f024b8b3786976a3ad

Note:

1. Date has to be calculated from the timestamp "X-TC-Timestamp" and the time zone is UTC+0. If you add
the system's local time zone information (such as UTC+8), calls can succeed both day and night but willdefinitely fail at 00:00. For example, if the timestamp is 1551113065 and the time in UTC+8 is 2019-02-26
00:44:25, the UTC+0 date in the calculated Date value should be 2019-02-25 instead of 2019-02-26.
2. Timestamp must be the same as your current system time, and your system time and standard time must be
synced; if the difference between Timestamp and your current system time is larger than five minutes, therequest will fail. If your system time is out of sync with the standard time for a while, the request will fail andreturn a signature expiration error.

According to the preceding rules, the string to be signed obtained in the example is as follows:
TC3-HMAC-SHA256
1551113065
2019-02-25/cvm/tc3_request
2815843035062fffda5fd6f2a44ea8a34818b0dc46f024b8b3786976a3adda7a

3. Calculating the Signature
1. Calculate the derived signature key with the following pseudocode:

SecretKey = "Gu5t9xGARNpq86cd98joQYCN3*******"
SecretDate = HMAC_SHA256("TC3" + SecretKey, Date)
SecretService = HMAC_SHA256(SecretDate, Service)
SecretSigning = HMAC_SHA256(SecretService, "tc3_request")
Field Name

Explanation

SecretKey

The original SecretKey, i.e., Gu5t9xGARNpq86cd98joQYCN3******* .

Date

The Date field information in Credential , such as 2019-02-25 in this example.

©2013-2022 Tencent Cloud. All rights reserved.

Page 22 of 178

Domains

Service

Value in the Service field in Credential , such as cvm in this example.

2. Calculate the signature with the following pseudocode:

Signature = HexEncode(HMAC_SHA256(SecretSigning, StringToSign))

4. Concatenating the Authorization
The Authorization is concatenated as follows:

Authorization =Algorithm + ' ' +'Credential=' + SecretId + '/' + CredentialScope + ', ' +'SignedHeaders=' + SignedHeaders + ', ' +'Signature=' + Signature
Field Name

Explanation

Algorithm

Signature algorithm, which is always TC3-HMAC-SHA256 .

SecretId

The SecretId in the key pair, i.e., AKIDz8krbsJ5yKBZQpn74WFkmLPx3******* .

CredentialScope

SignedHeadersSignature

Credential scope (see above). The calculation result in this example is 2019-0225/cvm/tc3_request .
Header information for signature calculation (see above), such as content-type;hostin this example.
Signature value. The calculation result in this example isc492e8e41437e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff .

According to the rules above, the value obtained in the example is:TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/2019-02-25/cvm/tc
3_request, SignedHeaders=content-type;host, Signature=c492e8e41437e97a620b728c301
bb8d17e7dc0c17eeabce80c20cd70fc3a78ff
The following example shows a finished authorization header:
POST https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/20
19-02-25/cvm/tc3_request, SignedHeaders=content-type;host, Signature=c492e8e41437
e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff©2013-2022 Tencent Cloud. All rights reserved.

Page 23 of 178

Domains

Content-Type: application/json; charset=utf-8
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1551113065
X-TC-Region: ap-guangzhou{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}5. Signature Demo
When calling API 3.0, you are recommended to use the corresponding Tencent Cloud SDK 3.0 which encapsulates
the signature process, enabling you to focus on only the specific APIs provided by the product when developing. See
SDK Center for more information. Currently, the following programming languages are supported:
PythonJava
PHP
Go
NodeJS.NET
To further explain the signing process, we will use a programming language to implement the process describedabove. The request domain name, API and parameter values in the sample are used here. This goal of this example isonly to provide additional clarification for the signature process, please see the SDK for actual usage.
The final output URL might be: https://cvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=apguangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Signature=EliP9YW3pW28FpsEdkXt%2F%2B
WcGeI%3D&Timestamp=1465185768&Version=2017-03-12.
Note: The key in the example is fictitious, and the timestamp is not the current time of the system, so if this URL is
opened in the browser or called using commands such as curl, an authentication error will be returned: Signature
expired. In order to get a URL that can work properly, you need to replace the SecretId and SecretKey in the example
with your real credentials and use the current time of the system as the Timestamp.
Note: In the example below, even if you use the same programming language, the order of the parameters in the URL
may be different for each execution. However, the order does not matter, as long as all the parameters are included in
the URL and the signature is calculated correctly.
Note: The following code is only applicable to API 3.0. It cannot be directly used in other signature processes. Even
with an older API, signature calculation errors may occur due to the differences in details. Please refer to thecorresponding documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 24 of 178

Domains

Java
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
import java.util.TreeMap;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import javax.xml.bind.DatatypeConverter;
public class TencentCloudAPITC3Demo {private final static Charset UTF8 = StandardCharsets.UTF_8;
private final static String SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
private final static String SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
private final static String CT_JSON = "application/json; charset=utf-8";
public static byte[] hmac256(byte[] key, String msg) throws Exception {Mac mac = Mac.getInstance("HmacSHA256");
SecretKeySpec secretKeySpec = new SecretKeySpec(key, mac.getAlgorithm());
mac.init(secretKeySpec);
return mac.doFinal(msg.getBytes(UTF8));}
public static String sha256Hex(String s) throws Exception {MessageDigest md = MessageDigest.getInstance("SHA-256");
byte[] d = md.digest(s.getBytes(UTF8));
return DatatypeConverter.printHexBinary(d).toLowerCase();}public static void main(String[] args) throws Exception {String service = "cvm";
String host = "cvm.tencentcloudapi.com";
String region = "ap-guangzhou";String action = "DescribeInstances";
String version = "2017-03-12";
String algorithm = "TC3-HMAC-SHA256";
String timestamp = "1551113065";//String timestamp = String.valueOf(System.currentTimeMillis() / 1000);
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");// Pay attention to the time zone; otherwise, errors may occur
sdf.setTimeZone(TimeZone.getTimeZone("UTC"));
String date = sdf.format(new Date(Long.valueOf(timestamp + "000")));// ************* Step 1: Concatenate the CanonicalRequest string *************©2013-2022 Tencent Cloud. All rights reserved.

Page 25 of 178

Domains

String httpRequestMethod = "POST";
String canonicalUri = "/";
String canonicalQueryString = "";String canonicalHeaders = "content-type:application/json; charset=utf-8\n" + "host:" + host + "\n";String signedHeaders = "content-type;host";
String payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}";
String hashedRequestPayload = sha256Hex(payload);
String canonicalRequest = httpRequestMethod + "\n" + canonicalUri + "\n" + canoni
calQueryString + "\n"+ canonicalHeaders + "\n" + signedHeaders + "\n" + hashedRequestPayload;
System.out.println(canonicalRequest);// ************* Step 2: Concatenate the string to sign *************
String credentialScope = date + "/" + service + "/" + "tc3_request";
String hashedCanonicalRequest = sha256Hex(canonicalRequest);
String stringToSign = algorithm + "\n" + timestamp + "\n" + credentialScope +"\n" + hashedCanonicalRequest;
System.out.println(stringToSign);// ************* Step 3: Calculate the signature *************
byte[] secretDate = hmac256(("TC3" + SECRET_KEY).getBytes(UTF8), date);byte[] secretService = hmac256(secretDate, service);byte[] secretSigning = hmac256(secretService, "tc3_request");String signature = DatatypeConverter.printHexBinary(hmac256(secretSigning, string
ToSign)).toLowerCase();
System.out.println(signature);// ************* Step 4: Concatenate the Authorization *************
String authorization = algorithm + " " + "Credential=" + SECRET_ID + "/" + creden
tialScope + ", "+ "SignedHeaders=" + signedHeaders + ", " + "Signature=" + signature;
System.out.println(authorization);
TreeMap<String, String> headers = new TreeMap<String, String>();headers.put("Authorization", authorization);headers.put("Content-Type", CT_JSON);headers.put("Host", host);
headers.put("X-TC-Action", action);headers.put("X-TC-Timestamp", timestamp);
headers.put("X-TC-Version", version);headers.put("X-TC-Region", region);
StringBuilder sb = new StringBuilder();sb.append("curl -X POST https://").append(host)©2013-2022 Tencent Cloud. All rights reserved.

Page 26 of 178

Domains.append(" -H \"Authorization: ").append(authorization).append("\"").append(" -H \"Content-Type: application/json; charset=utf-8\"").append(" -H \"Host: ").append(host).append("\"").append(" -H \"X-TC-Action: ").append(action).append("\"").append(" -H \"X-TC-Timestamp: ").append(timestamp).append("\"").append(" -H \"X-TC-Version: ").append(version).append("\"").append(" -H \"X-TC-Region: ").append(region).append("\"").append(" -d '").append(payload).append("'");
System.out.println(sb.toString());}}

Python# -*- coding: utf-8 -*import hashlib, hmac, json, os, sys, timefrom datetime import datetime# Key Parameters
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"
service = "cvm"host = "cvm.tencentcloudapi.com"
endpoint = "https://" + hostregion = "ap-guangzhou"
action = "DescribeInstances"version = "2017-03-12"
algorithm = "TC3-HMAC-SHA256"#timestamp = int(time.time())
timestamp = 1551113065
date = datetime.utcfromtimestamp(timestamp).strftime("%Y-%m-%d")params = {"Limit": 1, "Filters": [{"Name": "instance-name", "Values": ["unnamed"]}]}# ************* Step 1: Concatenate the CanonicalRequest string *************
http_request_method = "POST"
canonical_uri = "/"canonical_querystring = ""ct = "application/json; charset=utf-8"
payload = json.dumps(params)
canonical_headers = "content-type:%s\nhost:%s\n" % (ct, host)signed_headers = "content-type;host"hashed_request_payload = hashlib.sha256(payload.encode("utf-8")).hexdigest()
canonical_request = (http_request_method + "\n" +canonical_uri + "\n" +©2013-2022 Tencent Cloud. All rights reserved.

Page 27 of 178

Domains

canonical_querystring + "\n" +canonical_headers + "\n" +signed_headers + "\n" +hashed_request_payload)
print(canonical_request)# ************* Step 2: Concatenate the string to sign *************
credential_scope = date + "/" + service + "/" + "tc3_request"
hashed_canonical_request = hashlib.sha256(canonical_request.encode("utf-8")).hexd
igest()
string_to_sign = (algorithm + "\n" +str(timestamp) + "\n" +credential_scope + "\n" +hashed_canonical_request)
print(string_to_sign)# ************* Step 3: Calculate the Signature *************# Function for computing signature digest
def sign(key, msg):
return hmac.new(key, msg.encode("utf-8"), hashlib.sha256).digest()
secret_date = sign(("TC3" + secret_key).encode("utf-8"), date)secret_service = sign(secret_date, service)secret_signing = sign(secret_service, "tc3_request")
signature = hmac.new(secret_signing, string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
print(signature)# ************* Step 4: Concatenate the Authorization *************
authorization = (algorithm + " " +"Credential=" + secret_id + "/" + credential_scope + ", " +"SignedHeaders=" + signed_headers + ", " +"Signature=" + signature)
print(authorization)
print('curl -X POST ' + endpoint+ ' -H "Authorization: ' + authorization + '"'+ ' -H "Content-Type: application/json; charset=utf-8"'+ ' -H "Host: ' + host + '"'+ ' -H "X-TC-Action: ' + action + '"'+ ' -H "X-TC-Timestamp: ' + str(timestamp) + '"'+ ' -H "X-TC-Version: ' + version + '"'+ ' -H "X-TC-Region: ' + region + '"'+ " -d '" + payload + "'")

Golang©2013-2022 Tencent Cloud. All rights reserved.

Page 28 of 178

Domains

package main
import ("crypto/hmac""crypto/sha256""encoding/hex""fmt""time")
func sha256hex(s string) string {b := sha256.Sum256([]byte(s))
return hex.EncodeToString(b[:])}func hmacsha256(s, key string) string {hashed := hmac.New(sha256.New, []byte(key))hashed.Write([]byte(s))
return string(hashed.Sum(nil))}func main() {secretId := "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secretKey := "Gu5t9xGARNpq86cd98joQYCN3*******"
host := "cvm.tencentcloudapi.com"
algorithm := "TC3-HMAC-SHA256"
service := "cvm"version := "2017-03-12"
action := "DescribeInstances"
region := "ap-guangzhou"//var timestamp int64 = time.Now().Unix()
var timestamp int64 = 1551113065// step 1: build canonical request string
httpRequestMethod := "POST"
canonicalURI := "/"canonicalQueryString := ""canonicalHeaders := "content-type:application/json; charset=utf-8\n" + "host:" +host + "\n"signedHeaders := "content-type;host"
payload := `{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}`
hashedRequestPayload := sha256hex(payload)
canonicalRequest := fmt.Sprintf("%s\n%s\n%s\n%s\n%s\n%s",
httpRequestMethod,
canonicalURI,©2013-2022 Tencent Cloud. All rights reserved.

Page 29 of 178

Domains

canonicalQueryString,canonicalHeaders,signedHeaders,hashedRequestPayload)
fmt.Println(canonicalRequest)// step 2: build string to sign
date := time.Unix(timestamp, 0).UTC().Format("2006-01-02")
credentialScope := fmt.Sprintf("%s/%s/tc3_request", date, service)hashedCanonicalRequest := sha256hex(canonicalRequest)
string2sign := fmt.Sprintf("%s\n%d\n%s\n%s",
algorithm,
timestamp,
credentialScope,
hashedCanonicalRequest)
fmt.Println(string2sign)// step 3: sign string
secretDate := hmacsha256(date, "TC3"+secretKey)
secretService := hmacsha256(service, secretDate)secretSigning := hmacsha256("tc3_request", secretService)signature := hex.EncodeToString([]byte(hmacsha256(string2sign, secretSigning)))
fmt.Println(signature)// step 4: build authorization
authorization := fmt.Sprintf("%s Credential=%s/%s, SignedHeaders=%s, Signature=%s",algorithm,
secretId,
credentialScope,
signedHeaders,signature)
fmt.Println(authorization)
curl := fmt.Sprintf(`curl -X POST https://%s\-H "Authorization: %s"\
-H "Content-Type: application/json; charset=utf-8"\-H "Host: %s" -H "X-TC-Action: %s"\
-H "X-TC-Timestamp: %d"\
-H "X-TC-Version: %s"\
-H "X-TC-Region: %s"\-d '%s'`, host, authorization, host, action, timestamp, version, region, payload)
fmt.Println(curl)}

PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 30 of 178

Domains<?php$secretId = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";$secretKey = "Gu5t9xGARNpq86cd98joQYCN3*******";$host = "cvm.tencentcloudapi.com";$service = "cvm";$version = "2017-03-12";$action = "DescribeInstances";$region = "ap-guangzhou";// $timestamp = time();$timestamp = 1551113065;$algorithm = "TC3-HMAC-SHA256";// step 1: build canonical request string$httpRequestMethod = "POST";$canonicalUri = "/";
$canonicalQueryString = "";$canonicalHeaders = "content-type:application/json; charset=utf-8\n"."host:".$host."\n";$signedHeaders = "content-type;host";$payload = '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}';$hashedRequestPayload = hash("SHA256", $payload);$canonicalRequest = $httpRequestMethod."\n".$canonicalUri."\n".$canonicalQueryString."\n".$canonicalHeaders."\n".$signedHeaders."\n".$hashedRequestPayload;
echo $canonicalRequest.PHP_EOL;// step 2: build string to sign
$date = gmdate("Y-m-d", $timestamp);$credentialScope = $date."/".$service."/tc3_request";$hashedCanonicalRequest = hash("SHA256", $canonicalRequest);$stringToSign = $algorithm."\n".$timestamp."\n".$credentialScope."\n".$hashedCanonicalRequest;
echo $stringToSign.PHP_EOL;// step 3: sign string$secretDate = hash_hmac("SHA256", $date, "TC3".$secretKey, true);$secretService = hash_hmac("SHA256", $service, $secretDate, true);$secretSigning = hash_hmac("SHA256", "tc3_request", $secretService, true);$signature = hash_hmac("SHA256", $stringToSign, $secretSigning);
echo $signature.PHP_EOL;©2013-2022 Tencent Cloud. All rights reserved.

Page 31 of 178

Domains// step 4: build authorization$authorization = $algorithm." Credential=".$secretId."/".$credentialScope.", SignedHeaders=content-type;host, Signature=".$signature;echo $authorization.PHP_EOL;$curl = "curl -X POST https://".$host.' -H "Authorization: '.$authorization.'"'.' -H "Content-Type: application/json; charset=utf-8"'.' -H "Host: '.$host.'"'.' -H "X-TC-Action: '.$action.'"'.' -H "X-TC-Timestamp: '.$timestamp.'"'.' -H "X-TC-Version: '.$version.'"'.' -H "X-TC-Region: '.$region.'"'." -d '".$payload."'";
echo $curl.PHP_EOL;

Ruby# -*- coding: UTF-8 -*# require ruby>=2.3.0
require 'digest'
require 'json'
require 'time'require 'openssl'# Key Parameters
secret_id = 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******'
secret_key = 'Gu5t9xGARNpq86cd98joQYCN3*******'
service = 'cvm'
host = 'cvm.tencentcloudapi.com'
endpoint = 'https://' + hostregion = 'ap-guangzhou'
action = 'DescribeInstances'version = '2017-03-12'
algorithm = 'TC3-HMAC-SHA256'# timestamp = Time.now.to_i
timestamp = 1551113065
date = Time.at(timestamp).utc.strftime('%Y-%m-%d')# ************* Step 1: Concatenate the CanonicalRequest string *************
http_request_method = 'POST'
canonical_uri = '/'canonical_querystring = ''©2013-2022 Tencent Cloud. All rights reserved.

Page 32 of 178

Domains

canonical_headers = "content-type:application/json; charset=utf-8\nhost:#{host}\n"signed_headers = 'content-type;host'# params = { 'Limit' => 1, 'Filters' => [{ 'Name' => 'instance-name', 'Values' =>['unnamed'] }] }# payload = JSON.generate(params, { 'ascii_only' => true, 'space' => ' ' })# json will generate in random order, to get specified result in example, we hard-code it here.
payload = '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}'
hashed_request_payload = Digest::SHA256.hexdigest(payload)
canonical_request = [http_request_method,
canonical_uri,canonical_querystring,canonical_headers,signed_headers,hashed_request_payload,].join("\n")puts canonical_request# ************* Step 2: Concatenate the string to sign *************
credential_scope = date + '/' + service + '/' + 'tc3_request'
hashed_request_payload = Digest::SHA256.hexdigest(canonical_request)
string_to_sign = [algorithm,
timestamp.to_s,
credential_scope,
hashed_request_payload,].join("\n")puts string_to_sign# ************* Step 3: Calculate the Signature *************
digest = OpenSSL::Digest.new('sha256')secret_date = OpenSSL::HMAC.digest(digest, 'TC3' + secret_key, date)secret_service = OpenSSL::HMAC.digest(digest, secret_date, service)secret_signing = OpenSSL::HMAC.digest(digest, secret_service, 'tc3_request')
signature = OpenSSL::HMAC.hexdigest(digest, secret_signing, string_to_sign)
puts signature# ************* Step 4: Concatenate the Authorization *************
authorization = "#{algorithm} Credential=#{secret_id}/#{credential_scope}, Signed
Headers=#{signed_headers}, Signature=#{signature}"puts authorization
puts 'curl -X POST ' + endpoint \©2013-2022 Tencent Cloud. All rights reserved.

Page 33 of 178

Domains+ ' -H "Authorization: ' + authorization + '"' \+ ' -H "Content-Type: application/json; charset=utf-8"' \+ ' -H "Host: ' + host + '"' \+ ' -H "X-TC-Action: ' + action + '"' \+ ' -H "X-TC-Timestamp: ' + timestamp.to_s + '"' \+ ' -H "X-TC-Version: ' + version + '"' \+ ' -H "X-TC-Region: ' + region + '"' \+ " -d '" + payload + "'"DotNetusing System;
using System.Collections.Generic;using System.Security.Cryptography;
using System.Text;
public class Application{
public static string SHA256Hex(string s){
using (SHA256 algo = SHA256.Create()){
byte[] hashbytes = algo.ComputeHash(Encoding.UTF8.GetBytes(s));
StringBuilder builder = new StringBuilder();for (int i = 0; i < hashbytes.Length; ++i){
builder.Append(hashbytes[i].ToString("x2"));}
return builder.ToString();}}
public static byte[] HmacSHA256(byte[] key, byte[] msg){
using (HMACSHA256 mac = new HMACSHA256(key)){
return mac.ComputeHash(msg);}}
public static Dictionary<String, String> BuildHeaders(string secretid,
string secretkey, string service, string endpoint, string region,
string action, string version, DateTime date, string requestPayload){
string datestr = date.ToString("yyyy-MM-dd");
DateTime startTime = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc);
long requestTimestamp = (long)Math.Round((date - startTime).TotalMilliseconds, Mi©2013-2022 Tencent Cloud. All rights reserved.

Page 34 of 178

Domains

dpointRounding.AwayFromZero) / 1000;// ************* Step 1: Concatenate the CanonicalRequest string *************
string algorithm = "TC3-HMAC-SHA256";
string httpRequestMethod = "POST";
string canonicalUri = "/";
string canonicalQueryString = "";string contentType = "application/json";string canonicalHeaders = "content-type:" + contentType + "; charset=utf-8\n" +"host:" + endpoint + "\n";string signedHeaders = "content-type;host";
string hashedRequestPayload = SHA256Hex(requestPayload);string canonicalRequest = httpRequestMethod + "\n"+ canonicalUri + "\n"+ canonicalQueryString + "\n"+ canonicalHeaders + "\n"+ signedHeaders + "\n"+ hashedRequestPayload;
Console.WriteLine(canonicalRequest);
Console.WriteLine("----------------------------------");// ************ Step 2: Concatenate the string to sign *************
string credentialScope = datestr + "/" + service + "/" + "tc3_request";
string hashedCanonicalRequest = SHA256Hex(canonicalRequest);
string stringToSign = algorithm + "\n" + requestTimestamp.ToString() + "\n" + cre
dentialScope + "\n" + hashedCanonicalRequest;
Console.WriteLine(stringToSign);
Console.WriteLine("----------------------------------");// ************* Step 3: Calculate the signature *************
byte[] tc3SecretKey = Encoding.UTF8.GetBytes("TC3" + secretkey);byte[] secretDate = HmacSHA256(tc3SecretKey, Encoding.UTF8.GetBytes(datestr));byte[] secretService = HmacSHA256(secretDate, Encoding.UTF8.GetBytes(service));byte[] secretSigning = HmacSHA256(secretService, Encoding.UTF8.GetBytes("tc3_request"));
byte[] signatureBytes = HmacSHA256(secretSigning, Encoding.UTF8.GetBytes(stringTo
Sign));
string signature = BitConverter.ToString(signatureBytes).Replace("-", "").ToLower();
Console.WriteLine(signature);
Console.WriteLine("----------------------------------");// ************* Step 4: Concatenate the Authorization *************
string authorization = algorithm + " "+ "Credential=" + secretid + "/" + credentialScope + ", "+ "SignedHeaders=" + signedHeaders + ", "+ "Signature=" + signature;
Console.WriteLine(authorization);©2013-2022 Tencent Cloud. All rights reserved.

Page 35 of 178

Domains

Console.WriteLine("----------------------------------");
Dictionary<string, string> headers = new Dictionary<string, string>();headers.Add("Authorization", authorization);headers.Add("Host", endpoint);
headers.Add("Content-Type", contentType + "; charset=utf-8");
headers.Add("X-TC-Timestamp", requestTimestamp.ToString());
headers.Add("X-TC-Version", version);headers.Add("X-TC-Action", action);headers.Add("X-TC-Region", region);
return headers;}public static void Main(string[] args){// SecretID and SecretKey
string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string service = "cvm";
string endpoint = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";// The timestamp `2019-02-26 00:44:25` used here is only for reference. In a proj
ect, use the following parameter:// DateTime date = DateTime.UtcNow;// Enter the correct time zone. We recommend using UTC timestamp to avoid errors.
DateTime date = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc).AddSeconds(1551113065);
string requestPayload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"\\u672a\\u5
47d\\u540d\"], \"Name\": \"instance-name\"}]}";
Dictionary<string, string> headers = BuildHeaders(SECRET_ID, SECRET_KEY, service, endpoint, region, action, version, date, requestPayload);
Console.WriteLine("POST https://cvm.tencentcloudapi.com");foreach (KeyValuePair<string, string> kv in headers){Console.WriteLine(kv.Key + ": " + kv.Value);}
Console.WriteLine();Console.WriteLine(requestPayload);}}©2013-2022 Tencent Cloud. All rights reserved.

Page 36 of 178

Domains

NodeJS
const crypto = require('crypto');function sha256(message, secret = '', encoding) {const hmac = crypto.createHmac('sha256', secret)return hmac.update(message).digest(encoding)}
function getHash(message, encoding = 'hex') {const hash = crypto.createHash('sha256')
return hash.update(message).digest(encoding)}
function getDate(timestamp) {const date = new Date(timestamp * 1000)
const year = date.getUTCFullYear()const month = ('0' + (date.getUTCMonth() + 1)).slice(-2)
const day = ('0' + date.getUTCDate()).slice(-2)
return `${year}-${month}-${day}`}function main(){const SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
const SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******"
const endpoint = "cvm.tencentcloudapi.com"
const service = "cvm"
const region = "ap-guangzhou"
const action = "DescribeInstances"
const version = "2017-03-12"//const timestamp = getTime()
const timestamp = 1551113065
const date = getDate(timestamp)// ************* Step 1: Concatenate the CanonicalRequest string *************
const signedHeaders = "content-type;host"const payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}"
const hashedRequestPayload = getHash(payload);
const httpRequestMethod = "POST"
const canonicalUri = "/"const canonicalQueryString = ""const canonicalHeaders = "content-type:application/json; charset=utf-8\n" + "host:" + endpoint + "\n"const canonicalRequest = httpRequestMethod + "\n"©2013-2022 Tencent Cloud. All rights reserved.

Page 37 of 178

Domains+ canonicalUri + "\n"+ canonicalQueryString + "\n"+ canonicalHeaders + "\n"+ signedHeaders + "\n"+ hashedRequestPayload
console.log(canonicalRequest)
console.log("----------------------------")// ************* Step 2: Concatenate the string to sign *************
const algorithm = "TC3-HMAC-SHA256"
const hashedCanonicalRequest = getHash(canonicalRequest);
const credentialScope = date + "/" + service + "/" + "tc3_request"
const stringToSign = algorithm + "\n" +timestamp + "\n" +credentialScope + "\n" +hashedCanonicalRequest
console.log(stringToSign)
console.log("----------------------------")// ************* Step 3: Calculate the signature *************
const kDate = sha256(date, 'TC3' + SECRET_KEY)
const kService = sha256(service, kDate)
const kSigning = sha256('tc3_request', kService)
const signature = sha256(stringToSign, kSigning, 'hex')
console.log(signature)
console.log("----------------------------")// ************* Step 4: Concatenate the Authorization *************
const authorization = algorithm + " " +"Credential=" + SECRET_ID + "/" + credentialScope + ", " +"SignedHeaders=" + signedHeaders + ", " +"Signature=" + signature
console.log(authorization)
console.log("----------------------------")
const Call_Information = 'curl -X POST ' + "https://" + endpoint+ ' -H "Authorization: ' + authorization + '"'+ ' -H "Content-Type: application/json; charset=utf-8"'+ ' -H "Host: ' + endpoint + '"'+ ' -H "X-TC-Action: ' + action + '"'+ ' -H "X-TC-Timestamp: ' + timestamp.toString() + '"'+ ' -H "X-TC-Version: ' + version + '"'+ ' -H "X-TC-Region: ' + region + '"'+ " -d '" + payload + "'"console.log(Call_Information)}main()©2013-2022 Tencent Cloud. All rights reserved.

Page 38 of 178

Domains

C++#include <iostream>#include <iomanip>#include <sstream>#include <string>#include <stdio.h>#include <time.h>#include <openssl/sha.h>#include <openssl/hmac.h>using namespace std;
string get_data(int64_t &timestamp){
string utcDate;char buff[20] = {0};// time_t timenow;
struct tm sttime;
sttime = *gmtime(&timestamp);
strftime(buff, sizeof(buff), "%Y-%m-%d", &sttime);
utcDate = string(buff);
return utcDate;}string int2str(int64_t n){
std::stringstream ss;
ss << n;return ss.str();}string sha256Hex(const string &str){
char buf[3];unsigned char hash[SHA256_DIGEST_LENGTH];
SHA256_CTX sha256;
SHA256_Init(&sha256);
SHA256_Update(&sha256, str.c_str(), str.size());
SHA256_Final(hash, &sha256);
std::string NewString = "";for(int i = 0; i < SHA256_DIGEST_LENGTH; i++){snprintf(buf, sizeof(buf), "%02x", hash[i]);NewString = NewString + buf;}
return NewString;©2013-2022 Tencent Cloud. All rights reserved.

Page 39 of 178

Domains}
string HmacSha256(const string &key, const string &input){
unsigned char hash[32];
HMAC_CTX *h;#if OPENSSL_VERSION_NUMBER < 0x10100000L
HMAC_CTX hmac;
HMAC_CTX_init(&hmac);h = &hmac;#else
h = HMAC_CTX_new();#endif
HMAC_Init_ex(h, &key[0], key.length(), EVP_sha256(), NULL);
HMAC_Update(h, ( unsigned char* )&input[0], input.length());
unsigned int len = 32;
HMAC_Final(h, hash, &len);#if OPENSSL_VERSION_NUMBER < 0x10100000L
HMAC_CTX_cleanup(h);#else
HMAC_CTX_free(h);#endif
std::stringstream ss;
ss << std::setfill('0');for (int i = 0; i < len; i++){ss << hash[i];}return (ss.str());}
string HexEncode(const string &input){
static const char* const lut = "0123456789abcdef";
size_t len = input.length();string output;
output.reserve(2 * len);for (size_t i = 0; i < len; ++i){
const unsigned char c = input[i];output.push_back(lut[c >> 4]);
output.push_back(lut[c & 15]);}©2013-2022 Tencent Cloud. All rights reserved.

Page 40 of 178

Domains

return output;}
int main(){string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string service = "cvm";
string host = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";
int64_t timestamp = 1551113065;
string date = get_data(timestamp);// ************* Step 1: Concatenate the CanonicalRequest string *************
string httpRequestMethod = "POST";
string canonicalUri = "/";
string canonicalQueryString = "";string canonicalHeaders = "content-type:application/json; charset=utf-8\nhost:" +host + "\n";string signedHeaders = "content-type;host";
string payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}";
string hashedRequestPayload = sha256Hex(payload);string canonicalRequest = httpRequestMethod + "\n" + canonicalUri + "\n" + canoni
calQueryString + "\n"+ canonicalHeaders + "\n" + signedHeaders + "\n" + hashedRequestPayload;cout << canonicalRequest << endl;
cout << "-----------------------" << endl;// ************* Step 2: Concatenate the string to sign *************
string algorithm = "TC3-HMAC-SHA256";
string RequestTimestamp = int2str(timestamp);
string credentialScope = date + "/" + service + "/" + "tc3_request";
string hashedCanonicalRequest = sha256Hex(canonicalRequest);
string stringToSign = algorithm + "\n" + RequestTimestamp + "\n" + credentialScop
e + "\n" + hashedCanonicalRequest;
cout << stringToSign << endl;
cout << "-----------------------" << endl;// ************* Step 3: Calculate the signature ***************
string kKey = "TC3" + SECRET_KEY;
string kDate = HmacSha256(kKey, date);
string kService = HmacSha256(kDate, service);
string kSigning = HmacSha256(kService, "tc3_request");©2013-2022 Tencent Cloud. All rights reserved.

Page 41 of 178

Domains

string signature = HexEncode(HmacSha256(kSigning, stringToSign));cout << signature << endl;
cout << "-----------------------" << endl;// ************* Step 4: Concatenate the Authorization *************
string authorization = algorithm + " " + "Credential=" + SECRET_ID + "/" + creden
tialScope + ", "+ "SignedHeaders=" + signedHeaders + ", " + "Signature=" + signature;cout << authorization << endl;
cout << "------------------------" << endl;
string headers = "curl -X POST https://" + host + "\n"+ " -H \"Authorization: " + authorization + "\n"+ " -H \"Content-Type: application/json; charset=utf-8\"" + "\n"+ " -H \"Host: " + host + "\n"+ " -H \"X-TC-Action: " + action + "\n"+ " -H \"X-TC-Timestamp: " + RequestTimestamp + "\n"+ " -H \"X-TC-Version: " + version + "\n"+ " -H \"X-TC-Region: " + region + "\n"+ " -d '" + payload;cout << headers << endl;
return 0;};

Signature Failure
The following situational error codes for signature failure may occur. Please resolve the errors accordingly.
Error CodeDescription

AuthFailure.SignatureExpire

Signature expired. Timestamp and server time cannot differ by more than fiveminutes.

AuthFailure.SecretIdNotFoundThe key does not exist. Please go to the console to check whether it isdisabled or you copied fewer or more characters.

AuthFailure.SignatureFailure

Signature error. It is possible that the signature was calculated incorrectly, thesignature does not match the content actually sent, or the SecretKey isincorrect.

AuthFailure.TokenFailure

Temporary certificate token error.

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

©2013-2022 Tencent Cloud. All rights reserved.

Page 42 of 178

Domains

Signature：

Last updated 2023-03-28 10:48:33
Tencent Cloud API authenticates each access request, i.e. each request needs to include authentication information(Signature) in the common parameters to verify the identity of the requester.
The Signature is generated by the security credentials which include SecretId and SecretKey. If you don't have thesecurity credentials yet, go to the TencentCloud API Key page to apply for them; otherwise, you cannot invoke theTencentCloud API.

1. Applying for Security Credentials
Before using the TencentCloud API for the first time, go to the TencentCloud API Key page to apply for security
credentials.
Security credentials consist of SecretId and SecretKey:
SecretId is used to identify the API requester.
SecretKey is used to encrypt the signature string and verify it on the server.
You must keep your security credentials private and avoid disclosure.
You can apply for the security credentials through the following steps:
1. Log in to the Tencent Cloud Console.
2. Go to the TencentCloud API Key page.
3. On the API Key Management page, click Create Key to create a SecretId/SecretKey pair.
Note: Each account can have up to two pairs of SecretId/SecretKey.

2. Generating a SignatureWith the SecretId and SecretKey, a signature can be generated. The following describes how to generate a signature:
Assume that the SecretId and SecretKey are:SecretId: AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******
SecretKey: Gu5t9xGARNpq86cd98joQYCN3*******
Note: This is just an example. For actual operations, please use your own SecretId and SecretKey.

©2013-2022 Tencent Cloud. All rights reserved.

Page 43 of 178

Domains

Take the Cloud Virtual Machine's request to view the instance list (DescribeInstances) as an example. When you
invoke this API, the request parameters may be as follows:
Parameter
nameDescription

Parameter value

Action

Method name

DescribeInstances

SecretId

Key ID

AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******

Timestamp

Current timestamp

1465185768

Nonce

Random positive integer

11886

RegionRegion where the instance islocatedap-guangzhou

InstanceIds.0

ID of the instance to query

ins-09dx96dg

OffsetOffset0

Limit

Allowed maximum output

20

VersionAPI version number

2017-03-12

2.1. Sorting Parameters
First, sort all the request parameters in an ascending lexicographical order (ASCII code) by their names. Notes: (1)Parameters are sorted by their names instead of their values; (2) The parameters are sorted based on ASCII code, notin an alphabetical order or by values. For example, InstanceIds.2 should be arranged after InstanceIds.12. You cancomplete the sorting process using a sorting function in a programming language, such as the ksort function in PHP.
The parameters in the example are sorted as follows:{'Action' : 'DescribeInstances','InstanceIds.0' : 'ins-09dx96dg','Limit' : 20,'Nonce' : 11886,'Offset' : 0,
'Region' : 'ap-guangzhou','SecretId' : 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******','Timestamp' : 1465185768,'Version': '2017-03-12',}©2013-2022 Tencent Cloud. All rights reserved.

Page 44 of 178

Domains

When developing in another programming language, you can sort these sample parameters and it will work as long as
you obtain the same results.

2.2. Concatenating a Request String
This step generates a request string.
Format the request parameters sorted in the previous step into the form of "parameter name"="parameter value". For
example, for the Action parameter, its parameter name is "Action" and its parameter value is "DescribeInstances", so it
will become Action=DescribeInstances after formatted.
Note: The "parameter value" is the original value but not the value after URL encoding.
Then, concatenate the formatted parameters with "&". The resulting request string is as follows:

Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Timestamp=1465
185768&Version=2017-03-12

2.3. Concatenating the Signature Original String
This step generates a signature original string.
The signature original string consists of the following parameters:
1. HTTP method: POST and GET modes are supported, and GET is used here for the request. Please note that themethod name should be in all capital letters.
2. Request server: the domain name of the request to view the list of instances (DescribeInstances) is
cvm.tencentcloudapi.com. The actual request domain name varies by the module to which the API belongs. For
more information, see the instructions of the specific API.
3. Request path: The request path in the current version of TencentCloud API is fixed to /.
4. Request string: the request string generated in the previous step.
The concatenation rule of the signature original string is: Request method + request host + request path + ? + request
string
The concatenation result of the example is:
GETcvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&L
imit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WF
kmLPx3*******&Timestamp=1465185768&Version=2017-03-12

2.4. Generating a Signature String
This step generates a signature string.
First, use the HMAC-SHA1 algorithm to sign the signature original string obtained in the previous step, and then©2013-2022 Tencent Cloud. All rights reserved.

Page 45 of 178

Domains

encode the generated signature using Base64 to obtain the final signature.
The specific code is as follows with the PHP language being used as an example:$secretKey = 'Gu5t9xGARNpq86cd98joQYCN3*******';$srcStr = 'GETcvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5
yKBZQpn74WFkmLPx3*******&Timestamp=1465185768&Version=2017-03-12';$signStr = base64_encode(hash_hmac('sha1', $srcStr, $secretKey, true));echo $signStr;
The final signature is:zmmjn35mikh6pM3V7sUEuX4wyYM=
When developing in another programming language, you can sign and verify the original in the example above and it
works as long as you get the same results.

3. Encoding a Signature String
The generated signature string cannot be directly used as a request parameter and must be URL encoded.
For example, if the signature string generated in the previous step is zmmjn35mikh6pM3V7sUEuX4wyYM=, the final
signature string request parameter (Signature) is zmmjn35mikh6pM3V7sUEuX4wyYM%3D, which will be used togenerate the final request URL.
Note: If your request method is GET, or the request method is POST and the Content-Type isapplication/x-www-form-urlencoded, then all the request parameter values need to be URL encoded(except the parameter key and the symbol of =) when sending the request. Non-ASCII characters need to
be encoded with UTF-8 before URL encoding.
Note: The network libraries of some programming languages automatically URL encode all parameters, inwhich case there is no need to URL encode the signature string; otherwise, two rounds of URL encoding
will cause the signature to fail.
Note: Other parameter values also need to be encoded using RFC 3986. Use %XY in percent-encoding forspecial characters such as Chinese characters, where "X" and "Y" are hexadecimal characters (0-9 anduppercase A-F), and using lowercase will cause an error.

4. Signature Failure©2013-2022 Tencent Cloud. All rights reserved.

Page 46 of 178

Domains

The following situational error codes for signature failure may occur. Please resolve the errors accordingly.
Error code

Error description

AuthFailure.SignatureExpire

The signature is expired

AuthFailure.SecretIdNotFoundThe key does not exist

AuthFailure.SignatureFailure

Signature error

AuthFailure.TokenFailure

Token error

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type)

5. Signature Demo
When calling API 3.0, you are recommended to use the corresponding Tencent Cloud SDK 3.0 which encapsulates
the signature process, enabling you to focus on only the specific APIs provided by the product when developing. See
SDK Center for more information. Currently, the following programming languages are supported:
PythonJava
PHP
Go
NodeJS.NET
To further explain the signing process, we will use a programming language to implement the process describedabove. The request domain name, API and parameter values in the sample are used here. This goal of this example isonly to provide additional clarification for the signature process, please see the SDK for actual usage.
The final output URL might be: https://cvm.tencentcloudapi.com/?
Action=DescribeInstances&InstanceIds.0=ins09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=apguangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Signature=zmmjn35mikh6pM3V7s
UEuX4wyYM%3D&Timestamp=1465185768&Version=2017-03-12 .
Note: The key in the example is fictitious, and the timestamp is not the current time of the system, so if this URL is
opened in the browser or called using commands such as curl, an authentication error will be returned: Signature
expired. In order to get a URL that can work properly, you need to replace the SecretId and SecretKey in the example
with your real credentials and use the current time of the system as the Timestamp.

©2013-2022 Tencent Cloud. All rights reserved.

Page 47 of 178

Domains

Note: In the example below, even if you use the same programming language, the order of the parameters in the URL
may be different for each execution. However, the order does not matter, as long as all the parameters are included in
the URL and the signature is calculated correctly.
Note: The following code is only applicable to API 3.0. It cannot be directly used in other signature processes. Even
with an older API, signature calculation errors may occur due to the differences in details. Please refer to thecorresponding documentation.

Java
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;import java.util.Random;
import java.util.TreeMap;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import javax.xml.bind.DatatypeConverter;
public class TencentCloudAPIDemo {private final static String CHARSET = "UTF-8";
public static String sign(String s, String key, String method) throws Exception {Mac mac = Mac.getInstance(method);
SecretKeySpec secretKeySpec = new SecretKeySpec(key.getBytes(CHARSET), mac.getAlg
orithm());
mac.init(secretKeySpec);
byte[] hash = mac.doFinal(s.getBytes(CHARSET));
return DatatypeConverter.printBase64Binary(hash);}public static String getStringToSign(TreeMap<String, Object> params) {StringBuilder s2s = new StringBuilder("GETcvm.tencentcloudapi.com/?");// When signing, the parameters need to be sorted in lexicographical order. TreeM
ap is used here to guarantee the correct order.
for (String k : params.keySet()) {s2s.append(k).append("=").append(params.get(k).toString()).append("&");}
return s2s.toString().substring(0, s2s.length() - 1);}
public static String getUrl(TreeMap<String, Object> params) throws UnsupportedEnc
odingException {StringBuilder url = new StringBuilder("https://cvm.tencentcloudapi.com/?");// There is no requirement for the order of the parameters in the actual request
URL.
for (String k : params.keySet()) {©2013-2022 Tencent Cloud. All rights reserved.

Page 48 of 178

Domains// The request string needs to be URL encoded. As the Key is all in English letters, only the value is URL encoded here.
url.append(k).append("=").append(URLEncoder.encode(params.get(k).toString(), CHAR
SET)).append("&");}
return url.toString().substring(0, url.length() - 1);}
public static void main(String[] args) throws Exception {TreeMap<String, Object> params = new TreeMap<String, Object>(); // TreeMap enable
s automatic sorting// A random number should be used when actually calling, for example: params.put("Nonce", new Random().nextInt(java.lang.Integer.MAX_VALUE));params.put("Nonce", 11886); // Common parameter// The current time of the system should be used when actually calling, for examp
le: params.put("Timestamp", System.currentTimeMillis() / 1000);params.put("Timestamp", 1465185768); // Common parameterparams.put("SecretId", "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"); // Common parameterparams.put("Action", "DescribeInstances"); // Common parameterparams.put("Version", "2017-03-12"); // Common parameterparams.put("Region", "ap-guangzhou"); // Common parameterparams.put("Limit", 20); // Business parameterparams.put("Offset", 0); // Business parameterparams.put("InstanceIds.0", "ins-09dx96dg"); // Business parameterparams.put("Signature", sign(getStringToSign(params), "Gu5t9xGARNpq86cd98joQYCN3*******", "HmacSHA1")); // Common parameter
System.out.println(getUrl(params));}}

PythonNote: If running in a Python 2 environment, the following requests dependency package must be installed first: pip
install requests .

# -*- coding: utf8 -*import base64
import hashlib
import hmac
import time
import requests
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"©2013-2022 Tencent Cloud. All rights reserved.

Page 49 of 178

Domains

def get_string_to_sign(method, endpoint, params):
s = method + endpoint + "/?"
query_str = "&".join("%s=%s" % (k, params[k]) for k in sorted(params))
return s + query_str
def sign_str(key, s, method):
hmac_str = hmac.new(key.encode("utf8"), s.encode("utf8"), method).digest()
return base64.b64encode(hmac_str)
if __name__ == '__main__':endpoint = "cvm.tencentcloudapi.com"
data = {'Action' : 'DescribeInstances','InstanceIds.0' : 'ins-09dx96dg','Limit' : 20,'Nonce' : 11886,'Offset' : 0,
'Region' : 'ap-guangzhou','SecretId' : secret_id,'Timestamp' : 1465185768, # int(time.time())'Version': '2017-03-12'}
s = get_string_to_sign("GET", endpoint, data)
data["Signature"] = sign_str(secret_key, s, hashlib.sha1)
print(data["Signature"])# An actual invocation would occur here, which may incur fees after success# resp = requests.get("https://" + endpoint, params=data)# print(resp.url)

Golangpackage main
import ("bytes""crypto/hmac""crypto/sha1""encoding/base64""fmt""sort")
func main() {secretId := "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secretKey := "Gu5t9xGARNpq86cd98joQYCN3*******"©2013-2022 Tencent Cloud. All rights reserved.

Page 50 of 178

Domains

params := map[string]string{"Nonce": "11886","Timestamp": "1465185768","Region": "ap-guangzhou","SecretId": secretId,"Version": "2017-03-12","Action": "DescribeInstances","InstanceIds.0": "ins-09dx96dg","Limit": "20","Offset": "0",}var buf bytes.Buffer
buf.WriteString("GET")
buf.WriteString("cvm.tencentcloudapi.com")buf.WriteString("/")
buf.WriteString("?")// sort keys by ascii asc orderkeys := make([]string, 0, len(params))
for k, _ := range params {keys = append(keys, k)}sort.Strings(keys)
for i := range keys {k := keys[i]buf.WriteString(k)buf.WriteString("=")
buf.WriteString(params[k])buf.WriteString("&")}
buf.Truncate(buf.Len() - 1)hashed := hmac.New(sha1.New, []byte(secretKey))hashed.Write(buf.Bytes())
fmt.Println(base64.StdEncoding.EncodeToString(hashed.Sum(nil)))
}

PHP
<?php
$secretId = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";$secretKey = "Gu5t9xGARNpq86cd98joQYCN3*******";$param["Nonce"] = 11886;//rand();©2013-2022 Tencent Cloud. All rights reserved.

Page 51 of 178

Domains$param["Timestamp"] = 1465185768;//time();$param["Region"] = "ap-guangzhou";$param["SecretId"] = $secretId;$param["Version"] = "2017-03-12";$param["Action"] = "DescribeInstances";$param["InstanceIds.0"] = "ins-09dx96dg";$param["Limit"] = 20;$param["Offset"] = 0;
ksort($param);$signStr = "GETcvm.tencentcloudapi.com/?";foreach ( $param as $key => $value ) {$signStr = $signStr . $key . "=" . $value . "&";}
$signStr = substr($signStr, 0, -1);
$signature = base64_encode(hash_hmac("sha1", $signStr, $secretKey, true));echo $signature.PHP_EOL;// need to install and enable curl extension in php.ini// $param["Signature"] = $signature;// $url = "https://cvm.tencentcloudapi.com/?".http_build_query($param);// echo $url.PHP_EOL;// $ch = curl_init();// curl_setopt($ch, CURLOPT_URL, $url);// $output = curl_exec($ch);// curl_close($ch);// echo json_decode($output);Ruby# -*- coding: UTF-8 -*# require ruby>=2.3.0
require 'time'require 'openssl'
require 'base64'
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"
method = 'GET'
endpoint = 'cvm.tencentcloudapi.com'
data = {'Action' => 'DescribeInstances','InstanceIds.0' => 'ins-09dx96dg','Limit' => 20,©2013-2022 Tencent Cloud. All rights reserved.

Page 52 of 178

Domains'Nonce' => 11886,'Offset' => 0,'Region' => 'ap-guangzhou','SecretId' => secret_id,'Timestamp' => 1465185768, # Time.now.to_i'Version' => '2017-03-12',}
sign = method + endpoint + '/?'
params = []data.sort.each do |item|
params << "#{item[0]}=#{item[1]}"endsign += params.join('&')
digest = OpenSSL::Digest.new('sha1')
data['Signature'] = Base64.encode64(OpenSSL::HMAC.digest(digest, secret_key, sign))puts data['Signature']# require 'net/http'# uri = URI('https://' + endpoint)# uri.query = URI.encode_www_form(data)# p uri# res = Net::HTTP.get_response(uri)# puts res.body

DotNetusing System;
using System.Collections.Generic;using System.Net;
using System.Security.Cryptography;
using System.Text;
public class Application {public static string Sign(string signKey, string secret){string signRet = string.Empty;
using (HMACSHA1 mac = new HMACSHA1(Encoding.UTF8.GetBytes(signKey))){byte[] hash = mac.ComputeHash(Encoding.UTF8.GetBytes(secret));signRet = Convert.ToBase64String(hash);}return signRet;}
public static string MakeSignPlainText(SortedDictionary<string, string> requestParams, string requestMethod, string requestHost, string requestPath)©2013-2022 Tencent Cloud. All rights reserved.

Page 53 of 178

Domains{
string retStr = "";retStr += requestMethod;
retStr += requestHost;
retStr += requestPath;
retStr += "?";
string v = "";foreach (string key in requestParams.Keys){v += string.Format("{0}={1}&", key, requestParams[key]);}
retStr += v.TrimEnd('&');
return retStr;}
public static void Main(string[] args){
string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string endpoint = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";
double RequestTimestamp = 1465185768;// long timestamp = ToTimestamp() / 1000;// string requestTimestamp = timestamp.ToString();
Dictionary<string, string> param = new Dictionary<string, string>();param.Add("Limit", "20");param.Add("Offset", "0");param.Add("InstanceIds.0", "ins-09dx96dg");
param.Add("Action", action);param.Add("Nonce", "11886");// param.Add("Nonce", Math.Abs(new Random().Next()).ToString());
param.Add("Timestamp", RequestTimestamp.ToString());
param.Add("Version", version);param.Add("SecretId", SECRET_ID);
param.Add("Region", region);
SortedDictionary<string, string> headers = new SortedDictionary<string, string>(param, StringComparer.Ordinal);
string sigInParam = MakeSignPlainText(headers, "GET", endpoint, "/");
Console.WriteLine(sigInParam);
string sigOutParam = Sign(SECRET_KEY, sigInParam);©2013-2022 Tencent Cloud. All rights reserved.

Page 54 of 178

Domains

Console.WriteLine("GET https://cvm.tencentcloudapi.com");foreach (KeyValuePair<string, string> kv in headers){Console.WriteLine(kv.Key + ": " + kv.Value);}
Console.WriteLine("Signature" + ": " + WebUtility.UrlEncode(sigOutParam));
Console.WriteLine();string result = "https://cvm.tencentcloudapi.com/?";foreach (KeyValuePair<string, string> kv in headers){
result += WebUtility.UrlEncode(kv.Key) + "=" + WebUtility.UrlEncode(kv.Value) +"&";}result += WebUtility.UrlEncode("Signature") + "=" + WebUtility.UrlEncode(sigOutPa
ram);
Console.WriteLine("GET " + result);}}

NodeJS
const crypto = require('crypto');function get_req_url(params, endpoint){
params['Signature'] = escape(params['Signature']);const url_strParam = sort_params(params)
return "https://" + endpoint + "/?" + url_strParam.slice(1);}function formatSignString(reqMethod, endpoint, path, strParam){
let strSign = reqMethod + endpoint + path + "?" + strParam.slice(1);return strSign;}function sha1(secretKey, strsign){
let signMethodMap = {'HmacSHA1': "sha1"};
let hmac = crypto.createHmac(signMethodMap['HmacSHA1'], secretKey || "");
return hmac.update(Buffer.from(strsign, 'utf8')).digest('base64')}function sort_params(params){
let strParam = "";let keys = Object.keys(params);
keys.sort();for (let k in keys) {//k = k.replace(/_/g, '.');©2013-2022 Tencent Cloud. All rights reserved.

Page 55 of 178

Domains

strParam += ("&" + keys[k] + "=" + params[keys[k]]);}return strParam}function main(){const SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
const SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******"
const endpoint = "cvm.tencentcloudapi.com"
const Region = "ap-guangzhou"
const Version = "2017-03-12"
const Action = "DescribeInstances"
const Timestamp = 1465185768// const Timestamp = Math.round(Date.now() / 1000)
const Nonce = 11886//const nonce = Math.round(Math.random() * 65535)
let params = {};params['Action'] = Action;
params['InstanceIds.0'] = 'ins-09dx96dg';
params['Limit'] = 20;
params['Offset'] = 0;params['Nonce'] = Nonce;params['Region'] = Region;
params['SecretId'] = SECRET_ID;
params['Timestamp'] = Timestamp;
params['Version'] = Version;
strParam = sort_params(params)
const reqMethod = "GET";
const path = "/";
strSign = formatSignString(reqMethod, endpoint, path, strParam)
console.log(strSign)
console.log("-----------------------")
params['Signature'] = sha1(SECRET_KEY, strSign)
console.log(params['Signature'])console.log("-----------------------")
const req_url = get_req_url(params, endpoint)
console.log(params['Signature'])console.log("-----------------------")
console.log(req_url)}
main()©2013-2022 Tencent Cloud. All rights reserved.

Page 56 of 178

Domains©2013-2022 Tencent Cloud. All rights reserved.

Page 57 of 178

Domains

Responses：

Last updated 2023-03-28 10:48:33

Response for Successful Requests
For example, when calling CAM API (version: 2017-03-12) to view the status of instances (DescribeInstancesStatus),
if the request has succeeded, you may see the response as shown below:{"Response": {"TotalCount": 0,"InstanceStatusSet": [],"RequestId": "b5b41468-520d-4192-b42f-595cc34b6c1c"}}
The API will return Response , which contains RequestId , as long as it processes the request. It does notmatter if the request is successful or not.
RequestId is the unique ID of an API request. Contact us with this ID when an exception occurs.
Except for the fixed fields, all fields are action-specified. For the definitions of action-specified fields, see thecorresponding API documentation. In this example, TotalCount and InstanceStatusSet are the fields
specified by the API DescribeInstancesStatus . 0 TotalCount means that the requester owns 0 CVM
instance so the InstanceStatusSet is empty.

Response for Failed Requests
If the request has failed, you may see the response as shown below:{"Response": {"Error": {"Code": "AuthFailure.SignatureFailure","Message": "The provided credentials could not be validated. Please ensure your signature is correct."},"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 58 of 178

Domains

The presence of the Error field indicates that the request has failed. A response for a failed request will include
Error , Code and Message fields.
Code is the code of the error that helps you identify the cause and solution. There are two types of error codes
so you may find the code in either common error codes or API-specified error codes.
Message explains the cause of the error. Note that the returned messages are subject to service updates. The
information the messages provide may not be up-to-date and should not be the only source of reference.
RequestId is the unique ID of an API request. Contact us with this ID when an exception occurs.

Common Error Codes
If there is an Error field in the response, it means that the API call failed. The Code field in Error indicates the error
code. The following table lists the common error codes that all actions can return.
Error CodeDescription

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

AuthFailure.MFAFailure

MFA failed.

AuthFailure.SecretIdNotFoundThe key does not exist.

AuthFailure.SignatureExpire

Signature expired.

AuthFailure.SignatureFailure

Signature error.

AuthFailure.TokenFailure

Token error.

AuthFailure.UnauthorizedOperation

The request does not have CAM authorization.

DryRunOperation

DryRun Operation. It means that the request would have succeeded, but
the DryRun parameter was used.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidAction

The API does not exist.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Invalid parameter value.

LimitExceeded

Quota limit exceeded.

MissingParameter

A parameter is missing.

©2013-2022 Tencent Cloud. All rights reserved.

Page 59 of 178

Domains

NoSuchVersion

The API version does not exist.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

Resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

Resource is unavailable.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

UnsupportedProtocol

HTTPS request method error. Only GET and POST requests aresupported.

UnsupportedRegion

API does not support the requested region.

©2013-2022 Tencent Cloud. All rights reserved.

Page 60 of 178

Domains

Domain Management APIs
DescribeIntlBatchOperationLogs：

Last updated 2023-03-28 10:53:04

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to query the logs of bulk domain purchase.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeIntlBatchOperationLogs.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

OffsetNo

Integer

The offset. Default value: 0

Limit

No

Integer

The number of returned results. Default value: 20. Maximum value:100.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 61 of 178

Domains

Parameter NameType

Description

TotalCount

Integer

The total count.

DomainBatchLogSet

Array of
BatchDomainBuyLog

The log list.
Note: This field may return null, indicating that no valid values
can be obtained.

RequestId

String

The unique request ID, which is returned for each request.
RequestId is required for locating a problem.

4. Example
Example1 Getting the logs of bulk domain purchase
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntlBatchOperationLogs<Common request parameters>{"Limit": 0,"Offset": 0}

Output Example{"Response": {"TotalCount": 204,
"DomainBatchLogSet": [{"LogId": 318,
"Action": "new","CreatedOn": "2020-06-10 20:08:43","Number": 12,"Status": "doing"}],"RequestId": "1af07f55-2b13-4076-a301-74c2480f7af7"},©2013-2022 Tencent Cloud. All rights reserved.

Page 62 of 178

Domains"ResultStatus": true}

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError

Internal error.

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

©2013-2022 Tencent Cloud. All rights reserved.

Page 63 of 178

Domains

InvalidParameter

Invalid parameter.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 64 of 178

Domains

DescribeIntlDomainBatchDetails：

Last updated 2023-03-28 10:53:04

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to get the log details of bulk domain purchase.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeIntlDomainBatchDetails.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

LogId

Yes

Integer

The log ID.

OffsetNo

Integer

The offset. Default value: 0

Limit

No

Integer

The number of returned results. Default value: 20. Maximum value:
100.

OrderByKey

No

String

The sort key. Valid values: Domain , UpdateOn , Status

OrderBy

No

Integer

Valid values: 0 (ascending), 1 (descending).

©2013-2022 Tencent Cloud. All rights reserved.

Page 65 of 178

Domains

3. Output Parameters
Parameter NameType

Description

TotalCount

Integer

The total count.

DomainBatchDetailSet

Array of
BatchDomainBuyDetails

The list of log details.
Note: This field may return null, indicating that no valid
values can be obtained.

RequestId

String

The unique request ID, which is returned for eachrequest. RequestId is required for locating a problem.

4. Example
Example1 Getting the log details of bulk domain purchase
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntlDomainBatchDetails<Common request parameters>{"LogId": 1,"Limit": 0,"Offset": 0}

Output Example{"Response": {"TotalCount": 12,"RequestId": "13f43fa6-7282-4652-a99c-66819145ba5f","DomainBatchDetailSet": [{"Status": "doing","Domain": "batchzz426.club","UpdatedOn": "2020-06-10 20:08:50","CreatedOn": "2020-06-10 20:08:44",©2013-2022 Tencent Cloud. All rights reserved.

Page 66 of 178

Domains"Reason": "","ReasonZh": "","Action": "new","Id": 85215}]}}

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError

Internal error.

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InvalidParameter

Invalid parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 67 of 178

Domains©2013-2022 Tencent Cloud. All rights reserved.

Page 68 of 178

Domains

Domain Query APIs
CheckIntlDomainNew：

Last updated 2023-03-28 10:53:04

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to check whether a domain is available for registration.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CheckIntlDomainNew.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

DomainYes

String

The name of the domain to be checked.

PeriodNo

String

Period, in years. If this parameter is left empty, premium domains
cannot be queried.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 69 of 178

Domains

Parameter
Name

Type

Description

DomainName

String

The name of the domain checked.

Available

BooleanWhether the domain is available for registration.

ReasonString

The reason why the domain cannot be registered.

Premium

BooleanWhether the domain is a premium one.

Price

Float

The domain price.

BlackWord

BooleanWhether the domain name involves restricted words.

Describe

String

The premium domain description.
Note: This field may return null, indicating that no valid values can be obtained.

FeeRenewFloat

The price for renewing the premium domain.
Note: This field may return null, indicating that no valid values can be obtained.

RealPrice

Float

The real price of the domain. For a premium domain, its price varies depending on
the period. For a non-premium domain, the price is the 1-year price.
Note: This field may return null, indicating that no valid values can be obtained.

FeeTransfer

Float

The price for transferring a premium domain in.
Note: This field may return null, indicating that no valid values can be obtained.

FeeRestore

Float

The price for redeeming a premium domain.

PeriodInteger

The period (in years) of the domain.

ReasonZh

String

The reason why the domain cannot be registered, expressed in Chinese.

ResCodeString

The internal error code.

RequestId

String

The unique request ID, which is returned for each request. RequestId is required
for locating a problem.

4. Example
Example1 Checking whether a domain is available for registration
This example shows you how to check whether a domain is available for registration.
Input Example©2013-2022 Tencent Cloud. All rights reserved.

Page 70 of 178

Domains

POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckIntlDomainNew<Common request parameters>{"Domain": "mervyn111.com","Period": 1}

Output Example{"Response": {"Available": true,"Premium": false,"DomainName": "Example.show","FeeTransfer": 0,"Describe": "","FeeRestore": 0,"Period": 1,"Reason": "","ReasonZh": "","RequestId": "cc5af1aa-544c-11ea-9bcb-525400f1e866","RealPrice": 10,"BlackWord": false,"Price": 35,"ResCode": "1002","FeeRenew": 0}}

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©2013-2022 Tencent Cloud. All rights reserved.

Page 71 of 178

Domains

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.CheckDomainFailed

Domain name query failed. Please try this feature again later.

InternalError.CheckDnAvailableErr

Failed to get check data.

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameter

Invalid parameter.

InvalidParameter.DomainNameIsInvalid

The domain is empty or incorrect.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

MissingParameter.DomainIsEmpty

The domain cannot be empty.

©2013-2022 Tencent Cloud. All rights reserved.

Page 72 of 178

Domains

DescribeIntlDomainPriceNewList：

Last updated 2023-03-28 10:53:04

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to get the price list by domain suffix.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeIntlDomainPriceNewList.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

TldList.N

No

Array of
String

The list of domain suffixes for which you want to query prices. Thisparameter defaults to all suffixes.

Year.NNo

Array ofInteger

The purchase year of the domains for which you want to query
prices. This parameter defaults to all years.

Operation.N

No

Array of
String

The domain purchase type. Valid values: new , renew ,©2013-2022 Tencent Cloud. All rights reserved.

redem (redeem), tran (transfer in).

Page 73 of 178

Domains

3. Output Parameters
Parameter
Name

Type

Description

PriceList

Array ofPriceInfoNew

The price list of domains.

RequestId

String

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Getting the price list of domains
This example shows you how to get the price list of domains.
Input Example
https://domain.tencentcloudapi.com/?Action=DescribeIntlDomainPriceNewList&<Common request parameters>

Output Example{"Response": {"PriceList": [{"Price": 1,"RealPrice": 1,"Year": 1,"Operation": "xx","Tld": "xx"},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,©2013-2022 Tencent Cloud. All rights reserved.

Page 74 of 178

Domains"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},©2013-2022 Tencent Cloud. All rights reserved.

Page 75 of 178

Domains{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx",©2013-2022 Tencent Cloud. All rights reserved.

Page 76 of 178

Domains"Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx",©2013-2022 Tencent Cloud. All rights reserved.

Page 77 of 178

Domains"RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{©2013-2022 Tencent Cloud. All rights reserved.

Page 78 of 178

Domains"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1©2013-2022 Tencent Cloud. All rights reserved.

Page 79 of 178

Domains},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,©2013-2022 Tencent Cloud. All rights reserved.

Page 80 of 178

Domains"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,©2013-2022 Tencent Cloud. All rights reserved.

Page 81 of 178

Domains"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},©2013-2022 Tencent Cloud. All rights reserved.

Page 82 of 178

Domains{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx","Year": 1},{"Price": 1,"Operation": "xx","RealPrice": 1,"Tld": "xx",©2013-2022 Tencent Cloud. All rights reserved.

Page 83 of 178

Domains"Year": 1}],"RequestId": "xx"}}

Example2 Request successful
Request successful
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntlDomainPriceNewList<Common request parameters>{"Operation": ["renew"],"TldList": [".com"],"Year": ["1"]}

Output Example{"Response": {"PriceList": [{"Price": 0.0,
"RealPrice": 0.0,
"Year": 1,"Operation": "xx","Tld": "xx"}],"RequestId": "xx"©2013-2022 Tencent Cloud. All rights reserved.

Page 84 of 178

Domains}}

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.DomainPriceListFailed

Failed to get the domain price list.

InternalError

Internal error.

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.ReadBodyError

Failed to read the body.

©2013-2022 Tencent Cloud. All rights reserved.

Page 85 of 178

Domains

InvalidParameter

Invalid parameter.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 86 of 178

Domains

Bulk Operation APIs
BatchModifyIntlDomainDNS：

Last updated 2023-03-28 10:53:05

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to bulk modify DNS servers for domains.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
BatchModifyIntlDomainDNS.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

Yes

Array
of
String

The target domains.

Dns.N

Yes

Array
of
String

The domain DNS array.

BatchAction

No

StringValid values: batch_modify_domain_dns1 ,Domains.N©2013-2022 Tencent Cloud. All rights reserved.

Page 87 of 178

Domains

batch_modify_domain_dns2 ,batch_modify_domain_dns3

3. Output Parameters
Parameter

Type

Description

LogId

Integer

The log ID.

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Bulk modifying DNS servers for domains
Input Example
POST / HTTP/1.1
Host:domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchModifyIntlDomainDNS<Common request parameters>{"Domains": ["h101.tencent.com"],"Dns": ["f1g1ns2.dnspod.net","f1g1ns2.dnspod.net"]}

Output Example{"Response": {"LogId": 54,"RequestId": "ac64c5c2-c0f0-11ea-ba13-080027f4585e"©2013-2022 Tencent Cloud. All rights reserved.

Page 88 of 178

Domains}}

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.SetDomainDnsFailed

Failed to modify the DNS server. Enter acorrect DNS server address.

InternalError

Internal error.

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

©2013-2022 Tencent Cloud. All rights reserved.

Page 89 of 178

Domains

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameter

Invalid parameter.

InvalidParameter.DomainNameIsInvalid

The domain is empty or incorrect.

InvalidParameter.UpTo4000

The number of domains cannot exceed
4,000.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter

Missing parameter.

MissingParameter.ActionNotFoundThe route is not defined.

MissingParameter.DomainIsEmpty

The domain cannot be empty.

MissingParameter.RepDataIsNone

The request data cannot be empty.

ResourceNotFound.DomainNotFoundThe domain address is incorrect. Please
enter a correct one.

ResourceUnavailable.DomainIsModifyingDNS

Unable to perform this operation because an
operation of the same type is in progress forthis domain.

UnsupportedOperation.ModifyDomainInfoOperateUnsupported

This operation is unavailable under thecurrent domain status.

UnsupportedOperation.ModifyDomainInfoUnsupported

Modification is unavailable under the current
domain status.

UnsupportedOperation.ModifyDomainUnsupported

Modification is unavailable under the current
domain status.

©2013-2022 Tencent Cloud. All rights reserved.

Page 90 of 178

Domains

BatchModifyIntlDomainInfo：

Last updated 2023-03-28 10:53:05

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to bulk modify registrant information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

Domains.N

Yes

TemplateId

YesString

The profile ID.

LockTransfer

No

BooleanWhether to enable the 60-day inter-registrar transfer lock.

Array of
StringDescription
Common Params. The value used for this API:
BatchModifyIntlDomainInfo.

The domains whose information is to be modified.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 91 of 178

Domains

Parameter

Type

Description

LogId

Integer

The log ID.

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Bulk modifying registrant information
Input Example
POST / HTTP/1.1
Host:domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchModifyIntlDomainInfo<Common request parameters>{"TemplateId": "tmpl-xxxxx","Domains": ["h101.tencent.com"]}

Output Example{"Response": {"LogId": 318,
"RequestId": "1684afa4-0bf7-49f8-a630-ab460e5c038e"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 92 of 178

Domains

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError

Internal error.

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameter

Invalid parameter.

InvalidParameter.UpTo4000

The number of domains cannot exceed 4,000.

MissingParameter

Missing parameter.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 93 of 178

Domains

MissingParameter.DomainIsEmpty

The domain cannot be empty.

MissingParameter.RepDataIsNone

The request data cannot be empty.

MissingParameter.TemplateIdIsEmpty

The profile ID is empty or invalid.

ResourceInsufficient.Overwork
ResourceNotFound.ApprovedTemplateNotFound
ResourceNotFound.TemplateNotFound©2013-2022 Tencent Cloud. All rights reserved.

Too many tasks are being executed. Please submit newones later.
The identity is not verified for the profile.
The profile information is incorrect. Please set information
correctly.

Page 94 of 178

Domains

CreateIntlDomainBatch：

Last updated 2023-04-03 18:06:22

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to bulk register domains.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

TemplateId

YesString

The profile ID.

PeriodYes

Integer

The purchase period (years) of the domain. Value range: [1-10]

Domains.N

Yes

PayModeYes

Integer

AutoRenewFlag

No

BooleanArray of
String©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
CreateIntlDomainBatch.

The domains (maximum 4,000) to purchase.
The payment method. Valid values: 0 (online payment), 1(account balance), 2 (package), 3 (offline settlement).
Whether to enable auto-renewal.

Page 95 of 178

Domains

TransferProhibition

No

BooleanWhether to enable the transfer prohibition lock.

UpdateProhibition

No

BooleanWhether to enable the update prohibition lock.

CustomDns.N

No

Array of
String

The custom DNS servers

3. Output Parameters
Parameter
Name

Type

LogId

IntegerRequestId

StringDescription
The bulk purchase log ID.
Note: This field may return null, indicating that no valid values can be obtained.
The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Bulk registering domains
This example shows you how to bulk register domains.
Input Example
POST / HTTP/1.1
Host:domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntlDomainBatch<Common request parameters>{"Domains": ["a.com"],"PayMode": 0,"Period": 1,"TemplateId": "tmpl-aabb"}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 96 of 178

Domains{"Response": {"LogId": 318,
"RequestId": "1684afa4-0bf7-49f8-a630-ab460e5c038e"}}

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.RegisterDomain

Domain registration failed. Please try again later.

FailedOperation.RegisterDomainFailed

Domain registration failed. Please try again later.

InternalError

Internal error.

©2013-2022 Tencent Cloud. All rights reserved.

Page 97 of 178

Domains

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameter

Invalid parameter.

InvalidParameter.CustomDnsNotAllowed

You have no permission to customize DNS servers.

InvalidParameter.PackageResourceIdInvalid

Invalid package ID.

InvalidParameter.UpTo4000

The number of domains cannot exceed 4,000.

MissingParameter

Missing parameter.

MissingParameter.ActionNotFoundThe route is not defined.

MissingParameter.DomainIsEmpty

The domain cannot be empty.

MissingParameter.RepDataIsNone

The request data cannot be empty.

MissingParameter.TemplateIdIsEmpty

The profile ID is empty or invalid.

ResourceInsufficient.Overwork

ResourceNotFound.TemplateNotFound©2013-2022 Tencent Cloud. All rights reserved.

Too many tasks are being executed. Please submit new ones
later.
The profile information is incorrect. Please set information
correctly.

Page 98 of 178

Domains

TransferInIntlDomainBatch：

Last updated 2023-03-28 10:53:05

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to bulk transfer domains in.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringRegionNo

StringTemplateId

YesString

PassWords.N

Yes

Domains.N

Yes

Array of
String

The domains to be bulk transferred in.

PayModeYes

Integer

The payment method. Valid value: 1 (account balance).

AutoRenewFlag

No

BooleanWhether to enable auto-renewal.

Array of
String©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
TransferInIntlDomainBatch.
Common Params. The value used for this API: 2018-08-08.
Common Params. This parameter is not required for thisAPI.
The profile ID.
The transfer passwords for the domains.

Page 99 of 178

Domains

TransferProhibition

No

BooleanWhether to enable the transfer prohibition lock.

UpdateProhibition

No

BooleanWhether to enable the update prohibition lock.

LockTransfer

No

BooleanWhether to enable the 60-day inter-registrar transfer lock.

3. Output Parameters
Parameter
Name

Type

LogId

IntegerRequestId

StringDescription
The bulk purchase log ID.
Note: This field may return null, indicating that no valid values can be obtained.
The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Bulk transferring domains in
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TransferInIntlDomainBatch<Common request parameters>{"Domains": ["xx"],"PayMode": 0,"PassWords": ["xx"],"TemplateId": "xx"}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 100 of 178

Domains{"Response": {"LogId": 318,
"RequestId": "1684afa4-0bf7-49f8-a630-ab460e5c038e"}}

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.TransferInDomainFailed

Failed to transfer the domain in. Please try again later.

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

©2013-2022 Tencent Cloud. All rights reserved.

Page 101 of 178

Domains

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameter

Invalid parameter.

InvalidParameter.UpTo4000

The number of domains cannot exceed 4,000.

MissingParameter.ActionNotFoundThe route is not defined.

ResourceInsufficient.Overwork

Too many tasks are being executed. Please submit new ones later.

ResourceNotFound.TemplateNotFoundThe profile information is incorrect. Please set information correctly.

©2013-2022 Tencent Cloud. All rights reserved.

Page 102 of 178

Domains

Registrant Profile APIs
CreateIntlTemplate：

Last updated 2023-03-28 10:53:00

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to add a registrant profile.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringRegionNo

StringRegistrantContact

Yes

RegistrantContact

The registrant contact.

AdminContact

Yes

AdminContact

The admin contact.

TechnicalContact

Yes

TechnicalContact

The technical contact.

BillingContact

Yes

BillingContact

The contact person for bills.

©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
CreateIntlTemplate.
Common Params. The value used for this API: 201808-08.
Common Params. This parameter is not required forthis API.

Page 103 of 178

Domains

TemplateType

No

String

The profile type. Valid values: I (individual,
default), E (organization).

3. Output Parameters
Parameter
Name

Type

Description

TemplateId

String

The profile ID.

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Creating a registrant profile
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntlTemplate<Common request parameters>{"RegistrantContact": {"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx","AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},"BillingContact": {©2013-2022 Tencent Cloud. All rights reserved.

Page 104 of 178

Domains"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx","AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},
"TechnicalContact": {"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx","AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},"AdminContact": {"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx","AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 105 of 178

Domains

Output Example{"Response": {"RequestId": "xx","TemplateId": "xx"}}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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.CreateTemplateFailed

Failed to create the registrant profile.

FailedOperation.DescribeDomainListFailed

Failed to get the domain information. Please try again later.

©2013-2022 Tencent Cloud. All rights reserved.

Page 106 of 178

Domains

FailedOperation.DescribeTemplateFailed
FailedOperation.TemplateMaxNumFailed

Failed to query the registrant profile.
The number of registrant profiles has reached the maximum
number allowed. Delete a profile and try again.

InternalError

Internal error.

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameter

Invalid parameter.

InvalidParameter.CertificateCodeIsInvalid

Incorrect qualification information.

InvalidParameter.CertificateImageIsInvalid

Incorrect qualification photo.

InvalidParameter.EmailIsInvalid

The email address is empty or incorrect.

InvalidParameter.FirstNameIsInvalid

The first name is empty or incorrect.

InvalidParameter.LastNameIsInvalid

The last name is empty or incorrect.

InvalidParameter.NameIsInvalid

The contact person is empty or incorrect.

InvalidParameter.OrgIsInvalid

The registrant is empty or incorrect.

InvalidParameter.RepTypeIsInvalid

Invalid request type.

InvalidParameter.StreetIsInvalid

Incorrect address. Please enter a correct one.

InvalidParameter.TelephoneIsInvalid

The mobile number is empty or invalid.

InvalidParameter.UserTypeIsInvalid

The user type is empty or invalid.

InvalidParameter.ZipCodeIsInvalid

The zip code is empty or invalid.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter

Missing parameter.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 107 of 178

Domains

MissingParameter.DomainIsEmpty

The domain cannot be empty.

MissingParameter.RepDataIsNone

The request data cannot be empty.

MissingParameter.TemplateIdIsEmpty

The profile ID is empty or invalid.

MissingParameter.TemplateIdIsExist

This profile already exists.

ResourceNotFoundThe resource doesn’t exist.

ResourceNotFound.TemplateNotFound©2013-2022 Tencent Cloud. All rights reserved.

The profile information is incorrect. Please set information
correctly.

Page 108 of 178

Domains

DescribeIntlTemplateList：

Last updated 2023-03-28 10:53:00

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to get the list of registrant profiles.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeIntlTemplateList.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

OffsetNo

Integer

The offset.

Limit

No

Integer

The maximum number of entries.

KeywordNo

String

The domain registrant keyword for exact match.

Type

No

StringName©2013-2022 Tencent Cloud. All rights reserved.

The type. Valid values: all (all types), I (individual), E(organization).

Page 109 of 178

Domains

3. Output Parameters
Parameter
Name
TemplateSet

Type
Array of
IntlTemplate

TotalCount

IntegerRequestId

StringDescription

The registrant profile list information.
The total count.
The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Getting the list of registrant profiles
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntlTemplateList<Common request parameters>{}

Output Example{"Response": {"TotalCount": 0,"TemplateSet": [{"RegistrantContact": {"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx",©2013-2022 Tencent Cloud. All rights reserved.

Page 110 of 178

Domains"AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},
"TechnicalContact": {"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx","AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},"CreatedOn": "2020-09-22 00:00:00","TemplateId": "xx","AdminContact": {"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx","AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},"BillingContact": {"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx",©2013-2022 Tencent Cloud. All rights reserved.

Page 111 of 178

Domains"AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},"UpdatedOn": "2020-09-22 00:00:00","IsDefault": 0}],"RequestId": "xx"}}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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DomainInternalError

Network error. Please try again later.

©2013-2022 Tencent Cloud. All rights reserved.

Page 112 of 178

Domains

InternalError.ForbiddenRequest

Forbidden request.

InvalidParameter

Invalid parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 113 of 178

Domains

Other APIs
CreateIntlPhoneEmail：

Last updated 2023-03-28 10:53:04

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to verify a mobile number or an email address via a verification code.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
CreateIntlPhoneEmail.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

Type

Yes

Integer

The type. Valid values: 1 (mobile number), 2 (email address).

Code

Yes

String

The mobile number or email address.

VerifyCode

Yes

String

The verification code.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 114 of 178

Domains

Parameter
Name

Type

RequestId

StringDescription
The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Verifying a mobile number or an email address via a verification code
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntlPhoneEmail<Common request parameters>{"Type": 1,"Code": "18766554433","VerifyCode": "123456"}

Output Example{"Response": {"RequestId": "eac6b301-a322-493a-8e36-83b295459398"}}

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©2013-2022 Tencent Cloud. All rights reserved.

Page 115 of 178

Domains

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.AddPhoneEmailErr

Failed to add the mobile number or email address.

InternalError.CheckVerifyCodeErr

Failed to verify the verification code.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InternalError.VerifiedPhoneEmailErr

The mobile number or email address has already beenverified.

InternalError.VerifyCodeErr

Incorrect verification code.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 116 of 178

Domains

DeleteIntlPhoneEmail：

Last updated 2023-03-28 10:53:03

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to delete a mobile number or an email address.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

Type

Yes

Integer

The type. Valid values: 1 (mobile number), 2 (email address).

Code

Yes

String

The mobile number or email address.

Name

Description
Common Params. The value used for this API:
DeleteIntlPhoneEmail.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 117 of 178

Domains

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Deleting a mobile number or an email address
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIntlPhoneEmail<Common request parameters>{"Type": 1,"Code": "18766554433"}

Output Example{"Response": {"RequestId": "eac6b301-a322-493a-8e36-83b295459398"}}

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 NodeJS©2013-2022 Tencent Cloud. All rights reserved.

Page 118 of 178

Domains

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DeletePhoneEmailVerifyErr

Failed to delete the mobile number or email address.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 119 of 178

Domains

DeleteIntlTemplate：

Last updated 2023-03-28 10:53:03

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to delete a registrant profile.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DeleteIntlTemplate.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

TemplateId

YesString

The unique ID of the target registrant profile.

3. Output Parameters
Parameter
Name
RequestId

Type

StringDescription
The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 120 of 178

Domains

4. Example
Example1 Deleting a registrant profile
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIntlTemplate<Common request parameters>{"TemplateId": "template-1000q"}

Output Example{"Response": {"RequestId": "eac6b301-a322-493a-8e36-83b295459398"}}

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 121 of 178

Domains

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DeleteTemplateErr

Failed to delete the registrant profile.

InternalError.DescribeTemplateErr

Failed to get the details of the registrant profile.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.MethodNotMatch

Method mismatch.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 122 of 178

Domains

DescribeIntlBatchDetailStatus：

Last updated 2023-03-28 10:53:03

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to query the status of a bulk task.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

LogIds.N

Yes

Name

Description

Array ofInteger

Common Params. The value used for this API:
DescribeIntlBatchDetailStatus.

The IDs of the logs to be queried.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 123 of 178

Domains

Details

Array of
IntlBatchDetails

RequestId

String

The details.

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Querying the status of a bulk task
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntlBatchDetailStatus<Common request parameters>{"LogIds": [
12,
13
]
}

Output Example{"Response": {"Details": [{"Id": 12,"Status": "doing","Reason": "","ReasonZh": ""}],"RequestId": "121323"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 124 of 178

Domains

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameter

Invalid parameter.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 125 of 178

Domains

DescribeIntlDomain：

Last updated 2023-03-28 10:53:03

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to query domain information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeIntlDomain.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

DomainId

Yes

String

The domain ID.

Name

3. Output Parameters
Parameter
Name

Type

Description

DomainInfo

IntlDomainInfo

The domain information.

©2013-2022 Tencent Cloud. All rights reserved.

Page 126 of 178

Domains

RequestId

String

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Querying domain information
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntlDomain<Common request parameters>{"DomainId": 0}

Output Example{"Response": {"DomainInfo": {"Status": "xx","IsPremium": false,"DomainId": "xx","CanRenewYears": 0,"DomainName": "xx","RegistrarType": "xx","ModifyStatus": "xx","DnsModifyStatus": "xx","TemplateId": "xx","WhoisPrivacy": 0,"DomainStatus": [""],"Uin": "xx","AutoRenew": 3,"ExpirationDate": "xx","Dns": ["f1g1ns1.dnspod.net"],"ExpireMessage": 3,©2013-2022 Tencent Cloud. All rights reserved.

Page 127 of 178

Domains"DnsStatus": 3,"ContactInfo": {"Province": "xx","City": "xx","OrganizationName": "xx","FirstName": "xx","RegistrantType": "xx","Country": "xx","CompanyName": "xx","RegistrantName": "xx","Telephone": "xx","ZipCode": "xx","Street": "xx","LastName": "xx","Email": "xx"},"SupportDnssec": true,"CreationDate": "xx"},"RequestId": "xx"}}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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 128 of 178

Domains

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DescribeDomainInfoErr

Failed to query the domain information.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.MethodNotMatch

Method mismatch.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 129 of 178

Domains

DescribeIntlDomainList：

Last updated 2023-03-28 10:53:02

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to query the "My domains" list.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringRegionNo

StringOffsetNo

Integer

The page number in pagination cases.

Limit

No

Integer

The number of records on each page in pagination cases.

KeyWordNo

String

The domain keyword for fuzzy search.

OrderByRegTime

No

Integer

OrderByExpireTime

No

Integer©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
DescribeIntlDomainList.
Common Params. The value used for this API: 2018-08-08.
Common Params. This parameter is not required for thisAPI.

The registration time sort order. Valid values: 1(descending), 2 (ascending).
The expiration time sort order. Valid values: 1(descending), 2 (ascending).

Page 130 of 178

Domains

StatusNo

String

The domain status.
all : All domains.
UrgentNeedRenew : The domains that are in urgent
need of renewal.
RedemptionPending : The domains that are in urgent
need of redemption.
nosubmit : The domains with unverified identities.
tran : The domains that are being transferred in.

DnsStatus

No

Integer

OrderByDomainName

No

Integer

The DNS type. Valid values: 1 (DNSPod), 2 (others).
The domain sort order. Valid values: 1 (descending), 2(ascending).

3. Output Parameters
Parameter

Type

Description

DomainSet

Array of
IntlDomainInfo

The domain information set.

TotalCount

Integer

The total number of domains.

RequestId

String

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

Name

4. Example
Example1 Getting the list of domains
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntlDomainList<Common request parameters>{"Offset": 20,©2013-2022 Tencent Cloud. All rights reserved.

Page 131 of 178

Domains"Limit": 30}

Output Example{"Response": {"TotalCount": 1,"DomainSet": [{"Status": "xx","IsPremium": true,"DomainId": "xx","CanRenewYears": 0,"DomainName": "xx","RegistrarType": "xx","ModifyStatus": "xx","DnsModifyStatus": "xx","TemplateId": "xx","WhoisPrivacy": 0,"DomainStatus": ["xx"],"Uin": "xx","AutoRenew": 0,"ExpirationDate": "xx","Dns": ["xx"],"ExpireMessage": 0,"DnsStatus": 0,"ContactInfo": {"Province": "xx","City": "xx","OrganizationName": "xx","FirstName": "xx","RegistrantType": "xx","Country": "xx","CompanyName": "xx","RegistrantName": "xx","Telephone": "xx","ZipCode": "xx","Street": "xx","LastName": "xx","Email": "xx"},©2013-2022 Tencent Cloud. All rights reserved.

Page 132 of 178

Domains"SupportDnssec": true,"CreationDate": "xx"}],"RequestId": "xx"}}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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DescribeDomainListErr

Failed to query the "My domains" list.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.MethodNotMatch

Method mismatch.

InternalError.ReadBodyError

Failed to read the body.

©2013-2022 Tencent Cloud. All rights reserved.

Page 133 of 178

Domains

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 134 of 178

Domains

DescribeIntlPhoneEmailList：

Last updated 2023-03-28 10:53:02

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to get the list of verified mobile numbers and email addresses.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeIntlPhoneEmailList.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

Type

Yes

Integer

The type. Valid values: 1 (mobile number), 2 (email address).

Limit

No

Integer

The number of records on each page in pagination cases.

OffsetNo

Integer

The page number in pagination cases.

Name

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 135 of 178

Domains

Parameter
Name
PhoneEmailList

Type

Array of
IntlPhoneEmailLists

TotalCount

IntegerRequestId

StringDescription

The list of verified mobile numbers and email addresses.
The total count.
The unique request ID, which is returned for each request.
RequestId is required for locating a problem.

4. Example
Example1 Getting the list of verified mobile numbers and email addresses
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntlPhoneEmailList<Common request parameters>{"Type": 2,"Limit": 30,"Offset": 0}

Output Example{"Response": {"PhoneEmailList": [{"Code": "1234567@test.com","Type": 2,"CreatedOn": "2021-11-10 14:42:12"}],"TotalCount": 1,"RequestId": "eac6b301-a322-493a-8e36-83b295459398"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 136 of 178

Domains

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DescribePhoneEmailListErr

Failed to get the list of verified mobile numbers and email
addresses.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 137 of 178

Domains©2013-2022 Tencent Cloud. All rights reserved.

Page 138 of 178

Domains

DescribeIntlTemplate：

Last updated 2023-03-28 10:53:02

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to get the details of a registrant profile.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

TemplateId

YesString

The unique ID of a registrant profile.

Description
Common Params. The value used for this API:
DescribeIntlTemplate.

3. Output Parameters
Parameter
Name

Type

Description

Template

IntlTemplateInfo

The details of the registrant profile.

©2013-2022 Tencent Cloud. All rights reserved.

Page 139 of 178

Domains

RequestId

String

The unique request ID, which is returned for each request. RequestId isrequired for locating a problem.

4. Example
Example1 Getting the details of a registrant profile
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntlTemplate<Common request parameters>{"TemplateId": "template-1000q"}

Output Example{"Response": {"RequestId": "xx","Template": {"RegistrantContact": {"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx","AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},
"TechnicalContact": {"Province": "xx","City": "xx","Fax": "xx",©2013-2022 Tencent Cloud. All rights reserved.

Page 140 of 178

Domains"AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx","AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},"CreatedOn": "2020-09-22 00:00:00","AdminContact": {"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx","AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},"Uin": "xx","TemplateId": "xx","BillingContact": {"Province": "xx","City": "xx","Fax": "xx","AddressLine": "xx","FirstName": "xx","CompanyName": "xx","JobTitle": "xx","ZipCode": "xx","AddressLineTwo": "xx","Country": "xx","LastName": "xx","Phone": "xx","Email": "xx"},"UpdatedOn": "2020-09-22 00:00:00","IsDefault": 0}©2013-2022 Tencent Cloud. All rights reserved.

Page 141 of 178

Domains}}

Example2 Getting the details of a registrant profile - failed
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntlTemplate<Common request parameters>{"TemplateId": "template-1000q"}

Output Example{"Response": {"RequestId": "2f36ac98-07f4-4fef-9124-aed4820f5d39"}}

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 142 of 178

Domains

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DescribeTemplateErr

Failed to get the details of the registrant profile.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.MethodNotMatch

Method mismatch.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 143 of 178

Domains

ModifyOwnerIntlBatch：

Last updated 2023-03-28 10:53:02

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to bulk transfer domains to another account.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifyOwnerIntlBatch.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

Domains.N

Yes

Array of
String

The domains.

ToUin

Yes

String

The user ID.

DnsTransfer

No

BooleanWhether to transfer the DNS service.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 144 of 178

Domains

Parameter
Name

Type

Description

LogId

Integer

The ID of the bulk task.

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Bulk transferring domains to another accountInput Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyOwnerIntlBatch<Common request parameters>{"Domains": ["test1.com","test2.com"],"ToUin": "109619400","DnsTransfer": true}

Output Example{"Response": {"LogId": 4,"RequestId": "121323"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 145 of 178

Domains

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.DomainTransferErr

Domain transfer failed.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameter

Invalid parameter.

InvalidParameter.UpTo4000

The number of domains cannot exceed 4,000.

MissingParameter.ActionNotFoundThe route is not defined.

ResourceInsufficient.Overwork

Too many tasks are being executed. Please submit new ones later.

©2013-2022 Tencent Cloud. All rights reserved.

Page 146 of 178

Domains

RenewIntlDomainBatch：

Last updated 2023-03-28 10:53:01

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to bulk renew domains.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
RenewIntlDomainBatch.

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

Domains.N

Yes

Array of
String

The domains to check.

PeriodYes

Integer

The period (1 to 10 years). If this parameter is left empty,
premium domains cannot be checked.

PayModeYes

Integer

Payment method. Valid value: 1 (account balance).

AutoRenewFlag

No

BooleanWhether to enable auto-renewal.

©2013-2022 Tencent Cloud. All rights reserved.

Page 147 of 178

Domains

3. Output Parameters
Parameter

Type

Description

LogId

Integer

The ID of the bulk task.

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Bulk renewing domains
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewIntlDomainBatch<Common request parameters>{"Domains": ["test1.com","test2.com"],"Period": 1,"PayMode": 1,"AutoRenewFlag": false}

Output Example{"Response": {"LogId": 4,"RequestId": "121323"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 148 of 178

Domains

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.RenewDomainFailed

Domain renewal failed. Please try again later.

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InvalidParameter

Invalid parameter.

InvalidParameter.DomainNameIsInvalid

The domain is empty or incorrect.

©2013-2022 Tencent Cloud. All rights reserved.

Page 149 of 178

Domains

InvalidParameter.UpTo4000

The number of domains cannot exceed 4,000.

MissingParameter.ActionNotFoundThe route is not defined.

ResourceInsufficient.Overwork

Too many tasks are being executed. Please submit new ones later.

©2013-2022 Tencent Cloud. All rights reserved.

Page 150 of 178

Domains

SendIntlPhoneEmailCode：

Last updated 2023-03-28 10:53:01

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to send a verification code to a mobile number or an email address.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

Type

Yes

Integer

The type. Valid values: 1 (mobile number), 2 (email address).

Code

Yes

String

The mobile number or email address.

Description
Common Params. The value used for this API:
SendIntlPhoneEmailCode.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 151 of 178

Domains

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Sending a verification code to a mobile phone or an email address
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendIntlPhoneEmailCode<Common request parameters>{"Type": 1,"Code": "18766554433"}

Output Example{"Response": {"RequestId": "eac6b301-a322-493a-8e36-83b295459398"}}

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 NodeJS©2013-2022 Tencent Cloud. All rights reserved.

Page 152 of 178

Domains

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InternalError.SendVerifyCodeErr

Failed to send a verification code.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 153 of 178

Domains

SetIntlDomainAutoRenew：

Last updated 2023-03-28 10:53:01

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to set auto-renewal.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

DomainId

Yes

String

The domain ID.

AutoRenew

Yes

Integer

Name

Description
Common Params. The value used for this API:
SetIntlDomainAutoRenew.

Whether to enable auto-renewal. Valid values: 1 (enable), 2(disable).

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 154 of 178

Domains

Name
RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Setting auto-renewal for a domain
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetIntlDomainAutoRenew<Common request parameters>{"AutoRenew": 0,"DomainId": 0}

Output Example{"Response": {"RequestId": "xx"}}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©2013-2022 Tencent Cloud. All rights reserved.

Page 155 of 178

Domains

Tencent Cloud SDK 3.0 for NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DescribeDomainInfoErr

Failed to query the domain information.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.MethodNotMatch

Method mismatch.

InternalError.ReadBodyError

Failed to read the body.

InternalError.SetDomainAutoRenewErr

Failed to set auto-renewal for domains.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

©2013-2022 Tencent Cloud. All rights reserved.

Page 156 of 178

Domains

TransferProhibitionIntlBatch：

Last updated 2023-03-28 10:53:01

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to bulk set transfer prohibition for domains.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

Domains.N

Yes

StatusYes

Name

Array of
StringBooleanDescription
Common Params. The value used for this API:
TransferProhibitionIntlBatch.

The domain array.
Whether to enable transfer prohibition. Valid values: true
(enable), false (disable).

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 157 of 178

Domains

Parameter

Type

Description

LogId

Integer

The log ID.

RequestId

StringName

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Bulk setting transfer prohibition
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TransferProhibitionIntlBatch<Common request parameters>{"Domains": ["xx"],"Status": true}

Output Example{"Response": {"LogId": 11111111,"RequestId": "xx"}}5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 158 of 178

Domains

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DescribeDomainInfoErr

Failed to query the domain information.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.MethodNotMatch

Method mismatch.

InternalError.ReadBodyError

Failed to read the body.

InternalError.SetTransferProhibitedErr

Failed to cancel transfer prohibition for domains.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

ResourceUnavailable.DomainIsModifyingDNS©2013-2022 Tencent Cloud. All rights reserved.

Unable to perform this operation because an operation of thesame type is in progress for this domain.

Page 159 of 178

Domains

UpdateProhibitionIntlBatch：

Last updated 2023-03-28 10:53:01

1. API Description
Domain name for API request: domain.tencentcloudapi.com.
This API is used to bulk set update prohibition for domains.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI 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 thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2018-08-08.

RegionNo

StringCommon Params. This parameter is not required for this API.

Domains.N

Yes

StatusYes

Name

Array of
StringBooleanDescription
Common Params. The value used for this API:
UpdateProhibitionIntlBatch.

The domain array.
Whether to enable update prohibition. Valid values: true
(enable), false (disable).

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 160 of 178

Domains

Parameter
Name

Type

Description

LogId

Integer

The log ID.

RequestId

String

The unique request ID, which is returned for each request. RequestId is required forlocating a problem.

4. Example
Example1 Bulk setting update prohibition
Input Example
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateProhibitionIntlBatch<Common request parameters>{"Domains": ["xx"],"Status": true}

Output Example{"Response": {"LogId": 111,
"RequestId": "xx"}}5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 161 of 178

Domains

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 NodeJS
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DescribeDomainInfoErr

Failed to query the domain information.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.MethodNotMatch

Method mismatch.

InternalError.ReadBodyError

Failed to read the body.

InternalError.SetUpdateProhibitedErr

Failed to cancel update prohibition for domains.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

MissingParameter.ActionNotFoundThe route is not defined.

ResourceUnavailable.DomainIsModifyingDNS©2013-2022 Tencent Cloud. All rights reserved.

Unable to perform this operation because an operation of thesame type is in progress for this domain.

Page 162 of 178

Domains

Data Types：

Last updated 2023-03-28 10:48:39

AdminContact
The admin contact.
Used by actions: CreateIntlTemplate, DescribeIntlTemplate, DescribeIntlTemplateList.
Name

Type

Required

Description

FirstName

StringYes

The first name.

LastName

StringYes

The last name.

Country

StringYes

The country or region name, such as CN .

Province

StringYes

The province or state name.

City

StringYes

The city name.

AddressLine

StringYes

The address line 1.

ZipCodeStringYes

The zip code.

Email

StringYes

The email address.

Phone

StringYes

The mobile number, such as +86.13600000000 .
The company or organization name.

CompanyName

JobTitle

StringString

No

No

Note: This field may return null, indicating that no valid values canbe obtained.
The job title.
Note: This field may return null, indicating that no valid values canbe obtained.

AddressLineTwo

String

No

The address line 2.
Note: This field may return null, indicating that no valid values canbe obtained.

Fax

String

No

The fax number.
Note: This field may return null, indicating that no valid values canbe obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 163 of 178

Domains

BatchDomainBuyDetails
The log details of bulk domain purchase
Used by actions: DescribeIntlDomainBatchDetails.
Name

Type

Description

Id

Integer

The details ID.
The bulk operation type. Valid values: new (register domains),
batch_transfer_prohibition_on (enable transfer prohibition),

ActionStringbatch_transfer_prohibition_off (disable transfer prohibition),batch_update_prohibition_on (enable update prohibition),batch_update_prohibition_off (disable update prohibition).

DomainString

The domains.

StatusString

The status. Valid values: SUCCESS , FAILURE
The reason for failure.

ReasonStringNote: This field may return null, indicating that no valid values can beobtained.

CreatedOn

String

The creation time.

UpdatedOn

String

The update time.
Null: The DNS service is not transferred. false : The DNS service failed

TransferDnsResult

Booleanto be transferred. true : The DNS service is transferred successfully.
Note: This field may return null, indicating that no valid values can beobtained.
The reason for failure, expressed in Chinese.

ReasonZh

StringNote: This field may return null, indicating that no valid values can beobtained.
The payment status.

PayStatus

Integer

Note: This field may return null, indicating that no valid values can beobtained.

BatchDomainBuyLog
The log of bulk domain purchase©2013-2022 Tencent Cloud. All rights reserved.

Page 164 of 178

Domains

Used by actions: DescribeIntlBatchOperationLogs.
Name

Type

Description

LogId

Integer

The log ID.
The bulk operation type. Valid values: new (register domains),
batch_transfer_prohibition_on (enable transfer prohibition),

ActionStringbatch_transfer_prohibition_off (disable transfer prohibition),batch_update_prohibition_on (enable update prohibition),batch_update_prohibition_off (disable update prohibition).

NumberInteger

The quantity.

StatusString

The execution status. Valid values: doing , done

CreatedOn

String

The submission time.

BillingContact
The contact person for bills.
Used by actions: CreateIntlTemplate, DescribeIntlTemplate, DescribeIntlTemplateList.
Name

Type

Required

Description

FirstName

StringYes

The first name.

LastName

StringYes

The last name.

Country

StringYes

The country or region name, such as CN .

Province

StringYes

The province or state name.

City

StringYes

The city name.

AddressLine

StringYes

The address line 1.

ZipCodeStringYes

The zip code.

Email

StringYes

The email address.

Phone

StringYes

The mobile number, such as +86.13600000000 .

CompanyName

String

No

The company or organization name.
Note: This field may return null, indicating that no valid values can©2013-2022 Tencent Cloud. All rights reserved.

Page 165 of 178

Domains

be obtained.
The job title.
JobTitle

AddressLineTwo

StringStringNo

Note: This field may return null, indicating that no valid values canbe obtained.
The address line 2.
Note: This field may return null, indicating that no valid values canNobe obtained.

Fax

String

The fax number.
Note: This field may return null, indicating that no valid values canNobe obtained.

IntlBatchDetails
The details of the bulk task
Used by actions: DescribeIntlBatchDetailStatus.
Name

Type

Description

Id

Integer

The ID of the bulk task.

StatusString

The task status.

ReasonString

The reason.

ReasonZh

String

The reason, expressed in Chinese.

IntlContactInfo
The contact information.
Used by actions: DescribeIntlDomain, DescribeIntlDomainList.
Name

Type

Description

City

String

The city name.

Country

String

The country or region name.

Email

String

The email address.

©2013-2022 Tencent Cloud. All rights reserved.

Page 166 of 178

Domains

OrganizationName

String

The domain registrant.

Province

String

The province or state name.

RegistrantName

String

The name of the registrant.

RegistrantType

String

The registrant type. Valid values: I (individual), E (organization).

StreetString

The detailed address.

Telephone

String

The mobile number.

ZipCodeString

The zip code.

FirstName

String

The first name.

LastName

String

The last name.

CompanyName

String

The company name.

IntlDomainInfo
The domain information set.
Used by actions: DescribeIntlDomain, DescribeIntlDomainList.
Name

Type

Description

AutoRenew

Integer

CreationDate

String

The registration time.

DomainId

String

The domain ID.

DnsStatus

Integer

DomainName

String

The domains.

DomainStatus

Array of String

The domain status.

StatusString

The purchase status of the domain. Valid values:

The auto-renewal flag. Valid values: 0 (disabled by default), 1(enabled), 2 (disabled).

The DNS status. Valid values: 1 (DNSPod), 2 (others), 3(unknown).

ok : Normal.
RegisterPending : Pending registration.
RegisterDoing : Registration in progress.

©2013-2022 Tencent Cloud. All rights reserved.

Page 167 of 178

Domains

RegisterFailed : Registration failed.
RenewPending : Renewal grace period.
RenewDoing : Renewing.
RedemptionPending : Redemption period.
AboutToExpire : About to expire.
TransferPending : Pending transfer.
TransferTransing : Transfer in progress.
TransferFailed : Transfer failed.
ExpirationDate

String

The expiration date.

ExpireMessage

Integer

IsPremium

BooleanWhether the domain is a premium one.

Dns

Array of String

The DNS server of the domain.

ContactInfo

IntlContactInfo

The contact information.

The auto-renewal flag. Valid values: 1 (enabled), 2 (disabled), 3(disabled by default).

The number of years available for renewal. The value 0 indicates that
CanRenewYears

Integer

RegistrarType

StringUin

String

The account to which the domain belongs.

TemplateId

String

The profile ID.

SupportDnssec

BooleanWhether DNSSEC is supported.

WhoisPrivacy

Integer

ModifyStatus

String

DnsModifyStatus

Stringthe domain has reached its maximum validity period (10 years) andcannot be renewed.
The registrar type. If the value is epp , the registration time on thepage is followed by (UTC). Otherwise, it is followed by (UTC+8).

WHOIS privacy service status. Valid values: 1 (enabled), 2(disabled), 3 (enabling), 4 (disabling).
Valid values: NotModify (not modified), Modifying , Failed(failed to modify)
Valid values: NotModify (not modified), Modifying , Failed(failed to modify)

IntlPhoneEmailLists
The list of verified mobile numbers and email addresses.

©2013-2022 Tencent Cloud. All rights reserved.

Page 168 of 178

Domains

Used by actions: DescribeIntlPhoneEmailList.
Name

Type

Description

CodeString

The mobile number or email address.

Type

Integer

The type. Valid values: 1 (mobile number), 2 (email address).

CreatedOn

String

The verification time.

IntlTemplate
The details of the registrant profile.
Used by actions: DescribeIntlTemplateList.
Name

Type

Description

RegistrantContact

RegistrantContact

The registrant contact.

AdminContact

AdminContact

The admin contact.

TechnicalContact

TechnicalContact

The technical contact.

BillingContact

BillingContact

The contact person for bills.

CreatedOn

Timestamp

The creation time.

TemplateId

String

The profile ID.

IsDefault

Integer

Whether the profile is the default one.

UpdatedOn

Timestamp

The last update time.

IntlTemplateInfo
The registrant profile details.
Used by actions: DescribeIntlTemplate.
Name

Type

Description

RegistrantContact

RegistrantContact

The registrant contact.

©2013-2022 Tencent Cloud. All rights reserved.

Page 169 of 178

Domains

AdminContact

AdminContact

The admin contact.

TechnicalContact

TechnicalContact

The technical contact.

BillingContact

BillingContact

The contact person for bills.

CreatedOn

Timestamp

The creation time.

TemplateId

String

The profile ID.

TemplateType

StringUpdatedOn

Timestamp

The last updated time.

Uin

String

The account ID.

IsDefault

Integer

Whether the profile is the default one.

The registrant type. Valid values: I (individual), E(organization).

PriceInfoNew
The price information of the domains.
Used by actions: DescribeIntlDomainPriceNewList.
Name

Type

Description

Tld

String

The domain suffix, such as .com .

Year

Integer

The purchase years. Value range: [1-10]

Price

Float

The original price of the domain.

RealPrice

Float

The current price of the domain.

Operation

StringTitle

String

The domain purchase type. Valid values: new , renew , redem (redeem),tran (transfer in).
The title.
Note: This field may return null, indicating that no valid values can be obtained.

RegistrantContact
The registrant contact.

©2013-2022 Tencent Cloud. All rights reserved.

Page 170 of 178

Domains

Used by actions: CreateIntlTemplate, DescribeIntlTemplate, DescribeIntlTemplateList.
Name

Type

Required

Description

FirstName

StringYes

The first name.

LastName

StringYes

The last name.

Country

StringYes

The country or region name, such as CN .

Province

StringYes

The province or state name.

City

StringYes

The city name.

AddressLine

StringYes

The address line 1.

ZipCodeStringYes

The zip code.

Email

StringYes

The email address.

Phone

StringYes

The mobile number, such as +86.1360000000 .

No

The company or organization name.
Note: This field may return null, indicating that no valid values canCompanyName

Stringbe obtained.

JobTitle

String

No

The job title.
Note: This field may return null, indicating that no valid values canbe obtained.
The address line 2.

AddressLineTwo

StringNo

Note: This field may return null, indicating that no valid values canbe obtained.
The fax number.

Fax

StringNo

Note: This field may return null, indicating that no valid values canbe obtained.

TechnicalContact
The technical contact.
Used by actions: CreateIntlTemplate, DescribeIntlTemplate, DescribeIntlTemplateList.
Name

Type

Required©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 171 of 178

Domains

FirstName

StringYes

The first name.

LastName

StringYes

The last name.

Country

StringYes

The country or region name, such as CN .

Province

StringYes

The province or state name.

City

StringYes

The city name.

AddressLine

StringYes

The address line 1.

ZipCodeStringYes

The zip code.

Email

StringYes

The email address.

Phone

StringYes

The mobile number, such as +86.13600000000 .

No

The company or organization name.
Note: This field may return null, indicating that no valid values canCompanyName

Stringbe obtained.
The job title.
JobTitle

StringNo

Note: This field may return null, indicating that no valid values canbe obtained.
The address line 2.

AddressLineTwo

StringNo

Note: This field may return null, indicating that no valid values canbe obtained.
The fax number.

Fax

StringNo©2013-2022 Tencent Cloud. All rights reserved.

Note: This field may return null, indicating that no valid values canbe obtained.

Page 172 of 178

Domains

Error Codes：

Last updated 2023-03-28 10:48:39

Feature Description
If there is an Error field in the response, it means that the API call failed. For example:{"Response": {"Error": {"Code": "AuthFailure.SignatureFailure","Message": "The provided credentials could not be validated. Please check your si
gnature is correct."},"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"}}
Code in Error indicates the error code, and Message indicates the specific information of the error.

Error Code List
Common Error Codes
Error CodeDescription

ActionOffline

This API has been deprecated.

AuthFailure.InvalidAuthorization

Authorization in the request header is invalid.

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

AuthFailure.MFAFailure

MFA failed.
Key does not exist. Check if the key has been

AuthFailure.SecretIdNotFound

deleted or disabled in the console, and if not, checkif the key is correctly entered. Note that whitespaces
should not exist before or after the key.

AuthFailure.SignatureExpire©2013-2022 Tencent Cloud. All rights reserved.

Signature expired. Timestamp and server timecannot differ by more than five minutes. Please

Page 173 of 178

Domains

ensure your current local time matches the standard
time.
Invalid signature. Signature calculation error. Please
AuthFailure.SignatureFailure

ensure you’ve followed the signature calculation
process described in the Signature API
documentation.

AuthFailure.TokenFailure
AuthFailure.UnauthorizedOperation

DryRunOperation

Token error.
The request is not authorized. For more information,
see the CAM documentation.
DryRun Operation. It means that the request would
have succeeded, but the DryRun parameter wasused.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidAction

The API does not exist.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Invalid parameter value.

InvalidRequest

The multipart format of the request body is incorrect.

IpInBlacklist

Your IP is in uin IP blacklist.

IpNotInWhitelistYour IP is not in uin IP whitelist.

LimitExceeded

Quota limit exceeded.

MissingParameter

A parameter is missing.

NoSuchProduct

The product does not exist.

NoSuchVersion

The API version does not exist.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

RequestLimitExceeded.GlobalRegionUinLimitExceeded

Uin exceeds the frequency limit.

RequestLimitExceeded.IPLimitExceeded

The number of ip requests exceeds the frequency
limit.

RequestLimitExceeded.UinLimitExceeded

The number of uin requests exceeds the frequency©2013-2022 Tencent Cloud. All rights reserved.

Page 174 of 178

Domains

limit.
RequestSizeLimitExceeded

The request size exceeds the upper limit.

ResourceInUse

Resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

Resource is unavailable.

ResponseSizeLimitExceeded

The response size exceeds the upper limit.

ServiceUnavailable

Service is unavailable now.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

UnsupportedProtocol
UnsupportedRegion

HTTP(S) request protocol error; only GET and
POST requests are supported.
API does not support the requested region.

Service Error Codes
Error CodeDescription

FailedOperation.CheckDomainFailed

Domain name query failed. Please try thisfeature again later.

FailedOperation.CreateTemplateFailed

Failed to create the registrant profile.

FailedOperation.DescribeDomainListFailed

Failed to get the domain information. Please
try again later.

FailedOperation.DescribeTemplateFailed

Failed to query the registrant profile.

FailedOperation.DomainPriceListFailed

Failed to get the domain price list.

FailedOperation.RegisterDomain

Domain registration failed. Please try again
later.

FailedOperation.RegisterDomainFailed

Domain registration failed. Please try again
later.

©2013-2022 Tencent Cloud. All rights reserved.

Page 175 of 178

Domains

FailedOperation.RenewDomainFailed
FailedOperation.SetDomainDnsFailed

FailedOperation.TemplateMaxNumFailed

Domain renewal failed. Please try again later.
Failed to modify the DNS server. Enter acorrect DNS server address.
The number of registrant profiles hasreached the maximum number allowed.
Delete a profile and try again.

FailedOperation.TransferInDomainFailed

Failed to transfer the domain in. Please try
again later.

InternalError.AddPhoneEmailErr

Failed to add the mobile number or email
address.

InternalError.CheckDnAvailableErr

Failed to get check data.

InternalError.CheckVerifyCodeErr

Failed to verify the verification code.

InternalError.DeletePhoneEmailVerifyErr

Failed to delete the mobile number or email
address.

InternalError.DeleteTemplateErr

Failed to delete the registrant profile.

InternalError.DescribeDomainInfoErr

Failed to query the domain information.

InternalError.DescribeDomainListErr

Failed to query the "My domains" list.

InternalError.DescribePhoneEmailListErr

InternalError.DescribeTemplateErr

Failed to get the list of verified mobile
numbers and email addresses.
Failed to get the details of the registrant
profile.

InternalError.DomainInternalError

Network error. Please try again later.

InternalError.DomainTransferErr

Domain transfer failed.

InternalError.ForbiddenRequest

Forbidden request.

InternalError.JsonMarshal

Error in converting to JSON.

InternalError.MethodNotMatch

Method mismatch.

InternalError.NeedLogin

Login is required.

InternalError.ReadBodyError

Failed to read the body.

InternalError.SendVerifyCodeErr

Failed to send a verification code.

©2013-2022 Tencent Cloud. All rights reserved.

Page 176 of 178

Domains

InternalError.SetDomainAutoRenewErr
InternalError.SetTransferProhibitedErr

InternalError.SetUpdateProhibitedErr

Failed to set auto-renewal for domains.
Failed to cancel transfer prohibition fordomains.
Failed to cancel update prohibition fordomains.

InternalError.VerifiedPhoneEmailErr

The mobile number or email address has
already been verified.

InternalError.VerifyCodeErr

Incorrect verification code.

InvalidParameter.CertificateCodeIsInvalid

Incorrect qualification information.

InvalidParameter.CertificateImageIsInvalid

Incorrect qualification photo.

InvalidParameter.CustomDnsNotAllowed

You have no permission to customize DNS
servers.

InvalidParameter.DomainNameIsInvalid

The domain is empty or incorrect.

InvalidParameter.EmailIsInvalid

The email address is empty or incorrect.

InvalidParameter.FirstNameIsInvalid

The first name is empty or incorrect.

InvalidParameter.LastNameIsInvalid

The last name is empty or incorrect.

InvalidParameter.NameIsInvalid

The contact person is empty or incorrect.

InvalidParameter.OrgIsInvalid

The registrant is empty or incorrect.

InvalidParameter.PackageResourceIdInvalid

Invalid package ID.

InvalidParameter.RepTypeIsInvalid

Invalid request type.

InvalidParameter.StreetIsInvalid
InvalidParameter.TelephoneIsInvalid
InvalidParameter.UpTo4000

Incorrect address. Please enter a correctone.
The mobile number is empty or invalid.
The number of domains cannot exceed
4,000.

InvalidParameter.UserTypeIsInvalid

The user type is empty or invalid.

InvalidParameter.ZipCodeIsInvalid

The zip code is empty or invalid.

InvalidParameterValue.InvalidParameterFormat

Invalid parameter value.

©2013-2022 Tencent Cloud. All rights reserved.

Page 177 of 178

Domains

MissingParameter.ActionNotFoundThe route is not defined.

MissingParameter.DomainIsEmpty

The domain cannot be empty.

MissingParameter.RepDataIsNone

The request data cannot be empty.

MissingParameter.TemplateIdIsEmpty

The profile ID is empty or invalid.

MissingParameter.TemplateIdIsExist

This profile already exists.

ResourceInsufficient.Overwork
ResourceNotFound.ApprovedTemplateNotFound
ResourceNotFound.DomainNotFound

ResourceNotFound.TemplateNotFoundToo many tasks are being executed. Pleasesubmit new ones later.
The identity is not verified for the profile.
The domain address is incorrect. Please
enter a correct one.
The profile information is incorrect. Please
set information correctly.
Unable to perform this operation because an

ResourceUnavailable.DomainIsModifyingDNS

UnsupportedOperation.ModifyDomainInfoOperateUnsupported

UnsupportedOperation.ModifyDomainInfoUnsupported

UnsupportedOperation.ModifyDomainUnsupported©2013-2022 Tencent Cloud. All rights reserved.

operation of the same type is in progress forthis domain.
This operation is unavailable under thecurrent domain status.
Modification is unavailable under the current
domain status.
Modification is unavailable under the current
domain status.

Page 178 of 178