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

上传证书（推荐）

最近更新时间：2024.04.16 20:45:20

首次发布时间：2024.04.07 16:50:43

我的收藏

在火山引擎内容分发网络中上传一个证书。

使用限制

节流限制：您每秒最多可以提交 20 个 API 请求。

请求说明

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

请求参数

Query

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

Body

参数名称
数据类型
是否必选
参数说明
示例
Certificate
String
是
表示证书文件的内容，必须包含完整的证书链。内容中的换行需要使用 \r\n 替换。证书文件的扩展名是 .crt 或者 .pem。
-----BEGIN CERTIFICATE-----\r\n......\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\n.......\r\n-----END CERTIFICATE-----
PrivateKey
String
是
表示证书私钥文件的内容。内容中的换行需要使用 \r\n 替换。证书私钥文件的扩展名是 .key 或者 .pem。
-----BEGIN RSA PRIVATE KEY-----\r\n.....\r\n-----END RSA PRIVATE KEY-----
Desc
String
否
表示该证书的备注。
Note
Source
String
否

表示证书存放的位置。该参数有以下取值：

  • volc_cert_center：表示火山引擎证书中心。
  • cdn_cert_hosting：表示内容分发网络。在内容分发网络上存放证书是白名单功能。要使用该功能，请 提交工单。
volc_cert_center
Repeatable
Boolean
否

表示是否允许上传相同的证书。如果两个证书的指纹相同，这两个证书被认为是相同的证书。该参数有以下取值：

  • true：表示允许上传相同的证书。
  • false：表示不允许上传相同的证书。在调用该 API 时，内容分发网络会检查是否已存在相同的证书。如果存在，您无法上传该证书，同时响应正文的 Error 结构体中会包含已存在的证书的 ID。
该参数的默认值是 true。
true

返回参数

参数名称
数据类型
参数说明
示例
CertId
String
表示上传后该证书在 Source 中的 ID。
cert-17f1d965a11342eb80d9a0ecfef35713

请求示例 1

POST https://cdn.volcengineapi.com/?Action=AddCertificate&Version=2021-03-01
{
    "Source": "volc_cert_center",
    "Certificate": "-----BEGIN CERTIFICATE-----\r\nMIGrhI\r\nmg==\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\nMIIE ==\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\nMIID \r\nMrY=\r\n-----END CERTIFICATE-----",
    "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\r\nMIIjQVx9Q==\r\n-----END RSA PRIVATE KEY-----",
    "Repeatable": false
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "20240401215347C8101DF6B5EA14943C6E",
        "Action": "AddCertificate",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "CertId": "cert-6538a3e999094a9eb2311c8c3c16b9eb"
    }
}

请求示例 2

POST https://cdn.volcengineapi.com/?Action=AddCertificate&Version=2021-03-01
{
    "Source": "volc_cert_center",
    "Certificate": "-----BEGIN CERTIFICATE-----\r\nMIGrhI\r\nmg==\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\nMIIE ==\r\n-----END CERTIFICATE-----\r\n-----BEGIN CERTIFICATE-----\r\nMIID \r\nMrY=\r\n-----END CERTIFICATE-----",
    "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\r\nMIIjQVx9Q==\r\n-----END RSA PRIVATE KEY-----",
    "Repeatable": false
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20240401215849A247C098FE59A995A0D4",
        "Action": "AddCertificate",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InvalidParameter.Certificate.Duplicated",
            "Message": "证书已存在，ID为 cert-6538a3e999094a9eb2311c8c3c16b9eb。"
        }
    }
}