You need to enable JavaScript to run this app.
导航

获取证书列表

最近更新时间2024.01.25 20:28:21

首次发布时间2022.07.18 15:12:00

获取满足指定条件的证书的信息。

使用限制

节流限制:您每秒最多可发送 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:表示证书是托管在内容分发网络的。在内容分发网络上托管证书是白名单功能。要使用该功能,请提交工单
volc_cert_center
Name
String
指定一个域名以获取那些在 SAN 字段中包含该域名的证书。 域名可以是泛域名。 例如,指定 *.example.com 可获取SAN 字段中包含 img.example.com 或 www.example.com 等的证书。
*.example.com
PageNum
Long

指定返回的页码。默认值是 1。

内容分发网络根据符合条件的证书数量与 PageSize 的值计算总页数,然后根据您指定的 PageNum 返回对应页面上的证书信息。如果该页不存在,则返回结果中不包含任何证书信息。
1
PageSize
Long
指定每页的证书数量。默认值是 10,最大值是 100。
5
Status
String

指定一个或者多个状态,获取这些状态下的证书。默认返回所有状态的证书。

您可以指定以下状态。多个状态使用英文逗号(,)分隔。

  • running:表示获取有效期大于 30 天的那些证书。
  • expired:表示获取已经过期的那些证书。
  • expiring_soon:表示获取有效期小于等于 30 天但还未过期的那些证书。
running,expired
SortRule
Object
证书返回结果全局排序规则

响应正文

参数名称
数据类型
参数说明
示例
PageNum
Long
表示您在请求中指定的页码。
1
PageSize
Long
表示每页的证书数量。
10
Total
Long
表示符合查询条件的证书数量。如果由于指定的页码不正确没能返回证书信息,该参数的值不受影响。比如符合查询条件的证书数量是 4, 无论是否返回证书信息,该参数的值始终是 4。
2
CertInfo
Object[]
表示一个数组,该数组包含所有符合查询条件的证书。
ExpiringCount
Long
即将过期的证书个数

请求示例

POST https://cdn.volcengineapi.com/?Action=ListCertInfo&Version=2021-03-01
{
  "Source": "cdn_cert_hosting"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230505145824B24D2A2B3D4E9B0C6B89",
    "Action": "ListCertInfo",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "CertInfo": [
      {
        "CertId": "cert_hosting-4616",
        "CertName": "microfish.life",
        "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": "此处是备注",
        "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 请求失败。更多关于错误码的信息,参见错误码