获取证书详情 - ShowResourceDetailCertificate
功能介绍
获取所监控或者统计的证书详情。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cpcs::getResourceDetailCertificate
Read
-
-
cpcs:system:getResourceDetailCertificate
-
URI
GET /v1/{project_id}/dew/cpcs/resource/certificates
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| cluster_id | 否 | String | 参数解释: 集群id,默认空字符串,默认查询所有集群 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| app_id | 否 | String | 参数解释: 应用id,默认空字符串,默认查询所有的应用 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| service_type | 否 | String | 参数解释: 密码服务类型,默认空字符串,默认查询所有密码服务类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| algorithm_type | 否 | String | 参数解释: 算法类型,默认空字符串,0:国密,1:国际 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| certificate_type | 否 | String | 参数解释: 证书类型,默认空字符串,0:根证书,1:业务证书 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 页面大小,不超过1500 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 页数,默认1 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| from | 否 | Long | 参数解释: 查询起始时间戳,毫秒级时间戳,默认为0,默认从三天前查询 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| to | 否 | Long | 参数解释: 查询终止时间戳,毫秒级时间戳,默认为0,默认查询到当前时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。使用AK、SK等认证方式,此处非必选 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| metric_name | String | 参数解释: 资源名称 取值范围: 不涉及 |
| certificate_list | Array of certificate_list objects | 参数解释: 证书详情列表 取值范围: 不涉及 |
| total_count | Integer | 参数解释: 证书总数 取值范围: 不涉及 |
| expired_count | Integer | 参数解释: 证书过期数量 取值范围: 不涉及 |
| expiring_count | Integer | 参数解释: 证书即将过期数量 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 证书名称 取值范围: 不涉及 |
| id | String | 参数解释: 证书ID 取值范围: 不涉及 |
| tenant_id | String | 参数解释: 租户ID 取值范围: 不涉及 |
| cluster_id | String | 参数解释: 集群ID 取值范围: 不涉及 |
| server_type | String | 参数解释: 密码服务类型 取值范围: 不涉及 |
| certificate_type | String | 参数解释: 证书类型,0:根证书,1:业务证书 取值范围: 不涉及 |
| algorithm_type | String | 参数解释: 算法类型,0:国密,1:国际 取值范围: 不涉及 |
| algorithm | String | 参数解释: 算法名称 取值范围: 不涉及 |
| start_time | Long | 参数解释: 开始时间,UNIX时间戳,单位毫秒 取值范围: 不涉及 |
| expired_time | Long | 参数解释: 过期时间,UNIX时间戳,单位毫秒 取值范围: 不涉及 |
| issuer | String | 参数解释: 签发者 取值范围: 不涉及 |
| user | String | 参数解释: 用户 取值范围: 不涉及 |
| status | Integer | 参数解释: 证书状态,0:正常,2:过期,3:即将过期 取值范围: 不涉及 |
| create_time | String | 参数解释: 创建时间 取值范围: 不涉及 |
请求示例
-
GET https://cpcs.com/v1/{project_id}/dew/cpcs/resource/certificates?algorithm_type=&certificate_type=&cluster_id=&service_type=&limit=10&offset=1 -
获取特定类型的证书详情,服务为协同签名,算法为国际算法,根证书,第一页,一页10个
GET https://cpcs.com/v1/{project_id}/dew/cpcs/resource/certificates?algorithm_type=1&certificate_type=0&cluster_id=&service_type=COLLA_SIGN&limit=10&offset=1 -
GET https://cpcs.com/v1/{project_id}/dew/cpcs/resource/certificates?algorithm_type=&certificate_type=&cluster_id=&service_type=&limit=10&offset=1
响应示例
状态码:200
正常返回
{
"metric_name" : "证书的详情信息",
"certificate_list" : [ {
"name" : "缺省RSA证书_0",
"id" : "216e49989f583aacf829d4dbce584c76",
"tenant_id" : "3bab8e245e854f68af5967c00dd43127",
"cluster_id" : "227c92f3b5e849e3bbff50f1b57c2143",
"server_type" : "SSL_VPN",
"certificate_type" : "0",
"algorithm_type" : null,
"algorithm" : "RSA",
"start_time" : 1739772940000,
"expired_time" : 2370492940000,
"issuer" : "",
"user" : "",
"status" : 0,
"create_time" : "2024-05-28 13:53:50"
}, {
"name" : "缺省SM2证书_0",
"id" : "83da123629dc87ca10a19251a24407dc",
"tenant_id" : "3bab8e245e854f68af5967c00dd43127",
"cluster_id" : "227c92f3b5e849e3bbff50f1b57c2143",
"server_type" : "SSL_VPN",
"certificate_type" : "0",
"algorithm_type" : null,
"algorithm" : "SM2",
"start_time" : 1739772940000,
"expired_time" : 2370492940000,
"issuer" : "",
"user" : "",
"status" : 0,
"create_time" : "2024-05-28 13:53:50"
} ],
"total_count" : 8,
"expired_count" : 0,
"expiring_count" : 0
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 正常返回 |
错误码
请参见错误码。