Method: projects.sites.customDomains.list

هر CustomDomain مرتبط با سایت میزبانی والدین مشخص شده را فهرست می کند.

برای تسهیل صفحه بندی، CustomDomain ها را به ترتیبی ثابت، اما تعریف نشده برمی گرداند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
parent

string

ضروری. Site میزبانی Firebase با موجودیت های CustomDomain که می خواهید فهرست کنید.

پارامترهای پرس و جو

مولفه های
pageSize

integer

حداکثر تعداد نهادهای CustomDomain برای بازگرداندن در یک درخواست. پیش فرض 10 است.

pageToken

string

رمزی از تماس قبلی با customDomains.list که به سرور می‌گوید کجا لیست را از سر بگیرد.

showDeleted

boolean

در صورت صحت، درخواست، CustomDomain های پاک شده نرم را که هنوز به طور کامل حذف نشده اند، برمی گرداند. برای بازیابی CustomDomain های حذف شده، یک درخواست customDomains.undelete انجام دهید.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پاسخ از customDomains.list .

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "customDomains": [
    {
      object (CustomDomain)
    }
  ],
  "nextPageToken": string
}
زمینه های
customDomains[]

object ( CustomDomain )

فهرستی از نهادهای CustomDomain مرتبط با Site Firebase مشخص شده.

nextPageToken

string

نشانه صفحه‌بندی، اگر نتایج بیشتری فراتر از نتایج موجود در این پاسخ باشد.

این نشانه را در تماس بعدی خود با customDomains.list قرار دهید. توکن های صفحه کوتاه مدت هستند و نباید ذخیره شوند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • 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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.