Release Notes and Announcements

Release Notes

Product Announcement

Security Advisory

User Guide

Product Introduction

Overview

Product Category

Strengths

Scenarios

Plans and Editions

Supported Regions

Basic Concepts

Purchase Guide

Billing Overview

Purchase Guide

WAF Plan Upgrade Method

Renewing Connections

Payment Overdue

Refund

Getting Started

FAQs for Beginners

Operation Guide

Overview

Connection Management

Security Operations

Protection Policies

Service Settings

Practical Tutorial

WAF CCP Overview

Bot Management

API Security

Integration

Protection Configuration

API Documentation

History

Introduction

API Category

Making API Requests

Asset Management APIs

Billing APIs

Protection Settings APIs

Other APIs

IP Management APIs

Integration APIs

Log Service APIs

Security Overview APIs

Rule Engine APIs

Data Types

Error Codes

FAQS

Product Consultation

Connection

Usage

Permissions

Sandbox Isolation Status

Service Level Agreement

WAF Policy

Data Processing And Security Agreement

Glossary

DescribeCertificateVerifyResult

PDF

Focus Mode

Font Size

Last updated: 2025-10-30 22:08:59

1. API Description

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

Obtain certificate inspection result

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: DescribeCertificateVerifyResult.
Version	Yes	String	Common Params. The value used for this API: 2018-01-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul, ap-singapore.
Domain	Yes	String	Domain name
CertType	No	Integer	Certificate type. 0: Do not check international standard certificates; 1: The certificate is a self-owned certificate; 2: The certificate is a managed certificate.
Certificate	No	String	When CertType is 1, this parameter is required, indicating the self-owned certificate chain
CertID	No	String	When CertType is 2, this parameter must be filled, indicating the certificate ID hosted on Tencent Cloud's SSL platform
PrivateKey	No	String	When CertType=1, this parameter is required, indicating the private key of the self-owned certificate.
GmCertType	No	Integer	SM certificate type. 0: Do not check SM certificates; 1: The certificate is a self-owned SM certificate; 2: The certificate is a managed SM certificate.
GmCert	No	String	When GmCertType is 1, this parameter needs to be set, indicating the certificate chain of the self-owned SM certificate.
GmPrivateKey	No	String	When GmCertType is 1, this parameter needs to be set, indicating the private key of the self-owned SM certificate.
GmEncCert	No	String	When GmCertType is 1, this parameter needs to be set, indicating the encryption certificate of the self-owned SM certificate.
GmEncPrivateKey	No	String	When GmCertType is 1, this parameter needs to be set, indicating the private key of the encryption certificate for the self-owned SM certificate.
GmSSLId	No	String	When GmCertType is 2, this parameter needs to be set, indicating the ID of the certificate managed by the Tencent Cloud SSL platform.

3. Output Parameters

Parameter Name	Type	Description
Status	Integer	Status code 0: normal certificate 310: abnormal certificate 311: certificate expired 312: certificate about to expire
Detail	Array of String	Error details
NotAfter	String	Expiration time
Changed	Integer	Whether the certificate is changed 0: not changed 1: changed Note: This field may return null, indicating that no valid values can be obtained.
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 Obtaining the Certificate Verification Result

Input Example

https://waf.intl.tencentcloudapi.com/?Action=DescribeCertificateVerifyResult
&Domain=test1.testwaf.com
&CertType=1
&CertID=D3a93
&<Common request parameters>

Output Example

{
    "Response": {
        "Changed": 0,
        "Detail": [
            "x509: certificate is valid for *.testwaf.com, testwaf.com, not randy.qcloudwaf.com"
        ],
        "NotAfter": "2024-04-05 23:59:59",
        "RequestId": "a4824af0-ae9c-470e-b6c3-8d2a3bf89a18",
        "Status": 310
    }
}

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

Tencent Cloud CLI 3.0

6. Error Code

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

Error Code	Description
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameter.InvalidCertificate	Invalid certificate content.
InvalidParameter.QueryCertBySSLIDFailed	Failed to query certificate by ID.
InvalidParameterValue	Invalid parameter value.
ResourceUnavailable	Resources are unavailable.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Web Application Firewall