接口功能介绍
证书列表接口
接口约束
请保证账户余额大于0
URI
POST /manageCertificate/listCertifiicate
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| hmac | 是 | String | kms鉴权值 | B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw= | |
| requestDate | 是 | String | 时间戳 | Wed, 29 Aug 2023 17:05:01 CST | |
| accessKey | 是 | String | ctapi鉴权ak | ae2cc5cc5e8211ea978a186590d96509 | |
| userId | 是 | String | 用户id | 562b89493b1a40e1b97ea05e50dd8170 | |
| regionId | 是 | Integer | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNumber | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 每页显示证书数量 | 10 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回码 取值范围：200 成功 | 200 | |
| errorCode | 是 | String | 错误码 | KMS.0514 | |
| msg | 是 | String | 调用结果信息 | 证书状态更新成功 | |
| data | 是 | Object | 接口返回结果 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| content | 是 | List | 证书列表 | certInfo | |
| pageNumber | 是 | Integer | 当前页码 | 1 | |
| pageSize | 是 | Integer | 本页数量 | 10 | |
| totalCount | 是 | Integer | 证书总数 | 10 |
表 certInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| certificateId | 是 | String | 证书id | c761ed38-f582-45ca-996b-d11e9740dec8 | |
| keySpec | 是 | String | 证书密钥类型 | RSA_2048 | |
| exportablePrivateKey | 是 | Integer | 证书私钥是否可导出 1：可 0：不可 | 1 | |
| subject | 是 | String | 证书主体 | CN="defaultUserNameCN=userName", OU=kms, O=aliyun, ST=BeiJing, C=CN | |
| createdTime | 是 | String | 证书创建时间 | 2022-11-07 18:15:34 | |
| status | 是 | Integer | 证书状态 1.PENDING待导入 2.ACTIVE启用 3.INACTIVE禁用 4.REVOKED已吊销 | 2 |
请求示例
请求头header
{
"hmac": "B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw=",
"requestDate": "Wed, 29 Aug 2023 17:05:01 CST",
"accessKey": "ae2cc5cc5e8211ea978a186590d96509",
"userId":"562b89493b1a40e1b97ea05e50dd8170",
"regionId":"fecnjniakfkn2314ndekqldedcsadfg"
}请求体body
{
"pageNumber":"1",
"pageSize":"10"
}响应示例
{
"code": "200",
"errorCode": null,
"msg": "列表成功",
"data": {
"content": [
{
"certificateId": "c761ed38-f582-45ca-996b-d11e9740dec8",
"keySpec": "RSA_2048",
"exportablePrivateKey": 1,
"subject": null,
"createdTime": "2022-11-07 18:15:34",
"status": 2
},
{
"certificateId": "4882c278-9b68-4818-993d-b01ab7d5995f",
"keySpec": "RSA_2048",
"exportablePrivateKey": 1,
"subject": "CN=\"defaultUserNameCN=userName\", OU=kms, O=aliyun, ST=BeiJing, C=CN",
"createdTime": "2022-11-08 19:15:01",
"status": 2
}
],
"pageNumber": 1,
"pageSize": 10,
"totalCount": 10
}
}状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
