最近更新时间:2023.09.25 21:09:57
首次发布时间:2022.06.17 18:04:13
查看当前账号下的证书列表。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询证书列表接口。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListCertV2 | 接口名称。当前 API 的名称为 ListCertV2 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Available | Boolean | 否 |
| 是否启用证书,默认值为 true,支持的取值包括:
|
Expiring | Boolean | 否 |
| 证书是否过期,默认值为 false,支持的取值包括:
|
Domain | String | 否 | live.example.com | 域名,查询该域名对应的证书,支持精确查询 |
CertName | String | 否 | domaincert | 证书名称,支持输入证书名称中的关键字,进行模糊查询 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
CertList | Array of CertList | - | 证书信息列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
CertDomainList | Array of String | ["live.example.com"] | 与证书绑定的域名列表 |
ChainID | String | 4060e26538a149e2a87b42*******11 | 证书链 ID |
CertID | String | 812******1 | 证书实例 ID |
CertName | String | live.example.com | 证书名称 |
NotBefore | String | 2020-08-19T07:19:00+08:00 | 证书的生效日期,RFC3339 格式的 UTC 时间,精度为 s |
NotAfter | String | 2024-08-18T07:19:00+08:00 | 证书的过期时间,RFC3339 格式的 UTC 时间,精度为 s |
Status | String |
| 证书状态,由证书管理平台返回,支持的取值如下所示。
|
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" } ] } }
访问公共错误码获取详细信息。