接口功能介绍
调用本接口查询证书详情信息。
使用说明
- 支持按照证书备用名或证书ID查询,若两个参数都传,以证书备用名为准
- 由于证书平台经历过迁移,旧平台没有证书ID的字段,因此返回参数id可能不存在
- 单个用户一分钟限制调用10000次,并发不超过100。
接口详情
请求方式:get
请求路径:/cert/query-cert-detail
请求参数
参数 | 类型 | 名称 | 是否必填 | 说明 |
---|---|---|---|---|
name | string | 证书备注名 | 否 | name和id必填其中一个,若都填返回name查询结果 |
id | Integer | 证书id | 否 | name和id必填其中一个,若都填返回name查询结果 |
usage_mode | Integer | 证书用途 | 否 | 取值范围:0(加速域名的证书和私钥),1(客户端CA链证书),2(源站CA链证书),3(CDN回源节点证书和私钥),4(加速域名的证书和私钥(国密)),其中1、2、3是双向认证场景使用的证书 |
响应参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码 | 100000 | |
message | String | 结果简述 | 正确返回 | |
returnObj | Object | 返回对象 | returnObj | |
error | String | 错误码 | CDN_200002 | |
errorMessage | String | 错误详情 | 请求参数校验失败,XXX |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
result | Object | 证书信息 | result |
表 result
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
id | Integer | 证书id | 7034 | |
expires | Integer | 证书过期时间 | 1914562170 | |
issue | Integer | 证书颁发时间 | 1599202170 | |
issuer | String | 证书颁发机构 | Internet Widgits Pty Ltd | |
created | Integer | 证书创建时间 | 1600877997 | |
name | String | 证书备注名称 | aa | |
cn | String | 证书通用名称 | ctyun.cn | |
certs | String | 证书公钥信息 | xxx | |
key | String | 证书私钥信息 | xxx | |
sans | Array of Strings | 证书授权域名,即证书可以被哪些域名使用 | ctyun.cn1 | |
usage_mode | Integer | 证书用途,0:加速域名的证书和私钥 1:客户端CA链证书 2:源站CA链证书 3:CDN回源节点证书和私钥 4:加速域名的证书和私钥(国密);其中1、2、3是双向认证场景使用的证书 | 0 |
示例
请求路径:https://cdnapi-global.ctapi.ctyun.cn/cert/query-cert-detail
请求示例
https://cdnapi-global.ctapi.ctyun.cn/cert/query-cert-detail?name=xxxx
正常响应示例
{
"statusCode":100000,
"message":"正确返回",
"returnObj":{
"result":{
"id":7034,
"expires":1914562170,
"issue":1599202170,
"sans":[
"ctyun.cn",
"ctyun.cn1"
],
"created":1600877997,
"name":"aa",
"cn":"ctyun.cn2",
"issuer":"Internet Widgits Pty Ltd",
"certs":"xxx",
"key":"xxx",
"usage_mode":0
}
}
}
错误码请参考:参数code和message含义