Method: projects.locations.list

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

包含位置信息集合的资源（如果适用）。

查询参数

参数
filter

string

用于将结果范围缩小到首选子集的过滤条件。过滤语言接受 "displayName=tokyo" 等字符串，如需了解详情，请参阅 AIP-160。
pageSize

integer

返回的结果数上限。如果未设置，该服务会选择默认值。
pageToken

string

从响应的 nextPageToken 字段收到的页面令牌。发送该页面令牌以接收后续页面。

请求正文

请求正文必须为空。

响应正文

Locations.ListLocations 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
字段
locations[]

object (Location)

与请求中指定的过滤条件匹配的位置列表。
nextPageToken

string

标准列表下一页令牌。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅身份验证概览。