You need to enable JavaScript to run this app.
导航
查看证书详情
最近更新时间:2024.05.29 19:20:21首次发布时间:2023.09.25 14:31:46

调用 DescribeCertDetailSecretV2 接口,通过证书示例 ID 或证书链 ID 查询证书详情。

注意事项

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

请求说明

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

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeCertDetailSecretV2接口名称。当前 API 的名称为 DescribeCertDetailSecretV2
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

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

CertID

String

812******1

证书实例 ID,您可以通过ListCertV2接口获取证书示例 ID。

说明

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

ChainID

String

188b5c6f6b3c47728418932*******d2

证书链 ID,您可以通过ListcCertV2接口获取 证书链 ID。

说明

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

返回参数

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

参数类型示例值描述
CertDomainListArray of String["push.example.com"]与证书绑定的域名列表。
ChainIDString188b5c6f6b3c47728418932*******d2证书链 ID。
SSLObject of SSL-证书详细信息。
CertNameStringlive.example.com证书名称。
NotBeforeString2019-09-05T00:00:00Z证书的生效日期,RFC3339 格式的 UTC 时间,精度为秒。
NotAfterString2020-09-04T12:00:00Z证书的过期时间,RFC3339 格式的 UTC 时间,精度为秒。

Status

String

OK

证书状态,取值及含义如下所示。

  • OK:正常;
  • Expire:过期;
  • 30days:有效期剩余 30 天;
  • 15days:有效期剩余 15 天;
  • 7days:有效期剩余 7 天;
  • 1days:有效期剩余 1 天。

SSL

参数类型示例值描述
KeyTypeStringrsa密钥类型,默认为 rsa
ChainArray 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=DescribeCertDetailSecretV2&Version=2023-01-01
{
    "ChainID": "188b5c6f6b3c47728418932*******d2"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeCertDetailV2",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "CertDomainList": [
        "pull.wangyeah.xyz"
        ],
        "CertName": "pull.wangyeah.xyz",
        "ChainID": "37a012b22d554a3b8785f111d51a2b88",
        "NotAfter": "2024-08-03T23:59:59Z",
        "NotBefore": "2024-05-06T00:00:00Z",
        "SSL": {
        "Chain": [
            "-----BEGIN CERTIFICATE-----\nMIIF+TCCBOG***UrNyWlJ7\n-----END CERTIFICATE-----\n",
            "-----BEGIN CERTIFICATE-----\nMIIEqjCCA5K***QjJNSg==\n-----END CERTIFICATE-----\n",
            "-----BEGIN CERTIFICATE-----\nMIIDjjCCAna***Zl\nMrY=\n-----END CERTIFICATE-----\n"
        ]
        "KeyType": "rsa",
        },
        "Status": "OK"
    }
    }

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
500InternalErroran internal error occurred, please contact the administrator.出现内部错误,请联系技术支持
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误,请联系技术支持
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时,请联系技术支持

服务端 SDK

视频直播提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。