获取证书的检查结果

最近更新时间:2024-11-01 12:03:23

我的收藏

1. 接口描述

接口请求域名: waf.tencentcloudapi.com 。

获取证书的检查结果

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCertificateVerifyResult。
Version String 公共参数,本接口取值:2018-01-25。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Domain String 域名
示例值:randy.qcloudwaf.com
CertType Integer 证书类型。 0:不检测国际标准证书 1:证书来源为自有证书 2:证书来源为托管证书
示例值:1
Certificate String CertType为1时,需要填充此参数,表示自有证书的证书链
示例值:-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----
CertID String CertType为2时,需要填充此参数,表示腾讯云SSL平台托管的证书id
示例值:bKnSQLs
PrivateKey String CertType为1时,需要填充此参数,表示自有证书的私钥
示例值:-----BEGIN RSA PRIVATE KEY----- xxx -----END RSA PRIVATE KEY-----
GmCertType Integer 国密证书类型。0:不检测国密证书 1:证书来源为自有国密证书 2:证书来源为托管国密证书
示例值:0
GmCert String GmCertType为1时,需要填充此参数,表示自有国密证书的证书链
示例值:-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----
GmPrivateKey String GmCertType为1时,需要填充此参数,表示自有国密证书的私钥
示例值:-----BEGIN PRIVATE KEY----- xxx -----END PRIVATE KEY-----
GmEncCert String GmCertType为1时,需要填充此参数,表示自有国密证书的加密证书
示例值:-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----
GmEncPrivateKey String GmCertType为1时,需要填充此参数,表示自有国密证书的加密证书的私钥
示例值:-----BEGIN PRIVATE KEY----- xxx -----END PRIVATE KEY-----
GmSSLId String GmCertType为2时,需要填充此参数,表示腾讯云SSL平台托管的证书id
示例值:aKnKQLJ

3. 输出参数

参数名称 类型 描述
Status Integer 状态码。
0:证书正常
310:证书异常
311:证书过期
312:证书即将过期
示例值:0
Detail Array of String 错误详情
示例值:["x509: certificate is valid for *.testwaf.com, testwaf.com, not test.qcloudwaf.com"]
NotAfter String 过期时间
示例值:"2024-04-05 23:59:59"
Changed Integer 证书是否改变。
0:未变化
1:有变化
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取证书校验结果

输入示例

https://waf.tencentcloudapi.com/?Action=DescribeCertificateVerifyResult
&Domain=randy.qcloudwaf.com
&CertType=1
&CertID=D3a93
&<公共请求参数>

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidCertificate 证书内容非法。
InvalidParameter.QueryCertBySSLIDFailed 根据ID查询证书失败。
InvalidParameterValue 参数取值错误。
ResourceUnavailable 资源不可用。