REST Resource: projects.sites.customDomains

משאב: CustomDomain

CustomDomain הוא ישות המקשרת שם דומיין לאתר אירוח של Firebase. הוסף CustomDomain לאתר שלך כדי לאפשר לאירוח לשרת את תוכן האתר בתגובה לבקשות נגד שם הדומיין שלך.

ייצוג JSON
{
  "name": string,
  "annotations": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "expireTime": string,
  "etag": string,
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "requiredDnsUpdates": {
    object (DnsUpdates)
  },
  "issues": [
    {
      object (Status)
    }
  ],
  "certPreference": enum (Type),
  "cert": {
    object (Certificate)
  },
  "redirectTarget": string,
  "reconciling": boolean,
  "labels": {
    string: string,
    ...
  }
}
שדות
name

string

פלט בלבד. השם המלא של ה- CustomDomain .

annotations

map (key: string, value: string)

הערות שאתה יכול להוסיף כדי להשאיר מטא נתונים קריא-אנושיים ומחשבים לגבי CustomDomain שלך.

אובייקט המכיל רשימה של "key": value . דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

פלט בלבד. זמן היצירה של הדומיין המותאם אישית.

חותמת זמן בפורמט RFC3339 UTC "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: "2014-10-02T15:01:23Z" ו- "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

פלט בלבד. הפעם האחרונה שה- CustomDomain עודכן.

חותמת זמן בפורמט RFC3339 UTC "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: "2014-10-02T15:01:23Z" ו- "2014-10-02T15:01:23.045123456Z" .

deleteTime

string ( Timestamp format)

פלט בלבד. הזמן שבו ה- CustomDomain נמחק; null עבור דומיינים מותאמים אישית שלא נמחקו. דומיינים מותאמים אישית שנמחקו נמשכים כ-30 יום, ולאחר מכן, Hosting מסיר אותם לחלוטין. כדי לשחזר דומיין מותאם אישית שנמחק, בקש מ- customDomains.undelete .

חותמת זמן בפורמט RFC3339 UTC "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: "2014-10-02T15:01:23Z" ו- "2014-10-02T15:01:23.045123456Z" .

expireTime

string ( Timestamp format)

פלט בלבד. הזמן המינימלי לפני שה- CustomDomain נמחק באופן רך יוסר לחלוטין מ-Hosting; null עבור דומיינים מותאמים אישית שלא נמחקו.

חותמת זמן בפורמט RFC3339 UTC "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: "2014-10-02T15:01:23Z" ו- "2014-10-02T15:01:23.045123456Z" .

etag

string

פלט בלבד. מחרוזת המייצגת את המצב הנוכחי של ה- CustomDomain ומאפשרת לך לאשר את המצב ההתחלתי שלו בבקשות שישנו אותו. השתמש בתג כדי להבטיח עקביות בעת ביצוע בקשות customDomains.patch , customDomains.delete ו- customDomains.undelete .

hostState

enum ( HostState )

פלט בלבד. HostState של שם הדומיין שאליו מתייחס CustomDomain .

ownershipState

enum ( OwnershipState )

פלט בלבד. ה- OwnershipState של שם הדומיין שאליו מתייחס CustomDomain .

requiredDnsUpdates

object ( DnsUpdates )

פלט בלבד. קבוצה של עדכונים שעליך לבצע ברשומות ה-DNS של שם הדומיין כדי לאפשר ל-Hosting להגיש תוכן מאובטח מטעמו.

issues[]

object ( Status )

פלט בלבד. קבוצה של שגיאות שבהן נתקלו מערכות אירוח בעת ניסיון לבסס את היכולת של Hosting להגיש תוכן מאובטח עבור שם הדומיין שלך. פתור את הבעיות האלה כדי להבטיח שה- CustomDomain שלך יתנהג כראוי.

certPreference

enum ( Type )

שדה המאפשר לך לציין איזה סוג אישור SSL אירוח יוצר עבור שם הדומיין שלך. לדומיינים מותאמים אישית של תוכנית Spark יש גישה רק לסוג האישור GROUPED , בעוד שדומיינים של תוכנית Blaze יכולים לבחור כל אפשרות.

cert

object ( Certificate )

פלט בלבד. אישור ה-SSL של Hosting יש עבור שם התחום של הדומיין המותאם אישית הזה. עבור דומיינים מותאמים אישית חדשים, זה מייצג לעתים קרובות את כוונתו של Hosting ליצור אישור, ולא אישור בפועל. בדוק את שדה state למידע נוסף.

redirectTarget

string

שם דומיין שאליו CustomDomain הזה צריך להפנות תנועה. אם צוין, Hosting יגיב לבקשות נגד דומיין מותאם אישית זה עם קוד HTTP 301, ותנתב תעבורה ל- redirectTarget שצוין במקום זאת.

reconciling

boolean

פלט בלבד. שדה שאם הוא נכון, מציין שהמערכות של Hosting מנסות לגרום למצב של הדומיין המותאם להתאים למצב המועדף עליך. הדבר true לרוב בעת הקצאה ראשונית של CustomDomain לאחר בקשת customDomains.create או בעת יצירת אישור SSL חדש שיתאים certPreference מעודכן לאחר בקשת customDomains.patch .

labels

map (key: string, value: string)

תוויות המשמשות למטא נתונים ו/או סינון נוספים.

אובייקט המכיל רשימה של "key": value . דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

מצב מארח

המדינה המארח של שם הדומיין שלך. מצב המארח נקבע על ידי בדיקת כל כתובת IP המשויכת לשם הדומיין שלך כדי לראות אם הוא מגיש תוכן אירוח.

תקצירים
HOST_STATE_UNSPECIFIED מצב המארח של הדומיין המותאם אישית שלך לא צוין. ההודעה לא חוקית אם זה לא מצוין.
HOST_UNHOSTED שם הדומיין המותאם אישית שלך אינו משויך לכתובת IP כלשהי.
HOST_UNREACHABLE לא ניתן להגיע לשם הדומיין המותאם אישית שלך. שאילתות DNS של שירותי אירוח כדי למצוא את כתובות ה-IP של שם הדומיין שלך הובילו לשגיאות. עיין בשדה issues של אובייקט CustomDomain שלך לפרטים נוספים.
HOST_MISMATCH לשם התחום של הדומיין המותאם אישית שלך יש כתובות IP שבסופו של דבר אינן נפתרות לאירוח.
HOST_CONFLICT לשם הדומיין המותאם אישית שלך יש כתובות IP שמתאימות גם לאירוח וגם לשירותים אחרים. כדי להבטיח תוצאות עקביות, הסר רשומות A ו- AAAA הקשורות לשירותים שאינם אירוח.
HOST_ACTIVE כל הבקשות נגד שם הדומיין המותאם אישית שלך מוגשות על ידי Hosting. אם ה- OwnershipState של הדומיין המותאם אישית הוא גם ACTIVE , Hosting משרת את התוכן של אתר האירוח שלך בשם הדומיין.

OwnershipState

מצב הבעלות על הדומיין שלך. דומיין יכול להיות בבעלות של אתר אירוח Firebase אחד לכל היותר. ניתן לקבוע בעלות בשתי דרכים:

* TXT records: A TXT record on the domain in the form
`hosting-site=[siteId]`.
* CNAME records: A CNAME record that points to a Hosting site's default
domain.

אם CustomDomain שלך נמצא ב- OwnershipState שאינו OWNERSHIP_ACTIVE במשך יותר מ-30 יום והוא לא עודכן במשך 30 יום לפחות, מערכות הבעלות של Hosting מוחקות את ה- CustomDomain . כדי לשחזר CustomDomain שנמחק, בצע בקשת customDomains.undelete .

תקצירים
OWNERSHIP_STATE_UNSPECIFIED מצב הבעלות של הדומיין המותאם אישית שלך לא צוין. זה לא אמור לקרות לעולם.
OWNERSHIP_MISSING לשם הדומיין המותאם אישית שלך אין רשומות בעלות הקשורות לאירוח; לאף פרויקט Firebase אין הרשאה לפעול בשמו של שם הדומיין.
OWNERSHIP_UNREACHABLE לא ניתן להגיע לשם הדומיין המותאם אישית שלך. שאילתות DNS של שירותי אירוח כדי למצוא את רשומות הבעלות של שם הדומיין שלך הובילו לשגיאות. עיין בשדה issues של אובייקט CustomDomain שלך לפרטים נוספים.
OWNERSHIP_MISMATCH שם הדומיין המותאם אישית שלך נמצא בבעלות פרויקט Firebase אחר. הסר את רשומות TXT המתנגשות והחלף אותן ברשומות ספציפיות לפרויקט עבור פרויקט Firebase הנוכחי שלך.
OWNERSHIP_CONFLICT לשם הדומיין המותאם אישית שלך יש רשומות TXT סותרות המצביעות על בעלות הן של פרויקט Firebase הנוכחי והן של פרויקט אחר. הסר את רשומות הבעלות של הפרויקט האחר כדי להעניק את הבעלות הנוכחית על הפרויקט.
OWNERSHIP_PENDING רשומות ה-DNS של הדומיין המותאם אישית שלך מוגדרות כהלכה. אירוח יעביר את הבעלות על הדומיין שלך לדומיין CustomDomain זה תוך 24 שעות.
OWNERSHIP_ACTIVE לשם הדומיין המותאם אישית שלך יש רשומות TXT המעניקות הרשאה לפרויקט שלו לפעול בשמו.

עדכוני Dns

קבוצה של עדכוני רשומות DNS שעליך לבצע כדי לאפשר לאירוח להגיש תוכן מאובטח בתגובה לבקשות נגד שם הדומיין שלך. עדכונים אלה מציגים את המצב הנוכחי של רשומות ה-DNS של שם הדומיין שלך כאשר אירוח חיפש אותם לאחרונה, ואת קבוצת הרשומות הרצויה שהאירוח צריך לראות לפני שהדומיין המותאם אישית שלך יוכל להיות פעיל במלואו.

ייצוג JSON
{
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}
שדות
discovered[]

object ( DnsRecordSet )

ערכת רשומות ה-DNS התגלתה אירוח בעת בדיקת דומיין.

desired[]

object ( DnsRecordSet )

ערכת רשומות ה-DNS שהאירוח צריך לשרת תוכן מאובטח בדומיין.

checkTime

string ( Timestamp format)

הפעם האחרונה שבה אירוח בדק את רשומות ה-DNS של הדומיין המותאם אישית שלך.

חותמת זמן בפורמט RFC3339 UTC "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: "2014-10-02T15:01:23Z" ו- "2014-10-02T15:01:23.045123456Z" .

DnsRecordSet

קבוצה של רשומות DNS רלוונטיות להגדרה ותחזוקה של דומיין מותאם אישית ב-Firebase Hosting.

ייצוג JSON
{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}
שדות
domainName

string

פלט בלבד. שם הדומיין שאליו הרשומה מתייחסת.

checkError

object ( Status )

פלט בלבד. שגיאה נתקלה בשירותי אירוח בעת שאילתה לרשומות ה-DNS של שם הדומיין שלך. הערה: אירוח מתעלם משגיאות NXDOMAIN , מכיוון שבדרך כלל אלה רק אומרות שעדיין לא הוגדר שם דומיין.

records[]

object ( DnsRecord )

פלט בלבד. רשומות בדומיין.

DnsRecord

רשומות DNS הן רשומות משאבים שמגדירות כיצד מערכות ושירותים צריכים להתנהג בעת טיפול בבקשות עבור שם תחום. לדוגמה, כאשר אתה מוסיף רשומות A לרשומות ה-DNS של שם הדומיין שלך, אתה מודיע למערכות אחרות (כגון דפדפני האינטרנט של המשתמשים שלך) ליצור קשר עם כתובות IPv4 אלה כדי לאחזר משאבים רלוונטיים לשם הדומיין שלך (כגון קבצי אתר האירוח שלך ).

ייצוג JSON
{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action)
}
שדות
domainName

string

פלט בלבד. שם הדומיין שהרשומה מתייחסת אליו, למשל foo.bar.com. .

type

enum ( Type )

פלט בלבד. סוג הרשומה, שקובע אילו נתונים מכילה הרשומה.

rdata

string

פלט בלבד. הנתונים של הרשומה. משמעות הערך תלויה בסוג הרשומה: - A ו-AAAA: כתובות IP עבור שם הדומיין. - CNAME: דומיין נוסף לבדיקת רשומות. - TXT: מחרוזות טקסט שרירותיות הקשורות לשם התחום. אירוח משתמש ברשומות TXT כדי לקבוע לאילו פרויקטים של Firebase יש הרשאה לפעול בשמו של שם הדומיין. - CAA: הדגלים, התג והערך של הרשומה, למשל 0 issue "pki.goog" .

requiredAction

enum ( Action )

פלט בלבד. רשימה המציינת את הפעולה הנדרשת עבור רשומה זו.

סוּג

סוג רשומת ה-DNS, כולל A , TXT , AAAA ו- CAA .

תקצירים
TYPE_UNSPECIFIED סוג הרשומה לא מצוין. ההודעה לא חוקית אם זה לא מצוין.
A רשומת A , כהגדרתה ב- RFC 1035 . רשומות קובעות לאילו כתובות IPv4 שם דומיין מפנה את התנועה.
CNAME רשומת CNAME , כפי שהוגדרה ב- RFC 1035 . רשומות CNAME או Canonical Name ממפות שם דומיין לשם דומיין קנוני אחר. אם קיימת רשומת CNAME , היא צריכה להיות הרשומה היחידה בשם הדומיין.
TXT רשומת TXT , כפי שהוגדרה ב- RFC 1035 . רשומות TXT מכילות נתוני טקסט שרירותיים על שם תחום. אירוח משתמש ברשומות TXT כדי לקבוע לאיזה פרויקט Firebase יש הרשאה לפעול על שם דומיין.
AAAA רשומת AAAA, כפי שהוגדרה ברשומות AAAA RFC 3596 קובעות לאילו כתובות IPv6 שם תחום מפנה תנועה.
CAA

רשומת CAA, כהגדרתה ב- RFC 6844 . רשומות CAA, או אישור רשות אישורים, קובעות אילו רשויות אישורים (ארגוני טבעת אישורי SSL) מורשים להטביע אישור עבור שם התחום. Firebase Hosting משתמש pki.goog כ-CA הראשי שלו.

מפל רישומי CAA. רשומת CAA ב- foo.com חלה גם על bar.foo.com , אלא אם כן bar.foo.com יש מערכת משלו של רשומות CAA.

רישומי CAA הם אופציונליים. אם לשם תחום ולהוריו אין רישומי CAA, כל ה-CA מורשים להטביע תעודות בשמו. באופן כללי, Hosting מבקש ממך לשנות את רשומות CAA רק כאשר הדבר נדרש כדי לבטל את החסימה של יצירת אישורי SSL.

פעולה

פעולה היא סוג של פעולה שעליך לבצע ברשומת DNS זו כדי להגדיר את הדומיין שלך לשימוש עם Firebase Hosting.

תקצירים
NONE אין צורך בפעולה.
ADD הוסף את הרשומה הזו לרשומות ה-DNS שלך.
REMOVE הסר את הרשומה הזו מרשומות ה-DNS שלך.

סוּג

סוג התעודה. קובע כיצד מערכות אחסון מטפלות ביצירה ותחזוקה של האישור.

תקצירים
TYPE_UNSPECIFIED סוג התעודה אינו מוגדר. ההודעה לא חוקית אם זה לא מצוין.
TEMPORARY סוג אישור קצר מועד המכסה שם דומיין באופן זמני, בעוד ש-Hosting יוצר אישור קבוע יותר.
GROUPED האישור הסטנדרטי עבור דומיינים מותאמים אישית של תוכנית Spark.
PROJECT_GROUPED תוכנית בלעז בלבד. תעודה המכסה בין 1 ל-100 שמות דומיינים עם דומיינים מותאמים אישית באותו פרויקט Firebase.
DEDICATED תוכנית בלעז בלבד. תעודה המכסה שם דומיין בודד.

תְעוּדָה

אישור SSL המשמש לספק הצפנה מקצה לקצה עבור בקשות כנגד שם הדומיין שלך. Certificate יכול להיות תעודת SSL אמיתית או, עבור דומיינים מותאמים אישית שנוצרו לאחרונה, כוונתו של Hosting ליצור אחד.

ייצוג JSON
{
  "type": enum (Type),
  "state": enum (CertState),
  "verification": {
    object (CertVerification)
  },
  "issues": [
    {
      object (Status)
    }
  ],
  "createTime": string,
  "expireTime": string
}
שדות
type

enum ( Type )

פלט בלבד. סוג התעודה.

state

enum ( CertState )

פלט בלבד. מצב התעודה. רק מדינות CERT_ACTIVE ו- CERT_EXPIRING_SOON מספקות כיסוי SSL עבור שם דומיין. אם המדינה היא PROPAGATING ולאירוח היה אישור פעיל עבור שם הדומיין בעבר, האישור שהיה פעיל בעבר מספק כיסוי SSL עבור שם התחום עד להפצת האישור הנוכחי.

verification

object ( CertVerification )

פלט בלבד. קבוצה של אתגרי ACME שאתה יכול להוסיף לרשומות ה-DNS שלך או לספק אירוח קיים שאינו אירוח כדי לאפשר לאירוח ליצור אישור SSL עבור שם הדומיין שלך לפני שתפנה תנועה לעבר אירוח. אתה יכול להשתמש באתגרים האלה כחלק ממעבר אפס זמן השבתה מהספק הישן שלך לאירוח.

issues[]

object ( Status )

פלט בלבד. קבוצה של שגיאות אירוח נתקל בעת ניסיון ליצור אישור עבור שם הדומיין שלך. פתרו את הבעיות הללו כדי להבטיח שהאירוח יוכל לספק תקשורת מאובטחת עם המבקרים באתר שלכם.

createTime

string ( Timestamp format)

פלט בלבד. זמן יצירת התעודה. עבור אישורים TEMPORARY זה הזמן שבו אירוח יצר אתגרים לראשונה עבור שם הדומיין שלך. עבור כל סוגי האישורים האחרים, זה הזמן שבו האישור נוצר בפועל.

חותמת זמן בפורמט RFC3339 UTC "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: "2014-10-02T15:01:23Z" ו- "2014-10-02T15:01:23.045123456Z" .

expireTime

string ( Timestamp format)

פלט בלבד. זמן תפוגה של התעודה. לאחר זמן זה, לא ניתן עוד להשתמש באישור כדי לספק תקשורת מאובטחת בין אירוח למבקרים באתר שלך.

חותמת זמן בפורמט RFC3339 UTC "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: "2014-10-02T15:01:23Z" ו- "2014-10-02T15:01:23.045123456Z" .

CertState

המצב של אישור ה-SSL של Hosting עבור שם הדומיין שלך. זה יכול לייצג את המצב של האישור בפועל או, עבור דומיינים מותאמים אישית חדשים, את הניסיון של Hosting ליצור אישור.

תקצירים
CERT_STATE_UNSPECIFIED מצב התעודה אינו מוגדר. ההודעה לא חוקית אם זה לא מצוין.
CERT_PREPARING המצב הראשוני של כל תעודה, מייצג את כוונתו של Hosting ליצור תעודה, לפני הגשת בקשות לרשות אישורים.
CERT_VALIDATING אירוח מאמת אם רשומות ה-DNS של שם דומיין נמצאות במצב המאפשר יצירת אישורים מטעמו.
CERT_PROPAGATING האישור נוצר לאחרונה, וצריך זמן להתפשט ב-CDN של Hosting.
CERT_ACTIVE התעודה פעילה ומספקת חיבורים מאובטחים לשמות הדומיין שהוא מייצג.
CERT_EXPIRING_SOON תוקף האישור עומד לפוג, כל שמות הדומיינים בו יקבלו תעודות חדשות.
CERT_EXPIRED פג תוקף האישור. אירוח לא יכול עוד להגיש תוכן מאובטח בשם הדומיין שלך.

אישור אישור

קבוצה של אתגרי ACME שבהם תוכל להשתמש כדי לאפשר לאירוח ליצור אישור SSL עבור שם הדומיין שלך לפני הפניית תנועה לשרתי אחסון. השתמש באתגר DNS או HTTP; אין צורך לספק את שניהם.

ייצוג JSON
{
  "dns": {
    object (DnsUpdates)
  },
  "http": {
    object (HttpUpdate)
  }
}
שדות
dns

object ( DnsUpdates )

פלט בלבד. רשומת TXT להוספה לרשומות ה-DNS שלך המאשרת את כוונתך לאפשר לאירוח ליצור אישור SSL עבור שם הדומיין שלך.

http

object ( HttpUpdate )

פלט בלבד. קובץ להוספה לשירות האירוח הקיים שלך שאינו אירוח, המאשר את כוונתך לאפשר לאירוח ליצור אישור SSL עבור שם הדומיין שלך.

HttpUpdate

קובץ שאתה יכול להוסיף לשירות האירוח הקיים שלך שאינו אירוח ומאשר את כוונתך לאפשר לרשויות האישורים של Hosting ליצור אישור SSL עבור הדומיין שלך.

ייצוג JSON
{
  "path": string,
  "desired": string,
  "discovered": string,
  "lastCheckTime": string,
  "checkError": {
    object (Status)
  }
}
שדות
path

string

פלט בלבד. הנתיב לקובץ.

desired

string

פלט בלבד. מחרוזת טקסט להגשה בנתיב.

discovered

string

פלט בלבד. האם אירוח הצליח למצוא את תוכן הקובץ הנדרש בנתיב שצוין במהלך הבדיקה האחרונה שלו.

lastCheckTime

string ( Timestamp format)

פלט בלבד. בפעם האחרונה שמערכות אירוח בדקו את תוכן הקובץ.

חותמת זמן בפורמט RFC3339 UTC "Zulu", עם רזולוציה של ננו-שניות ועד תשע ספרות חלקיות. דוגמאות: "2014-10-02T15:01:23Z" ו- "2014-10-02T15:01:23.045123456Z" .

checkError

object ( Status )

פלט בלבד. אירעה שגיאה במהלך בדיקת התוכן האחרונה. אם ריק, הבדיקה הושלמה בהצלחה.

שיטות

create

 יוצר תחום CustomDomain .

delete

 מוחק את ה- CustomDomain שצוין.

get

 מקבל את ה- CustomDomain שצוין.

list

 מפרט כל CustomDomain המשויך לאתר אירוח האב שצוין.

patch

 מעדכן את ה- CustomDomain שצוין.

undelete

 ביטול מחיקת ה- CustomDomain שצוין אם הוא נמחק באופן רך.