REST Resource: sites.versions

משאב: גרסה

Version היא תצורה ואוסף של קבצים סטטיים שקובעים כיצד אתר מוצג.

ייצוג JSON
{
  "name": string,
  "status": enum (VersionStatus),
  "config": {
    object (ServingConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "createUser": {
    object (ActingUser)
  },
  "finalizeTime": string,
  "finalizeUser": {
    object (ActingUser)
  },
  "deleteTime": string,
  "deleteUser": {
    object (ActingUser)
  },
  "fileCount": string,
  "versionBytes": string
}
שדות
name

string

שם המשאב המלא עבור הגרסה, בפורמט:

sites/ SITE_ID /versions/ VERSION_ID

שם זה מסופק בגוף התגובה כאשר אתה קורא ל- versions.create .

status

enum ( VersionStatus )

סטטוס הפריסה של הגרסה.

לפריסה מוצלחת, התקשר ל- versions.create כדי ליצור גרסה חדשה (מצב CREATED ), העלה את כל הקבצים הרצויים לגרסה, ולאחר מכן עדכן את הגרסה למצב FINALIZED .

שימו לב שאם תשאירו את הגרסה במצב CREATED למשך יותר מ-12 שעות, המערכת תסמן אוטומטית את הגרסה כ- ABANDONED .

אתה יכול גם לשנות את הסטטוס של גרסה ל- DELETED על ידי קריאה versions.delete .

config

object ( ServingConfig )

התצורה להתנהגות האתר. תצורה זו קיימת בקובץ firebase.json .

labels

map (key: string, value: string)

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

אובייקט המכיל רשימה של "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" .

createUser

object ( ActingUser )

פלט בלבד. מזהה את המשתמש שיצר את הגרסה.

finalizeTime

string ( Timestamp format)

פלט בלבד. הזמן שבו הגרסה FINALIZED .

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

finalizeUser

object ( ActingUser )

פלט בלבד. מזהה את המשתמש FINALIZED את הגרסה.

deleteTime

string ( Timestamp format)

פלט בלבד. השעה שבה הגרסה DELETED .

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

deleteUser

object ( ActingUser )

פלט בלבד. מזהה את המשתמש DELETED את הגרסה.

fileCount

string ( int64 format)

פלט בלבד. המספר הכולל של קבצים המשויכים לגרסה.

ערך זה מחושב לאחר FINALIZED גרסה.

versionBytes

string ( int64 format)

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

ערך זה מחושב לאחר FINALIZED גרסה.

סטטוס גרסה

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

תקצירים
VERSION_STATUS_UNSPECIFIED מצב ברירת המחדל; אין להשתמש בכוונה.
CREATED הגרסה נוצרה, וכרגע מתווסף תוכן לגרסה.
FINALIZED כל התוכן התווסף לגרסה, ולא ניתן עוד לשנות את הגרסה.
DELETED הגרסה נמחקה.
ABANDONED הגרסה לא עודכנה ל- FINALIZED תוך 12 שעות ונמחקה אוטומטית.
EXPIRED הגרסה נמצאת מחוץ למגבלה המוגדרת באתר עבור מספר הגרסאות שנשמרו, כך שתוכן הגרסה מתוזמן למחיקה.
CLONING הגרסה עוברת שיבוט מגרסה אחרת. כל התוכן עדיין מועתק.

ServingConfig

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

ייצוג JSON
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
שדות
headers[]

object ( Header )

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

redirects[]

object ( Redirect )

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

rewrites[]

object ( Rewrite )

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

cleanUrls

boolean

מגדיר אם להסיר את סיומת הקובץ מהקבצים שהועלו.

trailingSlashBehavior

enum ( TrailingSlashBehavior )

מגדיר כיצד לטפל באלכסון נגרר בנתיב כתובת האתר.

i18n

object ( I18nConfig )

אופציונאלי. מגדיר את התנהגות השכתוב של i18n.

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

ייצוג JSON
{
  "headers": {
    string: string,
    ...
  },

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
שדות
headers

map (key: string, value: string)

נדרש. הכותרות הנוספות להוסיף לתגובה.

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

pattern שדה איחוד .
נדרש. תבנית כתובת אתר של מחרוזת שתתאים לנתיב כתובת האתר של הבקשה כדי לקבוע אם להחיל את כותרת התגובה המותאמת אישית הזו. יכול להיות גלוב בסגנון Bash או ביטוי רגיל של RE2.

pattern יכול להיות רק אחד מהאפשרויות הבאות:
glob

string

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

regex

string

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

הפניה מחדש

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

ייצוג JSON
{
  "statusCode": integer,
  "location": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
שדות
statusCode

integer

נדרש. הסטטוס קוד HTTP להחזיר בתגובה. זה חייב להיות קוד סטטוס 3xx חוקי.

location

string

נדרש. הערך שיש לשים בכותרת מיקום HTTP של התגובה.

המיקום יכול להכיל ערכי קבוצת לכידה מהתבנית באמצעות קידומת : לזיהוי הפלח ו- * אופציונלי כדי ללכוד את שאר כתובת האתר. לדוגמה:

"glob": "/:capture*",
"statusCode": 301,
"location": "https://example.com/foo/:capture"

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

pattern יכול להיות רק אחד מהאפשרויות הבאות:
glob

string

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

regex

string

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

לִכתוֹב מִחָדָשׁ

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

ייצוג JSON
{
  "functionRegion": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.

  // Union field behavior can be only one of the following:
  "path": string,
  "function": string,
  "run": {
    object (CloudRunRewrite)
  }
  // End of list of possible types for union field behavior.
}
שדות
functionRegion

string

אופציונאלי. ציין אזור ענן עבור קריאות פונקציות שנכתבו מחדש. אם לא מסופק, ברירת המחדל היא us-central1.

pattern שדה איחוד .
נדרש. תבנית כתובת URL של מחרוזת שתתאים לנתיב כתובת האתר של הבקשה כדי לקבוע אם להחיל שכתוב זה. יכול להיות גלוב בסגנון Bash או ביטוי רגיל של RE2.

pattern יכול להיות רק אחד מהאפשרויות הבאות:
glob

string

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

regex

string

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

behavior שדה האיגוד.
נדרש. התנהגות השכתוב.

behavior יכולה להיות רק אחת מהאפשרויות הבאות:
path

string

נתיב כתובת האתר שאליו יש לכתוב מחדש את הבקשה.

function

string

הפונקציה ל-proxy בקשות אל. חייב להתאים בדיוק לשם הפונקציה המיוצאת.

run

object ( CloudRunRewrite )

הבקשה תועבר ל-Cloud Run.

CloudRunRewrite

שכתוב מוגדר המפנה בקשות לשירות Cloud Run. אם שירות Cloud Run לא קיים בעת הגדרה או עדכון של תצורת Firebase Hosting שלך, הבקשה נכשלת. שגיאות כלשהן משירות Cloud Run מועברות למשתמש הקצה (לדוגמה, אם אתה מוחק שירות, כל בקשות המופנות לאותו שירות יקבלו שגיאת 404 ).

ייצוג JSON
{
  "serviceId": string,
  "region": string,
  "tag": string
}
שדות
serviceId

string

נדרש. מזהה מוגדר על ידי משתמש של שירות Cloud Run.

region

string

אופציונאלי. אזור מסופק על ידי המשתמש שבו מתארח שירות Cloud Run.

ברירת מחדל ל- us-central1 אם לא מסופק.

tag

string

אופציונאלי. תג TrafficConfig שסופק על ידי המשתמש לשלוח אליו תנועה.

כאשר מושמט, תעבורה נשלחת ל-URI בכל השירות

TrailingSlashBehavior

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

תקצירים
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

לא צוינה התנהגות.

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

ADD לוכסנים נגררים מתווספים לאינדקס של ספריות כמו גם לכל נתיב כתובת URL שאינו מסתיים בסיומת קובץ.
REMOVE נלוות נגררות מוסרות מאינדקסי הספריות וכן מכל נתיב כתובת אתר שאינו מסתיים בסיומת קובץ.

I18nConfig

אם מסופק, שכתובים של i18n מופעלים.

ייצוג JSON
{
  "root": string
}
שדות
root

string

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

שיטות

clone

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

create

 יוצר גרסה חדשה עבור האתר שצוין.

delete

 מוחק את הגרסה שצוינה.

get

 קבל את הגרסה המצוינת שנוצרה עבור האתר שצוין.

list

 מפרט את הגרסאות שנוצרו עבור האתר שצוין.

patch

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

populateFiles

 מוסיף קבצי תוכן לגרסה שצוינה.