更新时间:2023-10-11 GMT+08:00

查询证书列表

功能介绍

根据证书名称或绑定域名查询证书列表。

当前页面API即将废弃,建议您使用查询证书列表

URI

  • URI格式

    GET /v2/{project_id}/scm/certlist?order_status=&content=&sort_key=& sort_dir=&limit=&offset=

  • 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    项目ID。

请求消息

请求参数

参数

是否必选

参数类型

描述

order_status

String

证书状态,取值如下:

  • PAID:证书已支付;待申请证书。
  • ISSUED:证书已签发。
  • CHECKING:证书申请审核中。
  • CANCELCHECKING:取消证书申请审核中。
  • UNPASSED:证书申请未通过。
  • EXPIRED:证书已过期。
  • REVOKING:证书吊销申请审核中。
  • REVOKED:证书已吊销。
  • UPLOAD:证书托管中。
  • SUPPLEMENTCHECKING:多域名证书新增附加域名审核中。
  • CANCELSUPPLEMENTING:取消新增附加域名审核中。

content

String

搜索关键词。

sort_key

String

排序依据参数,取值如下:

  • certExpiredTime:证书到期时间。
  • certStatus:证书状态。
  • certUpdateTime:证书更新时间。

sort_dir

String

排序方式。根据排序参数sort_key进行排序,取值如下:

  • ASC:升序。
  • DESC:降序。

limit

Integer

每页条目数量,取值如下:

  • 10:每页显示10条证书信息。
  • 20:每页显示20条证书信息。
  • 50:每页显示50条证书信息。

offset

Integer

偏移量。取值范围为1~30。

响应消息

响应参数

参数

是否必选

参数类型

描述

total

Integer

列表证书数量。

free_remain

Integer

免费测试证书剩余配额。

order_list

Array of order_list objects

证书列表,详情请参见表1

表1 order_list

参数

是否必选

参数类型

描述

cert_id

String

证书ID。

cert_name

String

证书名称。

domain

String

绑定域名。

cert_type

String

证书类型。

cert_brand

String

证书品牌。

domain_type

String

域名类型。

purchase_period

Integer

有效期。

expired_time

String

证书到期时间。

order_status

String

证书状态。

domain_num

Integer

域名数量。

wildcard_number

Integer

泛域名数量。

cert_des

String

证书描述。

示例

  • 请求样例

    无。

  • 响应样例
    {  
    "total": 1, 
    "free_remain":"19", 
    "order_list": [{ 
    "cert_id": "scs1481110651012", 
    "cert_name": "scs-0001", 
    "domain": "*.example.com", 
    "cert_type": "GE00V01", 
    "cert_brand":"GLOBALSIGN",  
    "domain_type":" SINGLE_DOMAIN ", 
    "purchase_period":1, 
    "expired_time":"15051501510501", 
    "order_state":"completed ", 
    "domain_num":10, 
    "wildcard_number":2,
    "cert_des":"***********" 
    }] 
    }
    { 
       "error_code": "SCM.XXXX",  
       "error_msg": "XXXX"   
     }

状态码

表2描述的是API返回的正常状态码。
表2 状态码

状态码

编码

状态说明

200

OK

请求已成功。

异常状态码,请参见错误码