# 获取密钥分布统计信息 - ShowStatisticSecretKey
#### 功能介绍
获取CPCS中密钥分布统计信息
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-dew/dew_02_0002.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dew/dew_02_0308.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                         | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                                | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | cpcs::getStatisticSecretKey | Read | -           | -   | cpcs:system:getStatisticSecretKey | -      |
     
  
 
#### URI
GET /v1/{project_id}/dew/cpcs/secret-key/statistic
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 项目ID。可参考[获取项目ID](https://support.huaweicloud.com/api-dew/dew_02_0009.html)获取。 **约束限制：** 不涉及 **取值范围：** 字符长度为32 **默认取值：** 不涉及 |
   
表2Query参数 
| 参数               | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| cluster_id       | 否    | String  | **参数解释：** 集群id，默认为空，默认查询所有集群 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 空字符串        |
| app_id           | 否    | String  | **参数解释：** 应用id，默认为空，默认查询所有app **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 空字符串       |
| from             | 否    | Long    | **参数解释：** 查询的初始时间戳，毫秒级时间戳，默认查询前三天 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 0      |
| to               | 否    | Long    | **参数解释：** 查询的终止时间戳，毫秒级时间戳，默认查询到当前时间 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 0    |
| period           | 否    | Integer | **参数解释：** 统计周期，默认为1 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 1                    |
| filter           | 否    | String  | **参数解释：** 统计值，默认为min，默认用统计周期中数据的最小值。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** min |
| algorithm        | 否    | String  | **参数解释：** 算法 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 空字符串                        |
| algorithm_type   | 否    | String  | **参数解释：** 算法类型， **约束限制：** 不涉及 **取值范围：** 0：国密算法，1：国际算法 **默认取值：** 空字符串           |
| certificate_type | 否    | String  | **参数解释：** 证书类型， **约束限制：** 不涉及 **取值范围：** 0：根证书，1：业务证书 **默认取值：** 空字符串            |
| server_type      | 否    | String  | **参数解释：** 密码服务类型 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 空字符串                    |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。使用AK、SK等认证方式，此处非必选 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数                                  | 参数类型                                                                                        | 描述                                                                                                                                                                 |
|:---|:---|:---|
| total_count                         | Integer                                                                                     | **参数解释：** 总数量 **取值范围：** 不涉及          |
| invalid_count                       | Integer                                                                                     | **参数解释：** 无效数量 **取值范围：** 不涉及         |
| valid_count                         | Integer                                                                                     | **参数解释：** 有效数量 **取值范围：** 不涉及         |
| key_counts_by_service_type          | Array of [VendorKeyStatistic] objects | **参数解释：** 密钥分布按服务类型统计 **取值范围：** 不涉及  |
| key_counts_by_algorithm             | Array of [VendorKeyStatistic] objects | **参数解释：** 密钥分布按算法统计 **取值范围：** 不涉及    |
| key_counts_by_algorithm_and_cluster | Array of [VendorKeyStatistic] objects | **参数解释：** 密钥分布按算法和集群统计 **取值范围：** 不涉及 |
   
 表5VendorKeyStatistic 
| 参数            | 参数类型    | 描述                                                                                                                                                         |
|:---|:---|:---|
| total_count   | Integer | **参数解释：** 总数 **取值范围：** 不涉及   |
| valid_count   | Integer | **参数解释：** 有效数量 **取值范围：** 不涉及 |
| invalid_count | Integer | **参数解释：** 无效数量 **取值范围：** 不涉及 |
| tenant_id     | String  | **参数解释：** 租户ID **取值范围：** 不涉及 |
| cluster_id    | String  | **参数解释：** 集群ID **取值范围：** 不涉及 |
| cluster_name  | String  | **参数解释：** 集群名称 **取值范围：** 不涉及 |
| server_type   | String  | **参数解释：** 服务类型 **取值范围：** 不涉及 |
| algorithm     | String  | **参数解释：** 算法 **取值范围：** 不涉及   |
   
#### 请求示例
密码服务资源信息
```
GET https://cpcs.com/v1/{project_id}/dew/cpcs/secret-key/statistic
```
#### 响应示例
**状态码：200**
正常返回
```
{
  "total_count" : 8,
  "invalid_count" : 0,
  "valid_count" : 8,
  "key_counts_by_service_type" : [ {
    "total_count" : 8,
    "valid_count" : 8,
    "invalid_count" : 0,
    "tenant_id" : "4740d5274ad740749a9686e1b7456a85",
    "cluster_id" : "0a5217b0bc064e42a7d2e3f3c49f2b81",
    "cluster_name" : "otp",
    "server_type" : "OTP",
    "algorithm" : "SM4"
  } ],
  "key_counts_by_algorithm" : [ {
    "total_count" : 8,
    "valid_count" : 8,
    "invalid_count" : 0,
    "tenant_id" : "4740d5274ad740749a9686e1b7456a85",
    "cluster_id" : "0a5217b0bc064e42a7d2e3f3c49f2b81",
    "cluster_name" : "otp",
    "server_type" : "OTP",
    "algorithm" : "SM4"
  } ],
  "key_counts_by_algorithm_and_cluster" : [ {
    "total_count" : 8,
    "valid_count" : 8,
    "invalid_count" : 0,
    "tenant_id" : "4740d5274ad740749a9686e1b7456a85",
    "cluster_id" : "0a5217b0bc064e42a7d2e3f3c49f2b81",
    "cluster_name" : "otp",
    "server_type" : "OTP",
    "algorithm" : "SM4"
  } ]
}
```
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 200 | 正常返回 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-dew/ErrorCode.html)。