Method: projects.locations.list

이 서비스에 지원되는 위치 정보를 나열합니다.

이 메서드는 [ListLocationsRequest.name] 필드에 제공된 리소스 범위를 기반으로 위치를 나열합니다.

  • 전역 위치: name이 비어 있으면 메서드는 모든 프로젝트에서 사용할 수 있는 공개 위치를 나열합니다.
  • 프로젝트별 위치: name이 projects/{project} 형식을 따르는 경우 메서드는 특정 프로젝트에 표시되는 위치를 나열합니다. 여기에는 프로젝트에 사용 설정된 공개, 비공개 또는 기타 프로젝트별 위치가 포함됩니다.

gRPC 및 클라이언트 라이브러리 구현의 경우 리소스 이름이 name 필드로 전달됩니다. 직접 서비스 호출의 경우 리소스 이름은 특정 서비스 구현 및 버전을 기반으로 요청 경로에 통합됩니다.

HTTP 요청

GET https://vectorsearch.googleapis.com/v1beta/{name}/locations

경로 매개변수

매개변수
name

string

해당하는 경우 위치 컬렉션을 소유한 리소스입니다.

쿼리 매개변수

파라미터
filter

string

결과 범위를 선호하는 하위 집합으로 제한하는 필터입니다. 필터링 언어는 "displayName=tokyo"와 같은 문자열을 수락하며 AIP-160에 더 자세히 설명되어 있습니다.
pageSize

integer

반환할 최대 결과 수입니다. 설정되지 않은 경우 서비스에 기본값이 선택됩니다.
pageToken

string

응답의 nextPageToken 필드에서 수신된 페이지 토큰입니다. 후속 페이지를 수신하도록 이 페이지 토큰을 전송합니다.
extraLocationTypes[]

string

선택사항. 이 필드를 사용하지 마세요. 명시적으로 달리 문서화되지 않는 한 지원되지 않으며 무시됩니다. 주로 내부용입니다.

요청 본문

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

응답 본문

성공한 경우 응답 본문에 ListLocationsResponse의 인스턴스가 포함됩니다.

승인 범위

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

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

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

name 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • vectorsearch.locations.list

자세한 내용은 IAM 문서를 참조하세요.