メソッド: keyRings.list

フルネーム: projects.locations.keyRings.list

KeyRings をリストします。

HTTP リクエスト

GET https://cloudkms.googleapis.com/v1/{parent=projects/*/locations/*}/keyRings

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

パスパラメータ

パラメータ
parent

string

必須。KeyRings に関連付けられているロケーションのリソース名。形式は projects/*/locations/* です。

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

  • cloudkms.keyRings.list

クエリ パラメータ

パラメータ
pageSize

number

レスポンスに含める KeyRings の上限数。オプションです。それ以降の KeyRings は、後続のリクエストに ListKeyRingsResponse.next_page_token を含めることによって後で取得できます。指定していない場合は、適切なデフォルトが選択されます。

pageToken

string

前の ListKeyRingsResponse.next_page_token で返されたページ設定トークン。オプションです。

リクエストの本文

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

レスポンスの本文

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

KeyManagementService.ListKeyRings に対するレスポンス メッセージ。

JSON 表現

{
  "keyRings": [
    {
      object(KeyRing)
    }
  ],
  "nextPageToken": string,
  "totalSize": number
}
フィールド
keyRings[]

object(KeyRing)

KeyRings のリスト。

nextPageToken

string

結果の次ページを取得するためのトークン。この値を ListKeyRingsRequest.page_token で渡して、結果の次ページを取得します。

totalSize

number

クエリに一致した KeyRings の総数。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

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

試してみましょう

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Cloud KMS ドキュメント