获取指定证书可关联的域名¶
1. 接口描述¶
接口请求路径:POST /prod-api/acdn/tcdn/certificate/describeCertConfig
describeCertConfig 用于查询一张证书可以关联的加速域名,以及已经配置了该证书的域名。账号需具备 tcdn:DescribeCertificate 或 tcdn:DescribeAllDomains 权限。
Token 获取方式见 密钥鉴权。
说明:
- 请传入
certId或cert。传入certId时,服务端会换成该证书的上游证书 ID 再查询。- 返回的域名会按当前账号可访问的加速域名过滤。账号有标签限制且没有可访问域名时,两个列表都是空数组。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| certId | 否 | Long | 平台证书 ID,取自 列出证书 的 rows[].certId。示例值:91 |
| cert | 否 | String | 证书内容(PEM)。与 certId 二选一即可。示例值:-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE----- |
3. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:成功 |
| data | Object | 查询结果 |
| data.response | CertDomains | 可关联域名与已配置域名 |
4. 示例¶
示例1 按证书 ID 查询可关联域名¶
输入示例¶
代码调用¶
请将 {登录域名}、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 DescribeCertConfigTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/acdn/tcdn/certificate/describeCertConfig";
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
String requestBody = "{"
+ "\"certId\":91"
+ "}";
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/describeCertConfig"
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
requestBody := []byte(`{
"certId": 91
}`)
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": {
"response": {
"domains": ["www.example.com"],
"certifiedDomains": ["www.example.com"],
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
}
5. 错误码¶
上游或校验证书失败时,code 为 500,原因在 msg。
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限,需具备 tcdn:DescribeCertificate 或 tcdn:DescribeAllDomains |
| 请输入需要查询域名的证书信息 | 未传请求体 |
| 证书不存在 | certId 不存在或不属于当前账号 |
| 证书未绑定CDN | certId 没有 TCDN 关联 |
| 未初始化TCDN配置,请先联系管理员 | 当前账号未配置 TCDN |
| 未初始化TCDN配置(apiKeyId),请先联系管理员 | 未配置 API 密钥 |
| 未初始化TCDN配置(project),请先联系管理员 | 未配置项目 |
| 未查询到对应的API密钥信息 | 密钥配置不存在 |
| error code:{0},message:{1} | 上游查询失败。{0} 为错误码,{1} 为原因 |
6. 数据模型¶
CertDomains¶
证书可关联的加速域名。两个列表都已按当前账号可访问的域名过滤,取不到有效值时可能为 null。
| 参数名称 | 类型 | 描述 |
|---|---|---|
| domains | Array of String | 已接入 CDN、且可被该证书覆盖的域名。示例值:["www.example.com"] |
| certifiedDomains | Array of String | 已配置该证书的 CDN 域名。示例值:["www.example.com"] |
| requestId | String | 唯一请求 ID。示例值:a1b2c3d4-e5f6-7890-abcd-ef1234567890 |