跳转至

创建/更新域名证书配置

1. 接口描述

接口请求路径:POST /prod-api/cdn/layer7/ssl/updateDomainCertInfo

updateDomainCertInfo 用于为指定域名创建或更新证书配置,支持自有证书、托管证书与平台颁发证书。自有证书需提交 PEM 格式证书与私钥,且需与域名匹配;平台颁发需具备相应权限与免费证书配额。

Token 获取方式见 密钥鉴权

2. 输入参数

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

参数名称 必选 类型 描述
domainId Integer 域名 ID
示例值:190
source Integer 证书来源,支持以下值:
0:自有证书
1:托管证书
2:平台颁发
示例值:1
protocol Integer 回源协议,支持以下值:
0:HTTP
1:协议跟随
2:预留取值(接口允许)
示例值:1
certId Integer 证书 ID。source1(托管证书)时必选;source2 时可传已有平台证书 ID
示例值:1
sslCert String PEM 证书内容。source0(自有证书)时必选(域名已配置证书且仅改回源协议时可为空)
sslKey String PEM 私钥内容。source0(自有证书)时必选(域名已配置证书且仅改回源协议时可为空)

3. 示例

示例1 使用托管证书配置域名

输入示例

{
  "domainId": 190,
  "protocol": 1,
  "source": 1,
  "certId": 1,
  "sslCert": "",
  "sslKey": ""
}

代码调用

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

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 UpdateDomainCertInfoTest {

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

        String requestBody = "{"
                + "\"domainId\":190,"
                + "\"protocol\":1,"
                + "\"source\":1,"
                + "\"certId\":1,"
                + "\"sslCert\":\"\","
                + "\"sslKey\":\"\""
                + "}";

        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/cdn/layer7/ssl/updateDomainCertInfo"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "domainId": 190,
  "protocol": 1,
  "source": 1,
  "certId": 1,
  "sslCert": "",
  "sslKey": ""
}`)

    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": true
}

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:操作成功
data Boolean 是否更新成功。示例值:true

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
回源协议只能为0,1,2 protocol 非法
回源协议不能为空 未传 protocol
提交失败:证书与私钥不能为空 自有证书未传 sslCert / sslKey
提交失败:证书格式不正确,需包含完整有效的 PEM 证书块(-----BEGIN CERTIFICATE----- / -----END CERTIFICATE-----) 证书 PEM 格式非法
提交失败:私钥格式不正确,需包含完整有效的 PEM 私钥块(-----BEGIN PRIVATE KEY----- / -----END PRIVATE KEY-----) 私钥 PEM 格式非法
证书信息解析失败,请确认证书是否正确 证书解析失败
提交失败:域名与证书不匹配! 证书 SANs 未覆盖该域名
提交失败:证书与密钥不匹配! 证书与私钥不配对
提交失败:无效的托管证书ID 托管/平台证书 ID 无效
提交失败:无效的证书来源 source 不是 0 / 1 / 2
失败:域名不存在 域名不存在或不属于当前账号
失败:免费证书配额不足 平台颁发配额已用尽或未开通
失败:平台颁发证书不支持泛域名 泛域名不可使用平台颁发
提交失败:非标端口域名,需同套餐下有活跃状态的'80'端口域名才可使用平台颁发证书 非标端口缺少活跃默认端口域名