You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

绑定证书

最近更新时间：2023.10.12 17:39:57

首次发布时间：2022.06.17 18:04:14

我的收藏

调用接口绑定域名与证书。

说明

该接口属于历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版绑定证书接口。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=BindCert&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是BindCert接口名称。当前 API 的名称为 BindCert。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。

Body

参数类型是否必选示例值描述
DomainString是live.example.com需要绑定证书的域名
ChainIDString是be37f********c487f486244759821f需要绑定的证书链 ID，可以通过查询证书列表接口获取

HTTPS

Boolean

否

false

是否开启 HTTPS，默认值为 false

  • false：关闭；
  • true：开启。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://live.volcengineapi.com?Action=BindCert&Version=2020-08-01
{
  "Domain": "example-domain-0114",
  "CertDomain": "live.example.com",
  "ChainID": "be37f********c487f486244759821f",
  "HTTPS": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestID": "2020091615160501022706705738154",
    "Action": "BindCert",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

访问公共错误码获取详细信息。