Method: projects.locations.clusters.tokenAuthUsers.list

トークンベースの認証が有効になっているクラスタのすべてのトークン認証ユーザーを一覧表示します。

HTTP リクエスト

GET https://redis.googleapis.com/v1alpha1/{parent=projects/*/locations/*/clusters/*}/tokenAuthUsers

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

パスパラメータ

パラメータ
parent

string

必須。このトークンベースの認証ユーザーが一覧表示される親リソース。形式: projects/{project}/locations/{location}/clusters/{cluster}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返す最大アイテム数。

指定しない場合は、デフォルト値の 1000 が使用されます。pageSize 値に関係なく、レスポンスには部分的なリストが含まれる場合があり、クエリ対象のインスタンスが他にも存在するかどうかを見極めるため、呼び出し元はレスポンスの のみを信頼します。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。nextPageToken を使用して、クエリ対象のクラスタがほかにもあるかどうかを判断します。
pageToken

string

省略可。前の [tokenAuthUsers.list] リクエストから返された nextPageToken 値（存在する場合）。
filter

string

省略可。結果をフィルタリングする式。
orderBy

string

省略可。定義された順序で結果を並べ替えます。

リクエストの本文

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

レスポンスの本文

[tokenAuthUsers.list][] のレスポンス メッセージ。

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

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

object (TokenAuthUser)

プロジェクト内のトークン認証ユーザーのリスト。
nextPageToken

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。
unreachable[]

string

順序なしリスト。到達できなかったトークン認証ユーザー。

認可スコープ

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

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

詳細については、Authentication Overview をご覧ください。