获取指定证书可关联的域名--内容分发网络-火山引擎

文档中心

立即注册

导航

获取指定证书可关联的域名

最近更新时间：2024.11.02 21:50:26首次发布时间：2022.08.10 14:40:03

对于可与指定证书关联的加速域名，获取这些加速域名的证书配置情况。这些加速域名来自指定证书的 SAN 字段。

使用限制

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

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
CertId	String	是	表示您查询的是关联了证书 `CertId` 的加速域名的证书配置情况。您可以调用 ListCdnCertInfo 获取证书的 ID。	`cert-c195f679cecb4f34tj23dd8c54e6c0a2`
Status	String	否	表示加速域名的状态，用于对该 API 返回的加速域名进行过滤。您可以指定多个状态，状态之间使用逗号（,）分隔。该参数有以下取值： `online`：表示状态是 "正常运行"。 `offline`：表示状态是 "已下线"。 `configuring`：表示状态是 "配置中"。如果不指定该参数，表示不对加速域名进行过滤。	`configuring,online`
CertId2	String	否	表示您查询的是关联了双证书 `CertId` 和 `CertId2` 的加速域名的证书配置情况。	`cert-0274b8d83db5413db2408f0a98fe8e1c`

响应正文

参数名称	数据类型	参数说明
CertNotConfig	Object[]	表示当前未启用 HTTPS 的加速域名列表。列表中的加速域名还满足以下条件：在您对这些加速域名启用 HTTPS 时，可以将这些加速域名与您指定的证书关联。
SpecifiedCertConfig	Object[]	表示已启用了 HTTPS 的加速域名列表。这些加速域名关联了您指定的证书。如果您仅指定了 `CertId`，列表中包含的是配置模式为单证书，并且关联了 `CertId` 这本证书的加速域名。如果您指定了 `CertId` 和 `CertId2`，列表中包含的是配置模式为双证书，并且关联了 `CertId` 和 `CertId2` 这两本证书的加速域名。
OtherCertConfig	Object[]	表示已启用了 HTTPS 的加速域名列表。这些加速域名关联的证书不是您指定的证书。如果您仅指定了 `CertId`，列表中包含的是配置模式为单证书，但是关联的证书不是 `CertId` 的加速域名。如果您指定了 `CertId` 和 `CertId2`，列表中包含的是配置模式为双证书，但是关联的证书中至少有一本不是 `CertId` 或 `CertId2` 的加速域名。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeCertConfig&Version=2021-03-01
{
  "CertId": "cert-c195f679cecb4f34tj23dd8c54e6c0a2",
  "CertId2": "cert-0274b8d83db5413db2408f0a98fe8e1c",
  "Status": "configuring,online"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202406031130298BE82599DD0D187630A5",
        "Action": "DescribeCertConfig",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "CertNotConfig": [
            {
                "Domain": "aaa.example.com",
                "DomainLock": {
                    "Remark": "域名锁定，不允许自助配置操作，代运维配置中",
                    "Status": "on"
                },
                "Status": "online",
                "Type": "single_cert"
            },
            {
                "Domain": "bbb.example.com",
                "DomainLock": {
                    "Remark": "",
                    "Status": "off"
                },
                "Status": "online",
                "Type": "double_cert"
            }
        ],
        "OtherCertConfig": [
            {
                "CerStatus": "expiring_soon",
                "Domain": "ccc.example.com",
                "DomainLock": {
                    "Remark": "",
                    "Status": "off"
                },
                "Status": "online",
                "Type": "single_cert"
            }
        ],
        "SpecifiedCertConfig": [
            {
                "CerStatus": "running",
                "Domain": "ccc.example.com",
                "DomainLock": {
                    "Remark": "",
                    "Status": "off"
                },
                "Status": "online",
                "Type": "double_cert"
            }
        ]
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。