DescribeIdentifications
1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the verification information of a site.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeIdentifications. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| Filters.N | Yes | Array of Filter | Filter conditions. The maximum value for Filters.Values is 20. The detailed conditions are as follows: |
| Offset | No | Integer | The page offset. Default value: 0 |
| Limit | No | Integer | The paginated query limit. Default value: 20. Maximum value: 1000. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible sites. |
| Identifications | Array of Identification | The site verification information. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying the verification status of a site
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIdentifications
<Common request parameters>
{
"Limit": 20,
"Filters": [
{
"Values": [
"example.com"
],
"Name": "zone-name"
}
],
"Offset": 0
}
Output Example
{
"Response": {
"Identifications": [
{
"ZoneName": "example.com",
"Status": "pending",
"Ascription": {
"Subdomain": "edgeonereclaim",
"RecordType": "TXT",
"RecordValue": "reclaim-a24aba2420cf4ce8b7bff7c8be6d337f"
},
"OriginalNameServers": [
"ns1.example.com",
"ns2.example.com"
],
"FileAscription": {
"IdentifyContent": "88v24mnnljwbhaohrpfx80f63duhdnjx",
"IdentifyPath": "/.well-known/teo-verification/vd4ewuqa9n.txt"
}
}
],
"TotalCount": 1,
"RequestId": "8gs50b24-7df5-47f4-96ae-95825d53er3c"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| OperationDenied.DomainInShareCnameGroup | Switch failed: There are domain names in the shared CNAME group. |
| OperationDenied.ErrZoneIsAlreadyPaused | The EdgeOne service of the site is disabled. Please enable it and try again. |
| OperationDenied.ResourceLockedTemporary | This operation conflicts with concurrent operations. Try again later. |
| ResourceNotFound | The resource doesn’t exist. |
| ResourceUnavailable | The resource is unavailable. |