Method: projects.locations.list

Lista informações sobre os locais compatíveis com este serviço. Esse método pode ser chamado de duas maneiras:

  • Listar todos os locais públicos:use o caminho GET /v1/locations.
  • Listar locais visíveis para o projeto:use o caminho GET /v1/projects/{projectId}/locations. Isso pode incluir locais públicos, particulares ou outros visíveis especificamente para o projeto.

Solicitação HTTP

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

Parâmetros de caminho

Parâmetros
name

string

O recurso que tiver o conjunto de locais, se aplicável.

Parâmetros de consulta

Parâmetros
filter

string

Um filtro para restringir os resultados a um subconjunto preferido. A linguagem do filtro aceita strings como "displayName=tokyo" e está documentada com mais detalhes em AIP-160.
pageSize

integer

O número máximo de resultados a serem retornados. Se não for definido, o serviço selecionará um padrão.
pageToken

string

Um token de página recebido do campo nextPageToken na resposta. Envie esse token de página para receber a página seguinte.
extraLocationTypes[]

string

Opcional. Não use este campo. Ele não é compatível e é ignorado, a menos que esteja documentado de outra forma. Ele se destina principalmente para uso interno.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ListLocationsResponse.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • vectorsearch.locations.list

Para mais informações, consulte a documentação do IAM.