You need to enable JavaScript to run this app.
导航
内容分发网络
  • 文档首页
    • /
  • 内容分发网络

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

最近更新时间：2024.04.02 15:53:52

首次发布时间：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
是
表示一个证书的 ID，用于获取该 ID 的证书。
cert-c195f679cecb4f34tj23dd8c54e6c0a2
Status
String
否

表示一个或多个加速域名的状态。对于指定证书的 SAN 字段中的域名，如果某些域名在CDN 中有对应的加速域名，则获取指定状态下的这些加速域名的证书关联信息。该参数有以下取值：

  • all：表示所有状态。
  • offline：表示状态是 "已禁用"。
  • online：表示状态是 "已启用"。
  • configuring：表示状态是 "配置中"。
多个状态之间使用逗号（,）分隔。该参数的默认值是 all。
configuring,online

响应正文

参数名称
数据类型
参数说明
示例
CertNotConfig
Object[]
表示还未与任何证书相关联的加速域名列表。
SpecifiedCertConfig
Object[]
表示已关联该证书的域名列表。
OtherCertConfig
Object[]
表示与 ID 不是 CertID 的证书相关联的加速域名列表。

请求示例

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

POST https://cdn.volcengineapi.com/?Action=DescribeCertConfig&Version=2021-03-01
{
  "CertId": "cert-c19"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202207131255000102121011030C701AF8",
    "Action": "DescribeCertConfig",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "CertNotConfig": [
      {
        "CerStatus": null,
        "Domain": "test.example.com",
        "Status": "online"
      }
    ],
    "OtherCertConfig": [
      {
        "CerStatus": "running",
        "Domain": "img.example.com",
        "Status": "online"
      }
    ],
    "SpecifiedCertConfig": [
      {
        "CerStatus": "running",
        "Domain": "www.example.com",
        "Status": "online"
      }
    ]
  }
}

错误码

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