最近更新时间:2024.04.02 15:53:52
首次发布时间:2022.07.18 15:12:00
获取符合过滤条件的证书列表以及这些证书所关联的加速域名。
节流限制:您每秒最多可发送 20 个请求。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
---|---|---|---|
Action | String | 是 | 接口名称。当前 API 的名称为 ListCdnCertInfo 。 |
Version | String | 是 | 接口版本。当前 API 的版本为 2021-03-01 。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
CertId | String | 否 | 表示一个证书的 ID,获取该 ID 的证书。 您可以使用 ListCertInfo 获取您想要指定的证书的 ID。 | cert-c195f679cecb4f34tj23dd8c54e6c0a2 |
ConfiguredDomain | String | 否 | 表示一个加速域名列表,用于获取列表中每个加速域名所关联的证书。多个加速域名之间使用逗号(,)分隔。 列表中可以包含泛域名。但是需要留意的是,对于泛域名,只有当一个证书所关联加速域名中包含该泛域名,该证书才算符合ConfiguredDomain 这个过滤条件。例如,您指定的 ConfiguredDomain 是 *.example.com 。如果一个证书所关联的加速域名中有 www.example.com ,但没有 *.example.com ,那么该证书不符合这个过滤条件。 | *.example.com, www.test.com |
DnsName | String | 否 | 表示一个域名列表,获取 SAN 字段中包含列表中任一域名的证书。多个域名之间使用逗号(,)分隔。 列表中可以包含泛域名。但是需要留意的是,对于泛域名,只有当一个证书的 SAN 字段中包含该泛域名,该证书才算符合DnsName 这个过滤条件。例如,您指定的 DnsName 是 *.example.com 。如果一个证书的 SAN 字段中有 www.example.com ,但没有 *.example.com ,那么该证书不符合这个过滤条件。 | *.example.com, www.test.com |
PageNum | Long | 否 | 对于 API 返回的证书列表,该参数表示一个页码。该 API 实际返回的证书列表是该页码所指定的分页上的那些证书。 该 API 返回的证书是根据 如果您指定的分页上没有证书,则返回结果中 PageNum 的默认值是 1 。 | 1 |
PageSize | Long | 否 | 表示每个分页包含的证书数量。 该参数的取值范围是 1-200,默认值是10 。 | 5 |
Source | String | 否 | 表示证书的存放位置,获取存放在该位置的证书。该参数有以下取值:
| |
Status | String | 否 | 表示一个证书状态的列表,获取处于列表中任一状态下的证书。该参数有以下取值:
| running,expired |
Configured | Boolean | 否 | 表示在该 API 返回的
true 。 |
参数名称 | 数据类型 | 参数说明 | 示例 |
---|---|---|---|
PageNum | Long | 表示请求参数中 PageNum 的值。 | 1 |
PageSize | Long | 表示请求参数中 PageSize 的值。 | 10 |
Total | Long | 表示符合过滤条件的证书数量。该参数值不受 PageNum 和 PageSize 的影响。 | 2 |
CertInfo | Object[] | 表示一个数组,该数组包含所有符合查询条件的证书对象。 | |
ExpiringCount | Long | 表示在符合过滤条件的证书中,状态是 expiring_soon 的证书的数量。但是,当前该参数还未生效,因此该参数值始终是 0 。 | 0 |
POST https://cdn.volcengineapi.com/?Action=ListCdnCertInfo&Version=2021-03-01 { "DnsName": "www.example.com" }
{ "ResponseMetadata": { "RequestId": "20220713124835010202085223107B8699", "Action": "ListCdnCertInfo", "Version": "2021-03-01", "Service": "CDN", "Region": "cn-north-1" }, "Result": { "CertInfo": [ { "CertId": "cert-c195f679cecb4fcd9823dd8c54e6c0a2", "CertName": "www.example.com", "ConfiguredDomain": "www.example.com", "Desc": "UploadCert", "DnsName": "www.example.com,example.com", "EffectiveTime": 1643414400, "ExpireTime": 1675036799, "Source": "volc_cert_center", "Status": "running" } ], "PageNum": 1, "PageSize": 10, "Total": 1 } }
如果响应正文的 ResponseMetadata
字段中包含 Error
字段,则表示 API 请求失败。更多关于错误码的信息,参见错误码。