获取证书列表

最近更新时间:2019-09-26 20:39:45

1. 接口描述

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

本接口(DescribeCertList)用于获取证书列表。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCertList
Version String 公共参数,本接口取值:2018-04-26
Region String 公共参数,本接口不需要传递此参数。
ModuleType String 模块名称,应填ssl
Offset Integer 页数,默认第一页
Limit Integer 每页条数,默认每页20条
SearchKey String 搜索关键字
CertType String 证书类型(目前支持:CA=客户端证书,SVR=服务器证书)
Id String 证书id
WithCert String 是否同时获取证书内容
AltDomain String 如传,则只返回可以给该域名使用的证书

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数量
CertificateSet Array of SSLCertificate 列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取证书列表

输入示例

https://wss.tencentcloudapi.com/?Action=DescribeCertList
&Page=1
&Count=1
&SearchKey=as
&ProjectId=1000
&CertType=CA
&Id=sad
&WithCert=1
&AltDomain=asd
&ModuleType=ssl
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalNum": 12,
    "List": [
      {
        "OwnerUin": "664372747",
        "ProjectId": "0",
        "From": "trustasia",
        "Type": "2",
        "CertType": "SVR",
        "ProductZhName": "TrustAsia TLS RSA CA",
        "Domain": "cl.f-xj.cn",
        "Alias": "",
        "Status": 1,
        "VulnerabilityStatus": "INACTIVE",
        "StatusMsg": null,
        "VerifyType": "DNS_AUTO",
        "CertBeginTime": "2017-12-20 08:00:00",
        "CertEndTime": "2018-12-20 20:00:00",
        "ValidityPeriod": "12",
        "InsertTime": "2017-12-20 21:25:00",
        "ProjectInfo": {
          "ProjectId": "0",
          "OwnerUin": 0,
          "name": "默认项目",
          "CreatorUin": 0,
          "CreateTime": "0000-00-00 00:00:00",
          "Info": "默认项目"
        },
        "Id": "GjTNRoK7",
        "SubjectAltName": [
          "cl.f-xj.cn"
        ],
        "TypeName": "TrustAsia TLS RSA CA",
        "StatusName": "已通过",
        "IsVip": false,
        "IsDv": true,
        "IsWildcard": false,
        "IsVulnerability": false
      }
    ]
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.DomainInternalError 网络错误,请稍后重试。
InvalidParameter 参数错误。
InvalidParameter.RepTypeIsInvalid 请求类型错误。