查询租户的资源分布信息 - ShowResourceInfo

功能介绍

查询租户的资源分布信息

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cpcs::getResourceInfo
Read
-
-
cpcs:system:getResourceInfo
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
cpcs::getResourceInfo	Read	-	-	cpcs:system:getResourceInfo	-

URI

GET /v1/{project_id}/dew/cpcs/resource-info

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户token，参见:IAM token获取方法

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
cloud_service	CloudServiceInfo object	云原生密码服务资源分布情况
ccsp_service	CcspServiceInfo object	密码服务资源分布情况
vsm	VsmResourceInfo object	云密码虚拟机资源分布情况
app	AppResourceInfo object	应用情况
kms	KmsResourceInfo object	KMS密钥资源分布情况

表4 CloudServiceInfo
参数	参数类型	描述
service_num	Integer	当前租户开通的云原生密码服务数量（只统计白名单服务情况）
resource_num	Integer	当前租户云原生密码服务的资源实例总和
resource_distribution	ResourceDistribution object	当前租户云原生密码服务资源实例的分布情况

表5 ResourceDistribution
参数	参数类型	描述
kms	Integer	密钥管理服务密钥数量

表6 CcspServiceInfo
参数	参数类型	描述
cluster_num	Integer	当前租户拥有的密码服务集群数量
instance_num	Integer	当前租户拥有的密码服务实例数量
instance_quota	Integer	当前租户的可创建的密码服务实例配额数
instance_distribution	InstanceDistribution object	密码服务实例按服务类型的数量分布情况

表7 InstanceDistribution
参数	参数类型	描述
encrypt_decrypt	Integer	加解密服务实例数量
sign_verify	Integer	签名验签服务实例数量
kms	Integer	密钥管理服务实例数量
timestamp	Integer	时间戳服务实例数量
colla_sign	Integer	协同签名服务实例数量
otp	Integer	动态口令服务实例数量
db_encrypt	Integer	数据库加密服务实例数量
file_encrypt	Integer	文件加密服务实例数量
digit_seal	Integer	电子签章服务实例数量
ssl_vpn	Integer	ssl vpn服务实例数量

表8 VsmResourceInfo
参数	参数类型	描述
cluster_num	Integer	当前租户拥有的vsm集群数量
cpcs_cluster_num	Integer	当前租户名下由cpcs代创建和管理的vsm集群数量
instance_num	Integer	当前租户拥有的vsm实例总数
cpcs_instance_num	Integer	当前租户名下由cpcs代创建和管理的vsm实例总数
instance_quota	Integer	当前租户被分配的vsm实例配额数

表9 AppResourceInfo
参数	参数类型	描述
app_num	Integer	当前租户在cpcs创建的简单应用数量

**表10** KmsResourceInfo
参数	参数类型	描述
total_num	Integer	KMS密钥数量
result	KmsInfo object	KMS密钥类型的数量分布情况

**表11** KmsInfo
参数	参数类型	描述
aes_256	Integer	AES_256算法密钥数量
sm4	Integer	SM4算法密钥数量
rsa_2048	Integer	RSA_2048算法密钥数量
rsa_3072	Integer	RSA_3072算法密钥数量
rsa_4096	Integer	RSA_4096算法密钥数量
ec_p256	Integer	EC_P256算法密钥数量
ec_p384	Integer	EC_P384务算法密钥数量
sm2	Integer	SM2算法密钥数量

请求示例

查询租户的资源信息请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限

GET https://cpcs.com/v1/{project_id}/dew/cpcs/resource-info

响应示例

状态码：200

请求已成功

{
  "cloud_service" : {
    "service_num" : 1,
    "resource_num" : 10,
    "resource_distribution" : {
      "kms" : 10
    }
  },
  "ccsp_service" : {
    "cluster_num" : 10,
    "instance_num" : 46,
    "instance_quota" : 80,
    "instance_distribution" : {
      "encrypt_decrypt" : 10,
      "sign_verify" : 4,
      "kms" : 4,
      "timestamp" : 4,
      "colla_sign" : 4,
      "otp" : 4,
      "db_encrypt" : 4,
      "file_encrypt" : 6,
      "digit_seal" : 4,
      "ssl_vpn" : 2
    }
  },
  "vsm" : {
    "cluster_num" : 10,
    "cpcs_cluster_num" : 7,
    "instance_num" : 30,
    "cpcs_instance_num" : 21,
    "instance_quota" : 40
  },
  "app" : {
    "app_num" : 20
  },
  "kms" : {
    "total_num" : 40,
    "result" : {
      "aes_256" : 10,
      "sm4" : 4,
      "rsa_2048" : 4,
      "rsa_3072" : 4,
      "rsa_4096" : 4,
      "ec_p256" : 4,
      "ec_p384" : 4,
      "sm2" : 6
    }
  }
}