Method: projects.locations.sessions.list

インタラクティブ セッションを一覧表示します。

HTTP リクエスト

GET https://dataproc.googleapis.com/v1/{parent=projects/*/locations/*}/sessions

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

パスパラメータ

パラメータ
parent

string

必須。このセッション コレクションを所有する親。

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

  • dataproc.sessions.list

クエリ パラメータ

パラメータ
pageSize

integer

省略可。各レスポンスで返されるセッションの最大数。サービスが返す値はこれよりも少ないことがあります。
pageToken

string

省略可。前回の sessions.list 呼び出しから受け取ったページトークン。後続のページを取得するには、このトークンを指定します。
filter

string

省略可。レスポンスで返されるセッションのフィルタ。

フィルタは、各セッション リソースのさまざまなフィールドの値を制約する論理式です。フィルタは、大文字と小文字が区別され、論理演算子（AND、OR）で組み合わせた複数の句を含めることができます。サポートされているフィールドは sessionId、sessionUuid、state、createTime、labels です。

例: state = ACTIVE and createTime < "2023-01-01T00:00:00Z" は、2023 年 1 月 1 日より前に作成された ACTIVE 状態のセッションのフィルタです。state = ACTIVE and labels.environment=production は、本番環境ラベルを持つ ACTIVE 状態のセッションのフィルタです。

フィルタ構文の詳細とサポートされている比較演算子のリストについては、https://google.aip.dev/assets/misc/ebnf-filtering.txt をご覧ください。

リクエストの本文

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

レスポンスの本文

インタラクティブ セッションのリスト。

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

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

object (Session)

出力専用。指定したコレクションのセッション。
nextPageToken

string

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

認可スコープ

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

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

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