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 เวอร์ชันนี้กำลังถูกโคลนจากเวอร์ชันอื่น เนื้อหาทั้งหมดยังคงถูกคัดลอกไป

การแสดงการกำหนดค่า

การกำหนดค่าสำหรับวิธีกำหนดเส้นทางและประมวลผลคำขอขาเข้าไปยังไซต์ก่อนแสดงเนื้อหา เส้นทางคำขอ URL จะจับคู่กับรูปแบบ URL ที่ระบุในการกำหนดค่า จากนั้นโฮสติ้งจะใช้การกำหนดค่าที่เกี่ยวข้องตาม ลำดับลำดับความสำคัญ เฉพาะ

การเป็นตัวแทน JSON
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
เขตข้อมูล
headers[]

object ( Header )

อาร์เรย์ของออบเจ็กต์ โดยที่แต่ละออบเจ็กต์ระบุรูปแบบ URL ซึ่งหากจับคู่กับเส้นทาง URL คำขอ จะทริกเกอร์โฮสติ้งให้ใช้ส่วนหัวการตอบกลับแบบกำหนดเองที่ระบุ

redirects[]

object ( Redirect )

อาร์เรย์ของออบเจ็กต์ (เรียกว่ากฎการเปลี่ยนเส้นทาง) โดยแต่ละกฎระบุรูปแบบ URL ซึ่งหากจับคู่กับเส้นทาง URL คำขอ จะทริกเกอร์โฮสติ้งให้ตอบสนองด้วยการเปลี่ยนเส้นทางไปยังเส้นทางปลายทางที่ระบุ

rewrites[]

object ( Rewrite )

อาร์เรย์ของออบเจ็กต์ (เรียกว่ากฎการเขียนซ้ำ) โดยแต่ละกฎระบุรูปแบบ URL ซึ่งหากจับคู่กับเส้นทาง URL คำขอ จะทริกเกอร์โฮสติ้งให้ตอบสนองราวกับว่าบริการได้รับ URL ปลายทางที่ระบุ

cleanUrls

boolean

กำหนดว่าจะทิ้งนามสกุลไฟล์จากไฟล์ที่อัพโหลดหรือไม่

trailingSlashBehavior

enum ( TrailingSlashBehavior )

กำหนดวิธีจัดการกับเครื่องหมายสแลชต่อท้ายในเส้นทาง URL

i18n

object ( I18nConfig )

ไม่จำเป็น. กำหนดลักษณะการเขียนซ้ำของ i18n

Header ระบุรูปแบบ URL ที่หากตรงกับเส้นทาง URL คำขอ จะทริกเกอร์โฮสติ้งให้ใช้ส่วนหัวการตอบกลับแบบกำหนดเองที่ระบุ

การเป็นตัวแทน 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 แบบสนามยูเนี่ยน
ที่จำเป็น. รูปแบบ URL สตริงที่จะจับคู่กับเส้นทาง URL คำขอเพื่อพิจารณาว่าจะใช้ส่วนหัวการตอบกลับที่กำหนดเองนี้หรือไม่ อาจเป็นได้ทั้งแบบ Bash-style glob หรือนิพจน์ทั่วไป RE2

pattern สามารถมีได้เพียงอย่างใดอย่างหนึ่งต่อไปนี้:
glob

string

glob ที่ผู้ใช้ระบุจะจับคู่กับเส้นทาง URL คำขอ

regex

string

นิพจน์ทั่วไป RE2 ที่ผู้ใช้ระบุเพื่อจับคู่กับเส้นทาง URL คำขอ

เปลี่ยนเส้นทาง

Redirect ระบุรูปแบบ URL ที่หากตรงกับเส้นทาง URL คำขอ จะทริกเกอร์โฮสติ้งให้ตอบสนองด้วยการเปลี่ยนเส้นทางไปยังเส้นทางปลายทางที่ระบุ

การเป็นตัวแทน 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 ของการตอบกลับ

ตำแหน่งสามารถมีค่ากลุ่มการจับจากรูปแบบโดยใช้ : นำหน้าเพื่อระบุกลุ่มและตัวเลือก * เพื่อบันทึกส่วนที่เหลือของ URL ตัวอย่างเช่น:

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

pattern แบบสนามยูเนี่ยน
ที่จำเป็น. รูปแบบ URL สตริงที่จะจับคู่กับเส้นทาง URL คำขอเพื่อพิจารณาว่าจะใช้การเปลี่ยนเส้นทางนี้หรือไม่ อาจเป็นได้ทั้งแบบ Bash-style glob หรือนิพจน์ทั่วไป RE2

pattern สามารถมีได้เพียงอย่างใดอย่างหนึ่งต่อไปนี้:
glob

string

glob ที่ผู้ใช้ระบุจะจับคู่กับเส้นทาง URL คำขอ

regex

string

นิพจน์ทั่วไป RE2 ที่ผู้ใช้ระบุเพื่อจับคู่กับเส้นทาง URL คำขอ

เขียนใหม่

Rewrite จะระบุรูปแบบ URL ที่หากตรงกับเส้นทาง URL คำขอ จะทริกเกอร์โฮสติ้งให้ตอบสนองเสมือนว่าบริการได้รับ URL ปลายทางที่ระบุ

การเป็นตัวแทน 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 สตริงที่จะจับคู่กับเส้นทาง URL คำขอเพื่อพิจารณาว่าจะใช้การเขียนซ้ำนี้หรือไม่ อาจเป็นได้ทั้งแบบ Bash-style glob หรือนิพจน์ทั่วไป RE2

pattern สามารถมีได้เพียงอย่างใดอย่างหนึ่งต่อไปนี้:
glob

string

glob ที่ผู้ใช้ระบุจะจับคู่กับเส้นทาง URL คำขอ

regex

string

นิพจน์ทั่วไป RE2 ที่ผู้ใช้ระบุเพื่อจับคู่กับเส้นทาง URL คำขอ

behavior สนามยูเนี่ยน
ที่จำเป็น. พฤติกรรมของการเขียนซ้ำ

behavior สามารถเป็นได้เพียงอย่างใดอย่างหนึ่งต่อไปนี้:
path

string

เส้นทาง URL ที่จะเขียนคำขอใหม่

function

string

ฟังก์ชั่นการร้องขอพร็อกซี ต้องตรงกับชื่อฟังก์ชันที่ส่งออกทุกประการ

run

object ( CloudRunRewrite )

คำขอจะถูกส่งต่อไปยัง Cloud Run

CloudRunเขียนใหม่

การเขียนซ้ำที่กำหนดค่าไว้ซึ่งส่งคำขอไปยังบริการ Cloud Run หากไม่มีบริการ Cloud Run เมื่อตั้งค่าหรืออัปเดตการกำหนดค่า Firebase Hosting แสดงว่าคำขอล้มเหลว ข้อผิดพลาดจากบริการ Cloud Run จะถูกส่งต่อไปยังผู้ใช้ปลายทาง (เช่น หากคุณลบบริการ คำขอใดๆ ที่ส่งไปยังบริการนั้นจะได้รับข้อผิดพลาด 404 )

การเป็นตัวแทน JSON
{
  "serviceId": string,
  "region": string,
  "tag": string
}
เขตข้อมูล
serviceId

string

ที่จำเป็น. ID ที่ผู้ใช้กำหนดของบริการ Cloud Run

region

string

ไม่จำเป็น. ภูมิภาคที่ผู้ใช้ระบุซึ่งโฮสต์บริการ Cloud Run

ค่าเริ่มต้นเป็น us-central1 หากไม่ได้ระบุ

tag

string

ไม่จำเป็น. แท็ก TrafficConfig ที่ผู้ใช้ระบุเพื่อส่งการรับส่งข้อมูลไป

เมื่อละเว้น การรับส่งข้อมูลจะถูกส่งไปยัง URI ทั่วทั้งบริการ

พฤติกรรม TrailingSlash

กำหนดว่าควรเพิ่มหรือลบเครื่องหมายทับต่อท้ายจากเส้นทาง URL คำขอ

เอนัม
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

ไม่มีการระบุลักษณะการทำงาน

ไฟล์จะแสดงในตำแหน่งที่แน่นอนเท่านั้น และเครื่องหมายทับต่อท้ายจะถูกเพิ่มลงในดัชนีไดเร็กทอรีเท่านั้น

ADD เครื่องหมายสแลชต่อท้ายจะ ถูกเพิ่มลง ในดัชนีไดเรกทอรีตลอดจนเส้นทาง URL ใด ๆ ที่ไม่ลงท้ายด้วยนามสกุลไฟล์
REMOVE เครื่องหมายทับต่อท้ายจะ ถูกลบออก จากดัชนีไดเรกทอรี รวมถึงจากเส้นทาง URL ใดๆ ที่ไม่ได้ลงท้ายด้วยนามสกุลไฟล์

I18nConfig

หากระบุไว้ การเขียนซ้ำ i18n จะถูกเปิดใช้งาน

การเป็นตัวแทน JSON
{
  "root": string
}
เขตข้อมูล
root

string

ที่จำเป็น. เส้นทางที่ผู้ใช้ระบุซึ่งจะค้นหาเนื้อหาเฉพาะประเทศและภาษาภายในไดเรกทอรีสาธารณะ

วิธีการ

clone

 สร้างเวอร์ชันใหม่บนไซต์เป้าหมายที่ระบุโดยใช้เนื้อหาของเวอร์ชันที่ระบุ

create

 สร้างเวอร์ชันใหม่สำหรับไซต์ที่ระบุ

delete

 ลบเวอร์ชันที่ระบุ

get

 รับเวอร์ชันที่ระบุที่สร้างขึ้นสำหรับไซต์ที่ระบุ

list

 แสดงรายการเวอร์ชันที่สร้างขึ้นสำหรับไซต์ที่ระบุ

patch

 อัพเดตข้อมูลเมตาที่ระบุสำหรับเวอร์ชันที่ระบุ

populateFiles

 เพิ่มไฟล์เนื้อหาลงในเวอร์ชันที่ระบุ