You need to enable JavaScript to run this app.
导航
内容分发网络
  • 文档首页
    • /内容分发网络/API 参考/证书管理接口/获取证书列表
获取证书列表
最近更新时间：2024.06.28 19:18:53首次发布时间：2022.07.18 15:12:00
我的收藏

获取符合过滤条件的证书的信息。这些证书可以是服务器证书，也可以是 CA 证书。该 API 返回的是那些能与或者已经与您账号下的加速域名关联的证书。

使用限制

节流限制：您每秒最多可发送 20 个请求。

请求说明

  • 请求方式：POST
  • 请求地址：https://cdn.volcengineapi.com/?Action=ListCertInfo&Version=2021-03-01

请求参数

Query

参数名称
数据类型
是否必选
参数说明
Action
String
是
接口名称。当前 API 的名称为 ListCertInfo。
Version
String
是
接口版本。当前 API 的版本为 2021-03-01。

Body

参数名称
数据类型
是否必选
参数说明
示例
Source
String
是

表示证书托管的位置，获取托管在该位置的那些证书。该参数有以下取值：

  • volc_cert_center：表示火山引擎证书中心。
  • cdn_cert_hosting：表示火山引擎内容分发网络（CDN）。
volc_cert_center
CertId
String
否

表示一个证书的 ID，用于过滤证书，以获取该 ID 的证书。

如果不指定该参数，表示不使用该参数对 API 返回的证书列表进行过滤。
cert-602fc4eb6cbf4b9351b54bedf2bc5dc5
ConfiguredDomain
String
否

表示一个加速域名列表，用于过滤证书，以获取与列表中任意加速域名关联的那些证书。多个加速域名之间使用逗号（,）分隔。列表中可以包含泛域名。

如果不指定该参数，表示不使用该参数对 API 返回的证书列表进行过滤。
www.example.com,www.test.com
Name
String
否

表示一个加速域名，用于过滤证书，以获取 SAN 字段中包含该域名的那些证书。该加速域名可以是泛域名。

如果您查询的是 CA 证书，该参数无效。

如果不指定该参数，表示不使用该参数对 API 返回的证书列表进行过滤。
*.example.com
PageNum
Long
否

对于符合过滤条件的证书列表，该参数表示一个页码，该 API 实际展示的证书是该页码所指定的分页上的那些证书。

该 API 返回的证书是根据 PageSize 而分页的。假设该 API 返回的证书数量是 100，您指定的 PageSize 是 10，那么返回的证书是分布在 10 个页上。如果您指定的 PageNum 是 2，表示获取第 2 页上的那些证书。

如果您指定的分页上没有证书，则返回结果中 CertInfo 参数的值为 null。

PageNum 的默认值是 1。
1
PageSize
Long
否

表示每个分页包含的证书数量。

该参数的取值范围是 1-200，默认值是 10。
5
Status
String
否

表示一个或者多个证书状态，用于获取这些状态下的证书。多个状态之间使用逗号（,）分隔。该参数有以下取值：

  • running：表示有效期大于 30 天的那些证书。
  • expired：表示已过期的那些证书。
  • expiring_soon：表示有效期小于等于 30 天但还未过期的那些证书。
如果不指定该参数，表示不使用该参数对 API 返回的证书列表进行过滤。
running,expired
SortRule
Object
否
表示一个排序规则，对该 API 返回的证书进行排序。默认规则是按响应中的 ExpireTime 参数对返回的证书进行升序排序。
CertType
String
否

表示一个证书类型，用于获取该类型的证书。该参数有以下取值：

  • server_cert：表示服务器证书，也就是 SSL 证书。
  • ca_cert：表示 CA 证书。
该参数的默认值是 server_cert。
server_cert
EncryType
String
否

表示一个密钥算法，获取使用该算法的证书。该参数有以下取值：

  • inter_cert：表示 RSA 或 ECC 算法。
  • sm_cert：表示 SM2 算法。
该参数的默认值是 inter_cert。
inter_cert

响应正文

参数名称
数据类型
参数说明
示例
PageNum
Long
表示请求参数中的 PageNum。
1
PageSize
Long
表示请求参数中的 PageSize。
10
Total
Long
表示符合过滤条件的证书数量。该参数值不受 PageSize 和 PageNum 的影响。
2
CertInfo
Object[]
表示一个证书列表，包含所有符合过滤条件的证书。
ExpiringCount
Long

表示在符合过滤条件的证书中，状态是 expiring_soon 的证书数量。

当前该参数还未生效，因此该参数值始终是 0。
0

请求示例

POST https://cdn.volcengineapi.com/?Action=ListCertInfo&Version=2021-03-01
{
    "Source": "volc_cert_center",
    "ConfiguredDomain": "www.example.com",
    "Name": "*.example.com",
    "Status": "running,expiring_soon",
    "SortRule": {
        "Asc": false
    },
    "CertType": "server_cert",
    "EncryType": "inter_cert"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230505145824B24D2A2B3D4E9B0C6B89",
    "Action": "ListCertInfo",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "CertInfo": [
      {
        "CertId": "cert_hosting-4616",
        "CertName": "test.com",
        "ConfiguredDomain": null,
        "Desc": null,
        "DnsName": "example.com,www.example.com",
        "EffectiveTime": 1651708800,
        "ExpireTime": 1683331199,
        "Source": "cdn_cert_hosting",
        "Status": "expiring_soon"
      },
      {
        "CertId": "cert_hosting-4041",
        "CertName": "abc.example.com",
        "ConfiguredDomain": null,
        "Desc": "Remark",
        "DnsName": "abc.example.com",
        "EffectiveTime": 1655856000,
        "ExpireTime": 1687478399,
        "Source": "cdn_cert_hosting",
        "Status": "running"
      }
    ],
    "ExpiringCount": 0,
    "PageNum": 1,
    "PageSize": 10,
    "Total": 2
  }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。