Method: projects.locations.keyRings.cryptoKeys.getProtectedResourcesSummary

指定された Cloud KMS CryptoKey によって保護されているリソースの集計情報を返します。鍵と同じ Cloud 組織内のリソースのみが返されます。この呼び出しが成功するには、鍵を保持するプロジェクトが組織の一部であることが必要です。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。CryptoKey のリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • cloudkms.cryptoKeys.get

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

鍵と同じ Cloud 組織内の Cloud KMS 鍵で保護されているリソースに関する情報を集約します。

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

詳細については、認証の概要をご覧ください。