Method: projects.locations.batches.list

일괄 워크로드를 나열합니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 입력란입니다. 이 일괄 컬렉션을 소유한 상위 요소입니다.

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • dataproc.batches.list

쿼리 매개변수

매개변수
pageSize

integer

선택사항입니다. 각 응답에서 반환할 최대 일괄 처리 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 기본 페이지 크기는 20이고 최대 페이지 크기는 1,000입니다.

pageToken

string

선택사항입니다. 이전 batches.list 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이 토큰을 입력합니다.

filter

string

선택사항입니다. 응답에 반환할 일괄 처리의 필터입니다.

필터는 각 일괄 처리 리소스의 다양한 필드 값을 제한하는 논리 표현식입니다. 필터는 대소문자를 구분하며 논리 연산자 (AND/OR)와 결합된 여러 절을 포함할 수 있습니다. 지원되는 필드는 batchId, batchUuid, state, createTime, labels입니다.

예를 들어 2023년 1월 1일 전에 생성된 RUNNING 상태의 일괄 처리에 관한 state = RUNNING and createTime < "2023-01-01T00:00:00Z" 필터입니다. state = RUNNING and labels.environment=production: 프로덕션 환경 라벨이 있는 RUNNING 상태의 일괄 처리를 필터링합니다.

필터 문법에 관한 자세한 설명과 지원되는 비교 목록은 https://google.aip.dev/assets/misc/ebnf-filtering.txt를 참고하세요.

orderBy

string

선택사항입니다. 일괄 처리 목록을 정렬할 필드입니다.

현재 지원되는 정렬 순서는 지정되지 않음 (비어 있음)과 가장 최근에 생성된 일괄 처리를 먼저 정렬하는 createTime desc뿐입니다.

자세한 내용은 https://google.aip.dev/132#ordering을 참조하세요.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

일괄 워크로드 목록입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현
{
  "batches": [
    {
      object (Batch)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
필드
batches[]

object (Batch)

출력 전용입니다. 지정된 컬렉션의 일괄 처리입니다.

nextPageToken

string

다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

unreachable[]

string

출력 전용입니다. 응답에 포함할 수 없는 일괄 처리 목록입니다. 이러한 리소스 중 하나를 가져오려고 하면 목록 응답에 포함되지 않은 이유를 알 수 있습니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 인증 개요를 참조하세요.