查詢證書信息
更新時間 2022-12-05 17:52:57
最近更新時間: 2022-12-05 17:52:57
分享文章
接口功能介紹
查詢證書信息接口
接口約束
請保證賬戶余額大于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 | 表示系統內部錯誤。 |
錯誤碼
請參考 錯誤碼說明。