메서드: cursor.projects.locations.subscriptions.cursors.list

구독의 모든 커밋된 커서 정보를 반환합니다.

HTTP 요청

GET https://{endpoint}/v1/cursor/{parent=projects/*/locations/*/subscriptions/*}/cursors

여기서 {endpoint}지원되는 서비스 엔드포인트 중 하나입니다.

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

경로 매개변수

매개변수
parent

string

필수. 커서를 검색할 구독입니다. 구조는 다음과 같습니다. projects/{project_number}/locations/{location}/subscriptions/{subscriptionId}

쿼리 매개변수

매개변수
pageSize

integer

반환할 최대 커서 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 설정하지 않거나 0으로 설정하면 상위의 모든 커서가 반환됩니다.

pageToken

string

이전 cursors.list 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 매길 때 cursors.list에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

요청 본문

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

응답 본문

성공하면 응답 본문에 다음과 같은 구조의 데이터가 포함됩니다.

cursors.list에 대한 응답입니다.

JSON 표현

{
  "partitionCursors": [
    {
      object (PartitionCursor)
    }
  ],
  "nextPageToken": string
}
필드
partitionCursors[]

object (PartitionCursor)

이 요청의 파티션 커서입니다.

nextPageToken

string

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

승인 범위

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

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

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

PartitionCursor

커서와 해당 커서 파티션의 쌍입니다.

JSON 표현

{
  "partition": string,
  "cursor": {
    object (Cursor)
  }
}
필드
partition

string (int64 format)

이 필드의 파티션입니다.

cursor

object (Cursor)

커서 값입니다.

커서

주제 파티션 내 메시지의 위치를 설명하는 커서입니다.

JSON 표현

{
  "offset": string
}
필드
offset

string (int64 format)

주제 파티션 내의 메시지 오프셋입니다. 0보다 크거나 같아야 합니다.