跳转至

导入证书

1. 接口描述

接口请求路径:POST /prod-api/acdn/tcdn/certificate/addCertificate

addCertificate 用于把 PEM 证书和私钥导入当前账号的 TCDN 证书库。控制台「配置证书」选择「新上传证书」(source = 1)时先调用本接口。账号需具备 tcdn:CreateCertificate 权限。

Token 获取方式见 密钥鉴权。

注意:

  • 本接口只导入证书,不会给域名开启 HTTPS。选择「新上传证书」时,导入成功后必须再调用 配置域名证书(updateDomainConfig),把 data.relatesId 写入 https.certInfo.certId。
  • 选择「已托管证书」(source = 2)时不要调用本接口,直接调用 配置域名证书。
  • 证书须能解析出主题、SAN 和有效期。私钥须与证书成对。导入成功后可在 列出证书 中查询,data.certId 即列表中的 rows[].certId。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
certificate 是 String 证书内容(PEM)。须包含 -----BEGIN CERTIFICATE----- 与 -----END CERTIFICATE-----,可包含完整证书链
privateKey 是 String 私钥内容(PEM)。须包含完整私钥块,如 -----BEGIN PRIVATE KEY----- / -----END PRIVATE KEY-----,或 RSA、EC 等变体

3. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:成功
data Object 导入结果
data.certId Long 平台证书 ID。示例值:91
data.relatesId String 上游证书 ID。示例值:cert-example

4. 示例

示例1 导入 PEM 证书

输入示例

{
  "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
  "privateKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
}

代码调用

请将 {登录域名}、token 替换为实际值。

curl -X POST 'https://{登录域名}/prod-api/acdn/tcdn/certificate/addCertificate' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
  "privateKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
}'
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class AddCertificateTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/acdn/tcdn/certificate/addCertificate";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"certificate\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\","
                + "\"privateKey\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\""
                + "}";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Authorization", "Bearer " + token);
            httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));

            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                int statusCode = response.getStatusLine().getStatusCode();
                String body = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("Status Code: " + statusCode);
                System.out.println("Body: " + body);
            }
        }
    }
}
package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://{登录域名}/prod-api/acdn/tcdn/certificate/addCertificate"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
  "privateKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
}`)

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println("Status Code:", resp.StatusCode)
    fmt.Println("Body:", string(body))
}

输出示例

{
  "msg": "成功",
  "code": 200,
  "data": {
    "certId": 91,
    "relatesId": "cert-example"
  }
}

5. 错误码

上游或配置失败时,code 为 500,原因在 msg,没有 data。

HTTP 状态码 / 业务提示 描述
200 证书已导入
401 未鉴权或 Token 无效
403 无权限,需具备 tcdn:CreateCertificate
未初始化TCDN配置,请先联系管理员 当前账号未配置 TCDN
未初始化TCDN配置(apiKeyId),请先联系管理员 未配置 API 密钥
未初始化TCDN配置(project),请先联系管理员 未配置项目
未查询到对应的API密钥信息 密钥配置不存在
error code:{0},message:{1} 上游导入失败。{0} 为错误码,{1} 为原因。常见于证书与私钥不匹配或 PEM 无效