通过域名获取可用证书¶

1. 接口描述¶

接口请求路径：GET /prod-api/acdn/tcdn/certificate/describeCertByDomainName

describeCertByDomainName 用于查询当前账号下、SAN 覆盖指定加速域名的已导入证书。控制台「配置证书」选择「已托管证书」（source = 2）时，用本接口拉取可选证书列表。账号需具备 tcdn:DescribeCertificate 或 tcdn:DescribeAllDomains 权限。

Token 获取方式见密钥鉴权。

说明：

选出证书后，请把 data[].relatesId 传给配置域名证书（updateDomainConfig）完成绑定。该路径不调用导入证书。

域名须已接入且属于当前账号。匹配规则为证书 SAN 包含该域名，或包含去掉最左一级后的通配域名。例如查询 www.example.com 时同时匹配 *.example.com；查询 a.b.example.com 时同时匹配 *.b.example.com。只返回来源为 1 的 TCDN 证书。

2. 输入参数¶

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

参数名称	必选	类型	描述
domainName	是	String	Query 参数。加速域名。示例值：`www.example.com`

3. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
data	Array	可用证书列表。没有匹配证书时为空数组
data[].certId	Long	平台证书 ID。示例值：`91`
data[].relatesId	String	上游证书 ID。示例值：`cert-example`
data[].alias	String	证书别名，导入时取证书主题。示例值：`www.example.com`
data[].subjectDN	String	证书主题。示例值：`www.example.com`
data[].dnsName	String	证书 SAN 域名，多个域名以英文逗号分隔。示例值：`www.example.com,example.com`
data[].endTime	String	证书到期时间，格式 `yyyy-MM-dd HH:mm:ss`。示例值：`2027-01-01 00:00:00`

4. 示例¶

示例1 查询域名可用证书¶

输入示例¶

GET /prod-api/acdn/tcdn/certificate/describeCertByDomainName?domainName=www.example.com

代码调用¶

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

cURLJavaGo

curl -X GET 'https://{登录域名}/prod-api/acdn/tcdn/certificate/describeCertByDomainName?domainName=www.example.com' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx'

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class DescribeCertByDomainNameTest {

    public static void main(String[] args) throws Exception {
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        URIBuilder uriBuilder = new URIBuilder("https://{登录域名}/prod-api/acdn/tcdn/certificate/describeCertByDomainName");
        uriBuilder.addParameter("domainName", "www.example.com");

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet httpGet = new HttpGet(uriBuilder.build());
            httpGet.setHeader("Authorization", "Bearer " + token);

            try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
                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 (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    u, err := url.Parse("https://{登录域名}/prod-api/acdn/tcdn/certificate/describeCertByDomainName")
    if err != nil {
        panic(err)
    }
    q := u.Query()
    q.Set("domainName", "www.example.com")
    u.RawQuery = q.Encode()

    req, err := http.NewRequest(http.MethodGet, u.String(), nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)

    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",
      "alias": "www.example.com",
      "subjectDN": "www.example.com",
      "dnsName": "www.example.com,example.com",
      "endTime": "2027-01-01 00:00:00"
    }
  ]
}

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功。没有匹配证书时 `data` 为空数组
401	未鉴权或 Token 无效
403	无权限，需具备 `tcdn:DescribeCertificate` 或 `tcdn:DescribeAllDomains`
缺少必填参数：domainName	未传 Query 参数 `domainName`
域名不能为空	`domainName` 为空
域名不属于你	域名未接入当前账号，或不在当前账号可访问的标签范围内
域名格式异常:{0}	域名格式无法解析。`{0}` 为传入的域名