You need to enable JavaScript to run this app.
导航

查看证书详情 V2

最近更新时间2023.11.20 11:50:29

首次发布时间2022.08.11 14:10:12

查看一个证书的详细信息,包括绑定的域名、证书名称等信息。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询证书详情接口。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=DescribeCertDetailSceretV2&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringDescribeCertDetailSceretV2接口名称。当前 API 的名称为 DescribeCertDetailSceretV2
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述

ChainID

String

188b5c6f6b3c47728418932*******d2

证书链 ID,可以通过查询证书列表接口获取。

说明

参数 ChainID 与 CertID 传且仅传一个。

CertID

String

812******1

证书实例 ID,可以通过查询证书列表接口获取。

说明

参数 ChainID 与 CertID 传且仅传一个。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述
CertDomainListArray of String["live.example.com"]与证书绑定的域名列表
ChainIDString188b5c6f6b3c47728418932*******d2证书链 ID
RsaArray of Rsa-证书详细信息
CertNameStringlive.example.com证书名称

Status

String

OK

证书状态,取值与含义的对应关系如下所示。

  • OK:正常;
  • Expire:过期;
  • 30days:有效期剩余 30 天;
  • 15days:有效期剩余 15 天;
  • 7days:有效期剩余 7 天;
  • 1days:有效期剩余 1 天。
NotBeforeString2019-09-05T00:00:00+08:00证书的生效日期,RFC3339 格式的 UTC 时间,精度为 s
NotAfterString2020-09-04T12:00:00+08:00证书的过期时间,RFC3339 格式的 UTC 时间,精度为 s

Rsa

参数类型示例值描述
KeyTypeStringrsa密钥类型,默认为 rsa

Chain

Array of String

[
            "-----BEGIN CERTIFICATE-----MIIFa**********5S98-----END CERTIFICATE-----",
            "-----BEGIN CERTIFICATE-----MIIEk**********0UiB-----END CERTIFICATE-----",
            "-----BEGIN CERTIFICATE-----MIIEN**********B5==-----END CERTIFICATE-----"
            ]

证书链,包括叶子证书(服务器证书)、中间证书(中间 CA 证书)以及根证书(根 CA 证书)。证书链中的证书使用 PEM 编码格式

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeCertDetailSceretV2&Version=2020-08-01
{
    "ChainID": "188b5c6f6b3c47728418932*******d2"
}

返回示例

{
  "ResponseMetadata": {
    "RequestID": "2020091615344501022706705720725",
    "Action": "DescribeCertDetailSceretV2",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "ChainID": "188b5c6f6b3c47728418932*******d2",
    "ChainDomainList": [
      "live.example.com"
    ],
    "CertName": "live.example.com",
    "status": "OK",
    "NotBefore": "2019-09-05T00:00:00+08:00",
    "NotAfter": "2020-09-04T12:00:00+08:00",
    "Rsa": {
      "KeyType": "rsa",
      "Chain": [
        "-----BEGIN CERTIFICATE-----MIIFa**********5S98-----END CERTIFICATE-----",
        "-----BEGIN CERTIFICATE-----MIIEk**********0UiB-----END CERTIFICATE-----",
        "-----BEGIN CERTIFICATE-----MIIEN**********B5==-----END CERTIFICATE-----"
      ]
    }
  }
}

错误码

访问公共错误码获取详细信息。