You need to enable JavaScript to run this app.
导航

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

最近更新时间2024.01.25 20:28:21

首次发布时间2022.08.10 14:40:03

指定一个证书。对于其所颁发给的域名,获取这些域名在内容分发网络中的证书关联情况。

使用限制

节流限制:您每秒最多可发送 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。对于包含在该证书的 SAN 字段,且又是加速域名的那些域名,获取每个加速域名的证书关联情况。
cert-c195f679cecb4f34tj23dd8c54e6c0a2
Status
String

指定一个或者多个域名状态,对域名进行筛选。

您可以指定以下状态。多个状态使用英文逗号(,)分隔。

  • online:表示状态是运行中的那些域名。
  • configuring:表示状态是配置中的那些域名。
  • offline:表示状态是已下线的那些域名。
configuring,online

响应正文

参数名称
数据类型
参数说明
示例
CertNotConfig
Object[]
表示未关联任何证书的域名信息。
SpecifiedCertConfig
Object[]
表示已关联该证书的域名信息。
OtherCertConfig
Object[]
表示关联了其他证书的域名信息。

请求示例

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

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