接口功能介绍
查询证书信息接口
接口约束
请保证账户余额大于0
URI
POST /v1/manageCertificate/describeCertificate
路径参数
无
Query参数
无
请求参数
请求头header参数
请参见请求消息头
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| certificateId | 是 | String | 证书id | 474e569e-8814-474a-948b-dbcf6d853eff |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 |
200 | |
| errorCode | 是 | String | 错误码 | KMS.0514 | |
| msg | 是 | String | 调用结果信息 | 获取证书信息成功 | |
| data | 是 | Object | 接口返回结果 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| certificateId | 是 | String | 证书id | 474e569e-8814-474a-948b-dbcf6d853eff | |
| createdAt | 是 | String | 创建时间 | 2020-10-13T03:05:03Z | |
| exportablePrivateKey | 是 | int | 私钥是否可以导出 | 1 | |
| issuer | 是 | String | 证书的签发者信息 | CN=testCA,OU=kms,O=aliyun,C=CN | |
| keySpec | 是 | String | 证书密钥类型 | RSA_2048 | |
| notAfter | 是 | String | 证书有效期的截止时间 | 2022-10-13T03:09:00Z | |
| notBefore | 是 | String | 证书有效期的开始时间 | 2020-10-13T03:09:00Z | |
| serial | 是 | String | 证书序列号 | 12345 | |
| signatureAlgorithm | 是 | String | 证书签名算法 | RSA2048-SHA256 | |
| status | 是 | int | 证书状态 | 1 | |
| subject | 是 | String | 证书拥有者主体 | CN=userName,OU=aliyun,O=aliyun,C=CN | |
| subjectAlternativeNames | 是 | String | 证书主体别名 | ["test1.example.com","test2.example.com"] | |
| subjectKeyIdentifier | 是 | String | 主体公钥识别符 | ab cd ef gh *** | |
| subjectPublicKey | 是 | String | 证书公钥 | -----BEGIN PUBLIC KEY----- ******* -----END PUBLIC KEY----- | |
| updatedAt | 是 | String | 更新时间 | 2020-10-13T03:09:00Z | |
| keyUsage | 是 | String | 证书用途 | 1 |
请求示例
请求头header
{
"Content-Type": "application/json",
"requestDate": "20221101T154654Z",
"ctyun-eop-request-id": "89bf1559-a96e-4bc9-98fc-394d169a42e4",
"Eop-Authorization":"91ef73a6329545c294be1d5c763bdf7e Headers=ctyun-eop-request-id;eop-date Signature=2mc3zggaqLEGTSVy2H8lWsFEm+BNJf0CrcomDSOxPfc=",
"regionId":"60a39fca876e11ea91cf0242ac110002"
}
请求体body
{
"certificateId":"474e569e-8814-474a-948b-dbcf6d853eff"
}
响应示例
{
"code": "200",
"errorCode": null,
"msg": "获取证书信息成功",
"data": {
"certificateId": "474e569e-8814-474a-948b-dbcf6d853eff",
"createdAt": "2020-10-13T03:05:03Z",
"exportablePrivateKey": 1,
"issuer": "CN=testCA,OU=kms,O=aliyun,C=CN",
"keySpec": "RSA_2048",
"notAfter": "2022-10-13T03:09:00Z",
"notBefore": "2020-10-13T03:09:00Z",
"serial": "12345",
"signatureAlgorithm": "RSA2048-SHA256",
"status": "1",
"subject": "CN=userName,OU=aliyun,O=aliyun,C=CN",
"subjectAlternativeNames": ["test1.example.com","test2.example.com"],
"subjectKeyIdentifier": "ab cd ef gh *** ",
"subjectPublicKey": "-----BEGIN PUBLIC KEY----- ******* -----END PUBLIC KEY----- ",
"updatedAt": "2020-10-13T03:09:00Z",
"keyUsage": "1"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
| 400 | 表示参数缺失或错误。 |
| 401 | 表示用户验证错误。 |
| 404 | 表示操作目标不可用。 |
| 500 | 表示系统内部错误。 |
错误码
请参考 错误码说明。
