Method: projects.locations.list

列出有关此服务所支持位置的信息。

此方法会根据 [ListLocationsRequest.name] 字段中提供的资源范围列出位置：

  • 全球位置：如果 name 为空，该方法会列出所有项目可用的公共位置。
  • 特定于项目的位置：如果 name 采用 projects/{project} 格式，该方法会列出对相应特定项目可见的位置。这包括为项目启用的公共位置、私密位置或其他项目专属位置。

对于 gRPC 和客户端库实现，资源名称作为 name 字段传递。对于直接服务调用，资源名称会根据具体的服务实现和版本纳入请求路径中。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
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 权限：

  • observability.locations.list

如需了解详情，请参阅 IAM 文档。