跳转至

查询证书配置列表

1. 接口描述

接口请求路径:GET /prod-api/cdn/layer7/ssl/describeDomainSSL

describeDomainSSL 用于分页查询当前账号下已配置证书的域名列表,支持按域名模糊搜索,以及按证书状态、到期天数筛选。

Token 获取方式见 密钥鉴权

2. 输入参数

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

参数名称 必选 类型 描述
pageNum Integer Query 参数。当前页数
示例值:1
pageSize Integer Query 参数。每页显示条目个数
示例值:10
search String Query 参数。按域名模糊搜索
示例值:waf2.demon.com
searchHeader.status String Query 参数。按证书状态筛选,支持以下值:
issuing:颁发中
normal:正常
示例值:normal
searchHeader.certEndDay Integer Query 参数。按到期天数筛选。大于 0 表示查询未来 N 天内到期;0 表示已过期
示例值:30

3. 示例

示例1 分页查询证书配置列表

输入示例

GET /prod-api/cdn/layer7/ssl/describeDomainSSL?pageNum=1&pageSize=10

代码调用

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

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

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

        URIBuilder uriBuilder = new URIBuilder("https://{登录域名}/prod-api/cdn/layer7/ssl/describeDomainSSL");
        uriBuilder.addParameter("pageNum", "1");
        uriBuilder.addParameter("pageSize", "10");

        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/cdn/layer7/ssl/describeDomainSSL")
    if err != nil {
        panic(err)
    }
    q := u.Query()
    q.Set("pageNum", "1")
    q.Set("pageSize", "10")
    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))
}

输出示例

{
  "total": 5,
  "rows": [
    {
      "sslId": 262,
      "domainId": 215,
      "domainName": "waf2.demon.com",
      "source": 2,
      "endTime": "2025-07-01T19:41:53.000+08:00",
      "status": "normal",
      "port": 0,
      "protocol": 1,
      "certificateTaskStatus": null
    },
    {
      "sslId": 253,
      "domainId": 231,
      "domainName": "lw1test.com",
      "source": 2,
      "endTime": null,
      "status": "issuing",
      "port": 0,
      "protocol": 0,
      "certificateTaskStatus": "failed"
    }
  ],
  "code": 200,
  "msg": "成功"
}

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:成功
total Integer 总条数。示例值:5
rows [DomainSSLRow] 当前页证书配置列表

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限

6. 数据模型

DomainSSLRow

域名证书配置行。

参数名称 类型 描述
sslId Integer 域名证书关联记录 ID。示例值:262
domainId Integer 域名 ID。示例值:215
domainName String 域名。示例值:waf2.demon.com
source Integer 证书来源,支持以下值:
0:自有证书
1:托管证书
2:平台颁发(无证书记录时默认返回 2
示例值:2
endTime String 证书到期时间,可能为 null。示例值:2025-07-01T19:41:53.000+08:00
status String SSL 状态,支持以下值:
issuing:颁发中
normal:正常
示例值:normal
port Integer 端口,0 表示默认端口。示例值:0
protocol Integer 回源协议,支持以下值:
0:HTTP
1:协议跟随
示例值:1
certificateTaskStatus String 平台颁发任务状态(仅 statusissuing 时有意义),支持以下值:
issued:发起申请
ongoing:处理中
request_failure:处理失败,等待重新处理
complete:完成
failed:最终失败
可能为 null。示例值:failed