Method: projects.locations.list

Liệt kê thông tin về các vị trí hỗ trợ dịch vụ này.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
name

string

Tài nguyên sở hữu tập hợp vị trí, nếu có.

Tham số truy vấn

Tham số
filter

string

Bộ lọc để thu hẹp kết quả và chỉ thu hẹp kết quả bạn mong muốn. Ngôn ngữ lọc chấp nhận các chuỗi như "displayName=tokyo" và được ghi lại chi tiết hơn trong AIP-160.

pageSize

integer

Số lượng kết quả tối đa cần trả về. Nếu bạn không đặt chính sách này, dịch vụ sẽ chọn một chế độ mặc định.

pageToken

string

Mã thông báo trang nhận được từ trường nextPageToken trong phản hồi. Gửi mã thông báo trang đó để nhận trang tiếp theo.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Tin nhắn phản hồi cho Locations.ListLocations.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Trường
locations[]

object (Location)

Danh sách vị trí khớp với bộ lọc đã chỉ định trong yêu cầu.

nextPageToken

string

Mã thông báo tiêu chuẩn trên trang tiếp theo của Danh sách.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.