Method: projects.cryptoKeys.list

指定された Cloud プロジェクトの Cloud KMS によって管理されている暗号鍵を返します。このデータはスナップショットから取得されるため、呼び出し時の鍵メタデータの実際の状態が完全に反映されない場合があります。

HTTP リクエスト

GET https://kmsinventory.googleapis.com/v1/{parent=projects/*}/cryptoKeys

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

パスパラメータ

パラメータ
parent

string

必須。キーのメタデータを取得する Google Cloud プロジェクト（projects/* 形式）。

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

  • cloudkms.cryptoKeys.list

クエリ パラメータ

パラメータ
pageSize

integer

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

string

省略可。次のページの結果を取得するには、これを後続のリクエストに渡します。

リクエストの本文

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

レスポンスの本文

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

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

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

object (CryptoKey)

CryptoKeys のリスト。
nextPageToken

string

次のページが必要な場合、前のレスポンスから返されたページトークン。

認可スコープ

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

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

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