获取已与加速域名关联的证书列表--内容分发网络-火山引擎

文档中心

立即注册

导航

获取已与加速域名关联的证书列表

最近更新时间：2024.09.11 15:45:28首次发布时间：2022.07.18 15:12:00

获取符合过滤条件的证书列表以及这些证书所关联的加速域名列表。这些证书可以是服务器证书，也可以是 CA 证书。

如果是子用户调用该 API，列表中的加速域名是该子用户有权限访问的。

使用限制

节流限制：您每秒最多可发送 20 个请求。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=ListCdnCertInfo&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `ListCdnCertInfo`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
CertId	String	否	表示一个证书的 ID，用于过滤证书，以获取该 ID 的证书。您可以调用 ListCertInfo 获取您想要指定的证书的 ID。在调用 ListCertInfo 时，不要指定 `CertId`。如果不指定该参数，表示不使用该参数对 API 返回的证书列表进行过滤。	`cert-c195f679cecb4f34tj23dd8c54e6c0a2`
ConfiguredDomain	String	否	表示一个加速域名列表，用于过滤证书，以获取与列表中任意加速域名关联的那些证书。多个加速域名之间使用逗号（,）分隔。列表中可以包含泛域名。如果不指定该参数，表示不使用该参数对 API 返回的证书列表进行过滤。	`*.example.com, www.test.com`
DnsName	String	否	表示一个加速域名列表，用于过滤证书，以获取 SAN 字段中包含列表中任意域名的那些证书。多个加速域名之间使用逗号（,）分隔。列表中可以包含泛域名。由于 CA 证书没有 SAN，该参数仅对服务器证书生效。如果不指定该参数，表示不使用该参数对 API 返回的证书列表进行过滤。	`*.example.com, www.test.com`
PageNum	Long	否	表示一个页码。该 API 返回的证书列表是该页码所指定的分页上的那些证书。该 API 返回的证书是根据 `PageSize` 而分页的。假设该 API 返回的证书数量是 100，您指定的 `PageSize` 是 `10`，那么返回的证书是分布在 10 个页上。如果您指定的 `PageNum` 是 `2`，表示获取第 2 页上的那些证书。如果您指定的分页上没有证书，则返回结果中 `CertInfo` 参数的值为 `null`。 `PageNum` 的默认值是 `1`。	`1`
PageSize	Long	否	表示每个分页包含的证书数量。该参数的取值范围是 1-100，默认值是 `10`。	`5`
Source	String	否	表示证书的托管位置，用于过滤证书，以获取托管在该位置的证书。该参数有以下取值： `volc_cert_center`：表示火山引擎证书中心。 `cdn_cert_hosting`：表示内容分发网络。关于在内容分发网络上托管证书，参见内容分发网络证书托管。如果不指定该参数，表示不使用该参数对 API 返回的证书列表进行过滤。	`volc_cert_center`
Status	String	否	表示一个证书状态的列表，用于过滤证书，以获取处于列表中任意状态下的证书。该参数有以下取值： `running`：表示该证书的有效期大于 30 天。 `expired`：表示该证书已经过期。 `expiring_soon`：表示该证书的有效期小于等于 30 天，但还未过期。多个证书状态使用逗号（,）分隔。如果不指定该参数，表示不使用该参数对 API 返回的证书列表进行过滤。	`running,expired`
Configured	Boolean	否	表示在该 API 返回的证书列表中，是否包含未与任何加速域名关联的证书。该参数有以下取值： `true`：表示不包含未与任何加速域名关联的证书。 `false`：表示包含未与任何加速域名关联的证书。该参数的默认值是 `true`。	`false`
CertType	String	否	表示一个证书类型，用于过滤证书，以获取该类型的证书。该参数有以下取值： `server_cert`：表示服务器证书，也就是 SSL 证书。 `ca_cert`：表示 CA 证书。该参数的默认值是 `server_cert`。	`server_cert`
EncryType	String	否	表示一个密钥算法，用于过滤证书，以获取使用该算法的证书。该参数有以下取值： `inter_cert`：表示 RSA 或 ECC 算法。 `sm_cert`：表示 SM2 算法。该参数的默认值是 `inter_cert`。	`inter_cert`

响应正文

参数名称	数据类型	参数说明	示例
PageNum	Long	表示请求参数中 `PageNum` 的值。	`1`
PageSize	Long	表示请求参数中 `PageSize` 的值。	`10`
Total	Long	表示符合过滤条件的证书数量。该参数值不受 `PageNum` 和 `PageSize` 的影响。	`2`
CertInfo	Object[]	表示该 API 返回的证书列表。
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 请求失败。更多关于错误码的信息，参见错误码。