查询证书列表

查询 PBX 系统上的证书列表，包括导入和申请的证书。

请求 URL

GET {base_url}/{api_path}/certificate/list?access_token={access_token}

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • id：基于证书 ID 排序。
  • name：基于证书名称排序。
  • issue_to：基于证书关联的域名排序。
  • expiration：基于到期时间排序。
  • type：基于证书类型排序。
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序
type 否 String 按特定证书类型筛选结果。
取值范围：
  • trusted：受信任证书。
  • server：PBX 服务器证书。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 证书总数。
certificate_list Array<Cert_List> 证书信息。
Cert_List
参数 类型 说明
id Integer 证书 ID。
name String 证书名称。
type String 证书类型。
  • trusted：受信任证书。
  • server：PBX 服务器证书。
issue_to String 证书所关联的域名。
expiration String 证书的到期时间。
ca_type String 证书的添加方式。
注： 此参数仅在 PBX 服务器证书信息中返回。
  • upload：导入证书到 PBX 中。
  • apply：通过 PBX 申请证书。
auto_renewal Integer 证书是否启用了自动刷新。
注： 此参数仅在 PBX 服务器证书信息中返回。
  • 0：禁用。
  • 1：启用。
dns_provider String

指定用于证书申请和自动刷新的 DNS 服务提供商。

注： 此参数仅在 PBX 服务器证书信息中返回。
apply_status String
证书的当前申请状态。
  • issuing：申请中。
  • issuance_success：签发成功。
  • issuance_fail：签发失败。
apply_tip_code Integer 证书申请或刷新操作的提示码。
注： 此参数在证书申请或刷新失败时返回，且该提示码由 DNS 服务器生成。
auth_info_list Array<Auth_Info> 证书申请和自动刷新所需的 DNS 验证信息。
注： 此参数仅在 PBX 服务器证书信息中返回。
Auth_Info
注： 有关 DNS 验证参数的详细说明，请参见 支持的 DNS 提供商。
参数 类型 说明
k String DNS 提供商定义的验证参数键名。
iv Integer 用于返回整型格式的验证参数值。
sv String 用于返回字符串格式的验证参数值。
bv Boolean 用于返回布尔型格式的验证参数值。

示例

请求示例

GET /openapi/v1.0/certificate/list?access_token=n7V6X4DIqK8zdJiOMLcZ842NA2x8rl6x HTTP/1.1
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 3,
    "certificate_list": [
        {
            "id": 1,
            "name": "wildcard_example_com.crt",
            "type": "trusted",
            "issue_to": "*.example.com",
            "expiration": "2025/05/25 03:03:10 PM",
            "apply_status": "issuance_success"
        },
        {
            "id": 2,
            "name": "example.domain.com.crt",
            "type": "server",
            "issue_to": "example.domain.com",
            "expiration": "2025/05/25 10:45:42 AM",
            "ca_type": "upload",
            "apply_status": "issuance_success"
        },
        {
            "id": 3,
            "name": "docs.example.com.pem",
            "type": "server",
            "issue_to": "docs.example.com",
            "expiration": "-",
            "ca_type": "apply",
            "auto_renewal": 1,
            "dns_provider": "alidns",
            "apply_status": "issuing",
            "auth_info_list": [
                {
                    "k": "AccessKeyId",
                    "sv": "AKIAIXXXXXXXXXXAMPLE"
                },
                {
                    "k": "AccessKeySecret",
                    "sv": "wJalrXUXXXXXXXXXXLEKEY"
                },
                {
                    "k": "PropagationTimeout",
                    "iv": 300
                },
                {
                    "k": "PollingInterval",
                    "iv": 5
                },
                {
                    "k": "TTL",
                    "iv": 600
                }
            ]
        }
    ]
}