最近更新时间:2024.01.25 20:28:21
首次发布时间:2022.07.18 15:12:00
获取已关联了某个加速域名的证书的列表。
节流限制:您每秒最多可发送 20 个请求。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
---|---|---|---|
Action | String | 是 | 接口名称。当前 API 的名称为 ListCdnCertInfo 。 |
Version | String | 是 | 接口版本。当前 API 的版本为 2021-03-01 。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
CertId | String | 否 | 指定一个或者多个证书 ID。获取这些证书中已经关联了内容分发网络中当前账号下的加速域名的那些证书。最多可以指定 20 个证书 ID。多个证书 ID 使用英文逗号(,)分隔。 | cert-c195f679cecb4f34tj23dd8c54e6c0a2,cert-c195f67945u84fcd9823dd8c53eec0a2 |
ConfiguredDomain | String | 否 | 指定当前账号下的一个或者多个加速域名,获取已关联了这些域名的证书。最多可以指定 50 个加速域名。多个加速域名使用英文逗号(,)分隔。您可以指定泛域名。如果您指定一个泛域名,表示获取已与该泛域名关联的证书。 | *.example.com, www.test.com |
DnsName | String | 否 | 指定一个或者多个域名,在 SAN 字段中包含这些域名的证书中,获取已关联了某个加速域名的那些证书。最多可以指定 20 个域名。多个域名使用英文逗号(,)分隔。支持指定泛域名。 | *.example.com, www.test.com |
PageNum | Long | 否 | 指定返回的页码。默认值是 1。 内容分发网络根据符合条件的证书数量与PageSize 的值计算总页数,然后根据您指定的 PageNum 返回对应页面上的证书信息。如果该页不存在,则返回结果中不包含任何证书信息。 | 1 |
PageSize | Long | 否 | 指定每页的证书数量。默认值是 10,最大值是 100。 | 5 |
Source | String | 否 | 指定证书的来源。该参数有以下取值:
| |
Status | String | 否 | 指定一个或者多个状态,对证书进行筛选。 您可以指定以下状态。多个状态使用英文逗号(,)分隔。
| running,expired |
Configured | Boolean | 否 | 是否筛选绑定了域名的证书列表,默认为true |
参数名称 | 数据类型 | 参数说明 | 示例 |
---|---|---|---|
PageNum | Long | 表示您在请求中指定的页码。 | 1 |
PageSize | Long | 表示每页的证书数量。 | 10 |
Total | Long | 表示符合查询条件的证书数量。如果由于指定的页码不正确没能返回证书信息,该参数的值不受影响。比如符合查询条件的证书数量是 4,无论是否返回证书信息,该参数的值始终是 4。 | 2 |
CertInfo | Object[] | 表示一个数组,该数组包含所有符合查询条件的证书对象。 | |
ExpiringCount | Long | 即将过期的证书个数 |
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 请求失败。更多关于错误码的信息,参见错误码。