You need to enable JavaScript to run this app.
导航
查询证书列表
最近更新时间:2023.10.12 17:39:57首次发布时间:2022.06.17 18:04:13

查看当前账号下的证书列表。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询证书列表接口。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=ListCertV2&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringListCertV2接口名称。当前 API 的名称为 ListCertV2
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述

Available

Boolean

true

是否启用证书,默认值为 true,支持的取值包括:

  • true:启用证书;
  • false:禁用证书。

Expiring

Boolean

false

证书是否过期,默认值为 false,支持的取值包括:

  • false:表示证书未过期;
  • true:表示证书已过期。
DomainStringlive.example.com域名,查询该域名对应的证书,支持精确查询
CertNameStringdomaincert证书名称,支持输入证书名称中的关键字,进行模糊查询

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述
CertListArray of CertList-证书信息列表

CertList

参数类型示例值描述
CertDomainListArray of String["live.example.com"]与证书绑定的域名列表
ChainIDString4060e26538a149e2a87b42*******11证书链 ID
CertIDString812******1证书实例 ID
CertNameStringlive.example.com证书名称
NotBeforeString2020-08-19T07:19:00+08:00证书的生效日期,RFC3339 格式的 UTC 时间,精度为 s
NotAfterString2024-08-18T07:19:00+08:00证书的过期时间,RFC3339 格式的 UTC 时间,精度为 s

Status

String

OK

证书状态,由证书管理平台返回,支持的取值如下所示。

  • OK:正常;
  • Expire:过期;
  • 30days:有效期剩余 30 天;
  • 15days:有效期剩余 15 天;
  • 7days:有效期剩余 7 天;
  • 1days:有效期剩余 1 天。

示例

请求示例

POST https://live.volcengineapi.com?Action=ListCertV2&Version=2020-08-01

返回示例

{
  "ResponseMetadata": {
    "RequestID": "2020091618453101022706705762997",
    "Action": "ListCertV2",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "CertList": [
      {
        "CertDomainList": [
          "live.example.com"
        ],
        "ChainID": "4060e26538a149e2a87b42*******11",
        "CertID": "812******1",
        "NotBefore": "2020-08-19T07:19:00+08:00",
        "NotAfter": "2024-08-18T07:19:00+08:00",
        "Status": "Expire"
      },
      {
        "CertDomainList": [
          "*live2.example2.com"
        ],
        "ChainID": "d7134cbff1dd4425847f3********e4",
        "CertID": "812******1",
        "NotBefore": "2020-08-11T05:42:54+08::00",
        "NotAfter": "2020-09-18T05:42:54+08:00",
        "Status": "OK"
      }
    ]
  }
}

错误码

访问公共错误码获取详细信息。