Method: projects.sites.customDomains.list

Liệt kê từng CustomDomain được liên kết với trang web Lưu trữ mẹ đã chỉ định.

Trả về các CustomDomain theo một thứ tự nhất quán, nhưng không xác định, để hỗ trợ việc phân trang.

yêu cầu HTTP

GET https://firebasehosting.googleapis.com/v1beta1/{parent=projects/*/sites/*}/customDomains

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

Tham số đường dẫn

Thông số
parent

string

Bắt buộc. Site Lưu trữ Firebase với CustomDomain mục mà bạn muốn liệt kê.

Tham số truy vấn

Thông số
pageSize

integer

Số lượng thực thể CustomDomain tối đa cần trả về trong một yêu cầu. Giá trị mặc định là 10

pageToken

string

Mã thông báo từ lệnh gọi trước đó đến customDomains.list cho máy chủ biết vị trí cần tiếp tục liệt kê.

showDeleted

boolean

Nếu giá trị true (đúng), yêu cầu sẽ trả về các CustomDomain được xoá tạm thời mà chưa được xoá hoàn toàn. Để khôi phục các CustomDomain đã xoá, hãy gửi yêu cầu customDomains.undelete.

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

Phản hồi của customDomains.list.

Nếu thành công, 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
{
  "customDomains": [
    {
      object (CustomDomain)
    }
  ],
  "nextPageToken": string
}
Trường
customDomains[]

object (CustomDomain)

Danh sách các thực thể CustomDomain được liên kết với Firebase Site đã chỉ định.

nextPageToken

string

Mã thông báo phân trang, nếu có thêm kết quả ngoài kết quả trong phản hồi này.

Hãy đưa mã thông báo này vào lệnh gọi tiếp theo của bạn đến customDomains.list. Mã thông báo trang chỉ tồn tại trong thời gian ngắn và không nên được lưu trữ.

Phạm vi uỷ quyền

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

  • https://www.googleapis.com/auth/firebase.hosting.readonly
  • https://www.googleapis.com/auth/firebase.hosting
  • https://www.googleapis.com/auth/firebase.readonly
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • 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ề việc xác thực.