调用 DescribeCertDetailSecretV2
接口,通过证书 ID 或证书链 ID 查询证书详情。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeCertDetailSecretV2 | 接口名称。当前 API 的名称为 DescribeCertDetailSecretV2 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
CertID | String | 否 |
| 证书 ID,您可以通过ListCertV2接口获取证书 ID。 说明 参数 |
ChainID | String | 否 |
| 证书链 ID,您可以通过ListcCertV2接口获取 证书链 ID。 说明 参数 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
CertDomainList | Array of String | ["push.example.com"] | 与证书绑定的域名列表。 |
ChainID | String | 188b5c6f6b3c47728418932*******d2 | 证书链 ID。 |
SSL | Object of SSL | - | 证书详细信息。 |
CertName | String | live.example.com | 证书名称。 |
NotBefore | String | 2019-09-05T00:00:00Z | 证书的生效日期,RFC3339 格式的 UTC 时间,精度为秒。 |
NotAfter | String | 2020-09-04T12:00:00Z | 证书的过期时间,RFC3339 格式的 UTC 时间,精度为秒。 |
Status | String |
| 证书状态,取值及含义如下所示。
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
KeyType | String | rsa | 密钥类型,默认为 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=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" } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | CommonErr | - | 未分类错误。建议重试,如果仍返回该错误码,请联系技术支持。 |
400 | InvalidParam | - | 输入的参数无效或不符合要求,请参照请求参数说明进行检查。 |
400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验,请检查参数类型是否正确。 |
403 | RequestForbidden | - | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.AccountIDNotAllow | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。 |
404 | ResourceNotFound | - | 未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持。 |
500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误,请联系技术支持。 |
500 | InternalError.DB | an internal error related to database occurred, please contact the administrator. | 出现与数据库相关的内部错误,请联系技术支持。 |
502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时,请联系技术支持。 |
视频直播提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。