Method: folders.locations.list

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

Esse método lista locais com base no escopo de recursos fornecido no campo ListLocationsRequest.name:

  • Locais globais: se name estiver vazio, o método listará os locais públicos disponíveis para todos os projetos.
  • Locais específicos do projeto: se name seguir o formato projects/{project}, o método listará os locais visíveis para esse projeto específico. Isso inclui locais públicos, particulares ou outros locais específicos do projeto ativados para o projeto.

Para implementações de biblioteca de cliente e gRPC, o nome do recurso é transmitido como o campo name. Para chamadas diretas de serviço, o nome do recurso é incorporado ao caminho da solicitação com base na implementação e versão do serviço específico.

Solicitação HTTP

GET https://observability.googleapis.com/v1/{name=folders/*}/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 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:

  • observability.locations.list

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