You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/API 参考/证书管理/添加或更新证书
添加或更新证书
最近更新时间：2024.11.11 10:54:49首次发布时间：2023.09.25 14:31:46
我的收藏

调用 CreateCert 接口，添加或更新一个证书，需要填写证书名称和证书内容等参数。

注意事项

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

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
CertNameString否pushCertName证书名称。
ProjectNameString否default项目名称，默认值为 default，您可以登录访问控制获取项目名称。

ChainID

String

否

9*********a982edf6e84bba1f

证书链 ID，用于标识整个证书链，包括叶子证书（服务器证书）、中间证书（中间 CA 证书）以及根证书（根 CA 证书）。

说明

使用当前接口更新证书时， ChainID 为必选参数。

RsaObject of Rsa是-证书信息。
UseWayString是https证书用途，当前仅支持设置为 https，表示用于 HTTPS 加密；

Rsa

参数类型是否必选示例值描述

Pubkey

String

是

*******

证书内容，你需要在计算机上使用文本编辑器打开证书，并将所有内容复制粘贴作为参数。

说明

  • 视频直播支持证书链校验。你只需要上传为你的域名颁发的证书，系统将自动检索完整的证书链。
  • 如果你选择上传证书链，请务必包含服务器证书、中间证书和根证书，并按正确的顺序排列：首先是服务器证书，其次是中间证书，然后是根证书。错误的顺序将使证书链无效。

Prikey

String

是

*******

证书私钥的内容，你需要在计算机上使用文本编辑器打开证书私钥，并将所有内容复制粘贴作为参数。

说明

请确保证书私钥没有密码保护。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数类型示例值描述
ChainIDString9*********a982edf6e84bba1f证书链 ID。
DomainStringlive.example.com使用该证书的域名。

UseWay

String

https

证书用途，取值及含义如下所示。

  • https：用于 HTTPS 加密；
  • sign：用于签名加密。

请求示例

POST https://live.volcengineapi.com?Action=CreateCert&Version=2023-01-01
{
  "UseWay": "https",
  "Rsa": {
    "PubKey": "******",
    "PriKey": "******"
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestID": "2020091618492801022706705734830",
    "Action": "CreateCert",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "ChainID": "9**47c0151394d93a982edf6e84bba1f",
    "Domain": "live.example.net",
    "UseWay": "https"
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
400InvalidParam.OutOfRange%s should be one of {[%s]}%s should be between %d and %d参数超出允许范围，请检查错误消息中指定参数的取值是否超出取值范围。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。