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

文档中心

立即注册

导航

获取指定证书的域名关联情况

最近更新时间：2024.06.28 19:18:53首次发布时间：2022.08.10 14:40:03

对于指定证书的 SAN 字段中的域名，获取每个域名在火山引擎内容分发网络（CDN）中所关联的证书。您可以指定单本证书，也可以指定双证书。

使用限制

节流限制：您每秒最多可发送 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	是	表示一本证书的 ID。您可以调用 ListCdnCertInfo 获取证书的 ID。	`cert-c195f679cecb4f34tj23dd8c54e6c0a2`
Status	String	否	表示一个或者多个加速域名的状态，该 API 仅返回这些状态下的加速域名。多个状态之间使用逗号（,）分隔。该参数有以下取值： `all`：表示任意状态。 `offline`：表示状态是 "已禁用"。 `online`：表示状态是 "已启用"。 `configuring`：表示状态是 "配置中"。该参数的默认值是 `all`。	`configuring,online`
CertId2	String	否	如果您要指定双证书，该参数表示第二本证书的 ID。	`cert-0274b8d83db5413db2408f0a98fe8e1c`

响应正文

参数名称	数据类型	参数说明
CertNotConfig	Object[]	表示未与任何证书关联的加速域名列表。
SpecifiedCertConfig	Object[]	表示与您指定证书关联的加速域名列表。如果您指定了一本证书，则满足以下条件的加速域名会在该列表中：加速域名仅关联了一本证书。同时，关联的证书就是您指定的那本证书。如果您指定了两本证书，则满足以下条件的加速域名会在该列表中：加速域名关联了两本证书。同时，关联的两本证书就是您指定的那两本证书。
OtherCertConfig	Object[]	表示未您指定证书关联的加速域名列表。如果您指定了一本证书，则满足以下任意条件的加速域名会在该列表中：加速域名仅关联了一本证书。然而，关联的证书不是您指定的那本证书。加速域名关联了两本证书。如果您指定了两本证书，则满足以下任意条件的加速域名会在该列表中：加速域名关联了两本证书。然而，关联的两本证书中至少有一本不在您指定的那两本证书中。加速域名关联了一本证书。

请求示例

基于以上场景的请求示例如下：

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 请求失败。更多关于错误码的信息，参见错误码。