Method: projects.locations.list

Lista informações sobre os locais compatíveis com este serviço.

Solicitação HTTP

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

O URL usa a sintaxe de transcodificação gRPC.

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 de filtragem 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 ela não for definida, 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.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A mensagem de resposta para Locations.ListLocations.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Campos
locations[]

object (Location)

Uma lista de locais correspondente ao filtro especificado na solicitação.
nextPageToken

string

O token de próxima página da lista padrão.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.