Method: projects.locations.sessions.list

列出互動工作階段。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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-01-01 前建立的「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

詳情請參閱驗證總覽一文。