当前内容仅提供英语版本，中文版我们将尽快补充，感谢您的理解。
文档概览/
CheckFreeCertificateVerification/

CheckFreeCertificateVerification

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to verify a free certificate and obtain the application result. If verified, you can query the free certificate information for the corresponding domain name application through this API. If failed to apply, this API will return the corresponding verification failure message.
This API is used to check the free certificate application result after triggering the ApplyFreeCertificate . Once the application is successful, you need to configure through the ModifyHostsCertificate to deploy the free certificate to the acceleration domain.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: CheckFreeCertificateVerification.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringZone ID.
DomainYesStringAcceleration domain name, that domain name used when applying for free certificate.

3. Output Parameters

Parameter NameTypeDescription
CommonNameStringSpecifies the domain name to which the certificate is issued when the free certificate application succeeds.
Note: only one free certificate can be applied for a domain name. if a wildcard certificate has been applied for the domain name, its subdomains will use the wildcard certificate.
SignatureAlgorithmStringSpecifies the signature algorithm used by the certificate when the free certificate application succeeds. currently only support RSA 2048.
ExpireTimeTimestamp ISO8601Expiration time of the certificate when the free certificate application is successful. the time is in coordinated universal time (UTC), following the ISO 8601 standard date and time format.
RequestIdStringThe 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 Checking Free Certificate Application Result, Free Certificate Application Failed

This example shows you how to check whether the free certificate application succeeds for the domain name (cc.xzone.cloud) under the site (ZoneId is zone-28v607hq8d3m) after triggering the application.

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckFreeCertificateVerification
<Common request parameters>

{
    "ZoneId": "zone-28v607hq8d3m",
    "Domain": "cc.xzone.cloud"
}

Output Example

{
    "Response": {
        "Error": {
            "Code": "ResourceUnavailable.RecordUnExpected",
            "Message": "Unable to detect the verification value correctly. Please check whether the current domain name has configured regional resolution or policy interception."
        },
        "RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"
    }
}

Example2 Checking Free Certificate Application Result, Free Certificate Application Succeeds

This example shows you how to check whether the free certificate application succeeds for the domain name (aa.xzone.cloud) under the site (ZoneId zone-28v607hq8d3m) after triggering the free certificate application.

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckFreeCertificateVerification
<Common request parameters>

{
    "ZoneId": "zone-28v607hq8d3m",
    "Domain": "aa.xzone.cloud"
}

Output Example

{
    "Response": {
        "RequestId": "dc1ba58b-4e4e-4a71-bed6-2b777c48d17e",
        "CommonName": "aa.xzone.cloud",
        "SignatureAlgorithm": "RSA 2048",
        "ExpireTime": "2025-07-31T07:06:57Z"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.