1）接口功能介绍
查询证书列表。
2）接口约束
无。
3）URI
GET /v1/listCertificate。
4）请求参数
Query参数
| 参数 | 是否必填 | 参数类型 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| page | 否 | Integer | 1 | 当前页数 | |
| perPageNum | 否 | Integer | 10 | 每页显示的记录条数 |
5）响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
| status | 是 | Object | 应答状态 | status | |
| data | 是 | Object | 返回数据 | data |
表 status
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| message | 是 | String | 状态描述 | Success | |
| code | 是 | String | 状态码 | Success |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalPage | 是 | Integer | 1 | 总页数 | |
| total | 是 | Integer | 6 | 记录总个数 | |
| page | 是 | Integer | 1 | 当前页数 | |
| perPageNum | 是 | Integer | 10 | 每页显示的记录条数 | |
| certList | 是 | List | * | 获取可用主机IP响应数据列表 | certList |
表certList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | String | 证书 id | 28 | |
| certName | 是 | String | 证书备注名 | my-certificate | |
| commonName | 是 | String | 证书通用名 | *.ctcdn.cn | |
| certState | 是 | String | 证书状态 | Validity | |
| certType | 是 | String | 证书类型 | TrustAsia OV TLS Pro CA G2 | |
| expiresTime | 是 | Long | 到期时间 | 1634817600 | Unix时间戳,秒 |
| instanceInfoDetailList | 是 | List | 证书绑定的实例列表 | * | instanceInfoDetailList |
表instanceInfoDetailList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clusterName | 是 | String | 边缘集群名称 | * | |
| nodeCode | 是 | String | 边缘集群编码 | 广州1 | |
| slbInstances | 是 | List | 负载均衡实例列表 | slbInstances |
表slbInstances
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | String | 负载均衡id | 172 | |
| name | 是 | String | 负载均衡名称 | slb-1112 |
6）请求示例
GET https://{host}/v1/listCertificate?page=1&perPageNum=10
7）响应示例
{
"data": {
"certList": [
{
"id": "28",
"certName": "my-certificate",
"commonName": "*.ctcdn.cn",
"certState": "Validity",
"certType": "TrustAsia OV TLS Pro CA G2",
"expiresTime": 1634817600,
"instanceInfoDetailList": [
{
"clusterName": "广州1",
"nodeCode": "cn-guangzhou1",
"slbInstances": [
{
"id": "172",
"name": "slb-1112"
}
]
}
]
}
],
"page": 1,
"perPageNum": 10,
"totalPage": 1,
"total": 1
},
"requestId": "bda56e19-596c-4a76-b3ad-1a8f2f3ba4ce",
"status": {
"code": "Success",
"message": "Success"
}
}
8）状态码
| 状态码 | 描述 |
|---|---|
| Success | 表示请求成功。 |
