接口功能介绍
查询ukey证书详情
接口约束
无
URI
POST /v1/manageCertificate/describeCertificateForUk
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
certificateId | 是 | String | 证书id | 96126272-5262-4b61-bf5c-d66ca3c7a0b3 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | String | 状态码 取值范围:200 成功 | 200 | |
message | 是 | String | 提示信息 | Success | |
returnObj | 是 | Object | 返回数据结构体 | {} | result |
error | 否 | String | 错误码 仅错误时返回 格式为{服务编码}.{错误编号} | KMS.0269 |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
certificateId | 是 | String | 证书id | 474e569e-8814-474a-948b-dbcf6d853eff | |
certificateName | 是 | String | 证书名称 | cert1 | |
createdAt | 是 | String | 创建时间 | 2020-10-13T03:05:03Z | |
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 | 是 | Integer | 证书状态 | 2 | |
subject | 是 | String | 证书拥有者主体 | CN=userName,OU=aliyun,O=aliyun,C=CN | |
subjectAlternativeNames | 是 | Array of Strings | 证书主体别名 | ["test1.example.com","test2.example.com"] | |
subjectKeyIdentifier | 是 | String | 主体公钥识别符 | ab cd ef gh *** | |
subjectPublicKey | 是 | String | 证书公钥 | -----BEGIN PUBLIC KEY----- *** -----END PUBLIC KEY----- | |
epId | 是 | String | 企业项目 | 1 | |
useId | 是 | String | 创建者 | 1 |
枚举参数
参数名 status
枚举值 | 类型 | 说明 |
---|---|---|
2 | Integer | 启用 |
3 | Integer | 禁用 |
5 | Integer | 过期 |
请求示例
请求url
https://{host}/v1/manageCertificate/describeCertificateForUk
请求头header
{
"regionid": "fecnjniakfkn2314ndekqldedcsadfg"
}
请求体body
{
"certificateId":96126272-5262-4b61-bf5c-d66ca3c7a0b3
}
响应示例
{
"statusCode": 200,
"message": "获取Ukey证书详情成功",
"returnObj": {
"certificateId": "96126272-5262-4b61-bf5c-d66ca3c7a0b3",
"createdAt": "2024-08-07 15:08:13",
"issuer": "EMAILADDRESS=cloud@StatusCloud.com, CN=localhost, OU=section, O=StatusCloud, L=BJ, ST=BJ, C=CN",
"keySpec": "RSA_2048",
"notAfter": "2025-08-07 15:34:53",
"notBefore": "2024-08-07 15:34:53",
"serial": "1",
"signatureAlgorithm": "SHA256withRSA",
"status": 2,
"subject": "CN=Ree,email=ree@StateCloud.com,OU=kms,O=StateCloud,C=CN",
"subjectAlternativeNames": [
"www.test1.com"
],
"subjectKeyIdentifier": "f3fbac152013950a4d0f949cf5bf7338abe0fca3",
"subjectPublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvPbKVpuylWRHzxv8U1fXsH4YeMEgbQlu5SPNzdFS++pVadzy1PfxkbMAkegInRiBkFuqIKFymTW9YoQBcc4OnUsuYqUL6nZUzl3PX93tdBdiIWB+fLx2MgoEIXW17FY6OYu76/Mb9dj8tDi1Vv+//hNOFPxCvvkZoFeeyjvNw8HTwLC4jULB9yeMDGiUcpkjjZelEhWK3JbaAgsF2/ABb+Qi0XorEcFpDj6BBbJD08iZtPmWsFkoWlsg84JuWvIsR2cFp6Q62ePKLgpVGfg2gPuHnu29GoGRD6l4GwSeNSKoQcXR2uh/y58wgLRqrxCwFirwfg08N488vK4XFAY2nwIDAQAB\n-----END PUBLIC KEY-----",
"epId": "31",
"userId": "user"
}
}
状态码
请参考状态码章节
错误码
请参考错误码章节