You need to enable JavaScript to run this app.
导航
全站加速
  • 文档首页
    • /
  • 全站加速

查询证书ListCert

最近更新时间：2024.04.10 16:11:56

首次发布时间：2024.04.10 16:11:56

我的收藏

API描述

API名称：ListCert。
API域名：open.volcengineapi.com。
API描述：查询用户在火山平台拥有的证书。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=ListCert&Version=2021-04-01

请求参数

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

Query

参数名称
数据类型
是否必选
参数说明
Action
String
是
接口名称。当前 API 的名称为 ListCert。
Version
String
是
接口版本。当前 API 的版本为 2021-04-01。

Body

参数名称
数据类型
是否必选
参数说明
示例
MatchDomain
String
否
查询某个域名绑定的证书。通过输入的加速域名，查询与该加速域名绑定的证书信息。
www.xxx.com
PageNumber
Integer
否
分页页号，最大10000，最小1，不填默认为1。
3
PageSize
Integer
否
分页页号，分页页大小，最大100，不填默认为20。
20
CertStatus
String
否

筛选不同状态的证书，支持：

  • Expired：已过期
  • Expiring：即将过期，距离真正过期时间少于30天时展示的状态
  • Running：运行中
Expired
BoundStatus
String
否

基于证书是否绑定了加速域名，进行证书的筛选。支持：

  • unbound：查询在全站加速服务上，未与加速域名相绑定的证书。
  • bound：查询在全站加速服务上，已与加速域名相绑定的证书。
unbound
ProjectName
String[]
否
证书所在的项目列表，最多允许填写一个。
default
ContainDomain
Boolean
否
是否包含DCDN的域名绑定关系，开启后可能会增加该接口的访问时间。
true

返回参数

参数名称
数据类型
参数说明
示例
Total
Integer
证书数量。
100
PageNumber
Integer
当前页号。
1
PageSize
Integer
当前页大小。
10
CertList
Object[]
与加速域名绑定的证书信息列表。
-

请求示例

POST https://open.volcengineapi.com?Action=ListCert&Version=2021-04-01
{
    "MatchDomain": "www.123.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240116194414CDF3FF504645E6BAEDAF",
        "Action": "ListCert",
        "Version": "2021-04-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "CertList": [
            {
                "CertSource": "volc",
                "CertId": "cert-d5ad7****6294455a61b64eb45b06e6a",
                "CertName": "test1",
                "Expire": "2025-01-02T03:48:07Z"
            },
            {
                "CertSource": "volc",
                "CertId": "cert-a2841031****46a0aff5d04f8608c14a",
                "CertName": "test2",
                "Expire": "2024-12-11T09:12:00Z"
            },
            {
                "CertSource": "volc",
                "CertId": "cert-2cf0477****b4c0699a00bd6ea757be0",
                "CertName": "test3",
                "Expire": "2024-12-11T09:10:32Z"
            }
        ]
    }
}