Method: projects.locations.keyRings.cryptoKeys.getProtectedResourcesSummary

返回有关受给定 Cloud KMS CryptoKey 保护的资源的汇总信息。系统将仅返回密钥所在 Cloud 组织内的资源。为使此调用成功,拥有该密钥的项目必须是某个组织的一部分。

HTTP 请求

GET https://kmsinventory.googleapis.com/v1/{name=projects/*/locations/*/keyRings/*/cryptoKeys/**}/protectedResourcesSummary

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。CryptoKey 的资源名称。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • cloudkms.cryptoKeys.get

请求正文

请求正文必须为空。

响应正文

如果成功,响应正文将包含结构如下的数据:

汇总有关受 Cloud KMS 密钥保护的资源的信息,该密钥与密钥位于同一 Cloud 组织中。

JSON 表示法
{
  "name": string,
  "resourceCount": string,
  "projectCount": integer,
  "resourceTypes": {
    string: string,
    ...
  },
  "cloudProducts": {
    string: string,
    ...
  },
  "locations": {
    string: string,
    ...
  }
}
字段
name

string

ProtectedResourcesSummary 资源的全名。示例:projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary

resourceCount

string (int64 format)

与密钥属于同一 Cloud 组织的受保护资源总数。

projectCount

integer

密钥所属 Cloud 组织中具有受该密钥保护的资源的不同 Cloud 项目的数量。

resourceTypes

map (key: string, value: string (int64 format))

受相应密钥保护的资源数(按资源类型分组)。

cloudProducts

map (key: string, value: string (int64 format))

受该密钥保护的资源数(按 Cloud 产品分组)。

locations

map (key: string, value: string (int64 format))

受该密钥保护的资源数(按区域分组)。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览