最近更新时间:2024.04.02 15:53:52
首次发布时间:2022.07.18 15:12:00
获取符合过滤条件的证书信息。该 API 获取的证书是那些能与或者已经与您账号下的加速域名关联的证书。
节流限制:您每秒最多可发送 20 个请求。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
---|---|---|---|
Action | String | 是 | 接口名称。当前 API 的名称为 ListCertInfo 。 |
Version | String | 是 | 接口版本。当前 API 的版本为 2021-03-01 。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
Source | String | 是 | 表示证书存放的位置。该参数有以下取值:
| volc_cert_center |
CertId | String | 否 | 表示一个证书 ID,获取该 ID 的证书。 | cert-602fc4eb6cbf4b9351b54bedf2bc5dc5 |
ConfiguredDomain | String | 否 | 表示一个加速域名列表,获取已与列表中任何一个加速域名绑定的证书。 | www.example.com,www.test.com |
Name | String | 否 | 表示一个域名,用于获取那些在 SAN 字段中包含该域名的证书。该域名可以是泛域名。例如,指定 *.example.com 表示获取 SAN 字段中包含 img.example.com 或 www.example.com 等匹配该泛域名的证书。 | *.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,expired |
SortRule | Object | 否 | 表示一个排序规则,对该 API 返回的证书进行排序。默认规则是按响应中的 ExpireTime 参数对返回的证书进行升序排序。 |
参数名称 | 数据类型 | 参数说明 | 示例 |
---|---|---|---|
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": "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": "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 请求失败。更多关于错误码的信息,参见错误码。