关联证书与加速域名--内容分发网络-火山引擎

文档中心

立即注册

导航

关联证书与加速域名

最近更新时间：2024.06.28 19:18:53首次发布时间：2022.07.18 15:12:00

将指定的证书与火山引擎内容分发网络（CDN）中当前账号下的一个或者多个加速域名相关联。您可以指定单本证书，也可以指定双证书。

双证书是白名单功能。要指定双证书，请提交工单。如果您指定双证书，表示这两本证书将与您指定的加速域名关联。

使用限制

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

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
CertId	String	是	表示一个证书 ID，将 `CertId` 表示的证书与 `Domains` 中的加速域名关联。	`cert-c195f679cecb4f34tj23dd8c54e6c0a2`
CertId2	String	否	如果您要指定双证书，该参数表示第二本证书的 ID。	`cert-0274b8d83db5413db2408f0a98fe8e1c`
Domain	String	是	表示一个加速域名列表。列表中的加速域名将与您指定的证书关联。您最多可以指定 50 个加速域名，多个加速域名之间使用逗号（,）分隔。单证书和双证书场景的额外描述如下：单证书：如果列表中的某个加速域名不包含在该证书的 SAN 字段中，该加速域名将无法与该证书关联。双证书：如果列表中的某个加速域名不包含在任意一本证书的 SAN 字段中，该加速域名将无法与这两本证书关联。	`www.example.com,img.example.com`

响应正文

参数名称	数据类型	参数说明	示例
DeployResult	Object[]	表示 `Domain` 列表中的加速域名是否成功关联了您指定的证书。

请求示例

POST https://cdn.volcengineapi.com/?Action=BatchDeployCert&Version=2021-03-01
{
  "CertId": "cert-c195f679cecb4fc5yjt3dd8c54e6c0a2",
  "Domain": "www.example.com,img.example.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202207131500530102120352272280EC8F",
    "Action": "BatchDeployCert",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "DeployResult": [
      {
        "Domain": "www.example.com",
        "Status": "success"
      },
      {
        "Domain": "img.example.com",
        "ErrorMsg": "域名与证书不匹配",
        "Status": "fail"
      }
    ]
  }
}

错误码

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