CheckCnameStatus
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
When the site access type is CNAME, all domain names under the site must configure CNAME records as specified by the CNAME domain assigned by EdgeOne.
You can obtain the designated CNAME domain name assigned by EdgeOne for the integration domain through this API, and validate the configuration status of the CNAME for the integration domain through this API.
A maximum of 20 requests can be initiated per second for this API.
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: CheckCnameStatus. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | Site ID. |
| RecordNames.N | Yes | Array of String | The domain name list that need to detect CNAME configuration state can be: |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| CnameStatus | Array of CnameStatus | Integration of the CNAME of the domain name configuration status information list. |
| 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 Validate CNAME Configuration Status
Perform CNAME configuration status verification for the domain name test.qq.com. The result is active (CNAME configuration is completed). EdgeOne assigns the CNAME domain test.qq.com.eo.dnse0.com to the domain name.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckCnameStatus
<Common request parameters>
{
"ZoneId": "zone-20hyebgyfsko",
"RecordNames": [
"example.qq.com"
]
}Output Example
{
"Response": {
"CnameStatus": [
{
"RecordName": "test.qq.com",
"Cname": "test.qq.com.eo.dnse0.com",
"Status": "active"
}
],
"RequestId": "d08bed0d-15bf-4d65-ab56-906aee0c845"
}
}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 |
|---|---|
| InternalError.ProxyServer | An unknown error occurred in the backend server. |
| UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
| UnauthorizedOperation.NoPermission | The sub-account is not authorized for the operation. Please get permissions first. |
| UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |