Method: organizations.protectedResources.search

指定された Cloud 組織の指定された Cloud KMS CryptoKey によって保護されているリソースのメタデータを返します。

HTTP リクエスト

GET https://kmsinventory.googleapis.com/v1/{scope=organizations/*}/protectedResources:search

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

パスパラメータ

パラメータ
scope

string

必須。組織のリソース名。例: organizations/123

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

  • cloudkms.protectedResources.search

クエリ パラメータ

パラメータ
cryptoKey

string

必須。CryptoKey のリソース名。

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

  • cloudkms.cryptoKeys.get
pageSize

integer

返されるリソースの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 500 個のリソースが返されます。最大値は 500 です。500 を超える値は 500 に強制変換されます。
pageToken

string

前回の KeyTrackingService.SearchProtectedResources 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、KeyTrackingService.SearchProtectedResources に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
resourceTypes[]

string

省略可。このリクエストが検索するリソースタイプのリスト。空の場合、すべてのトラッキング可能なリソースタイプが検索されます。

正規表現もサポートされています。次に例を示します。

  • compute.googleapis.com.* は、タイプが compute.googleapis.com で始まるリソースのみに限定します。
  • .*Image は、タイプが Image で終わるリソースのみに限定します。
  • .*Image.* は、タイプに Image を含むリソースのみに限定します。

サポートされているすべての正規表現の構文については、RE2 をご覧ください。正規表現が、サポートされているリソースタイプと一致しない場合は、INVALID_ARGUMENT エラーが返されます。

リクエストの本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

KeyTrackingService.SearchProtectedResources に対するレスポンス メッセージです。

JSON 表現 
{
  "protectedResources": [
    {
      object (ProtectedResource)
    }
  ],
  "nextPageToken": string
}
フィールド
protectedResources[]

object (ProtectedResource)

このページの保護対象リソース。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープが必要です。

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

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