REST Resource: sites.versions

Sumber daya: Versi

Version adalah konfigurasi dan kumpulan file statis yang menentukan bagaimana suatu situs ditampilkan.

Representasi 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
}
Bidang
name

string

Nama sumber daya yang sepenuhnya memenuhi syarat untuk versi tersebut, dalam format:

sites/ SITE_ID /versions/ VERSION_ID

Nama ini diberikan di isi respons saat Anda memanggil versions.create .

status

enum ( VersionStatus )

Status penerapan versi.

Agar penerapan berhasil, panggil versions.create untuk membuat versi baru (status CREATED ), unggah semua file yang diinginkan ke versi tersebut, lalu perbarui versi ke status FINALIZED .

Perhatikan bahwa jika Anda membiarkan versi dalam status CREATED selama lebih dari 12 jam, sistem akan secara otomatis menandai versi tersebut sebagai ABANDONED .

Anda juga dapat mengubah status versi menjadi DELETED dengan memanggil versions.delete .

config

object ( ServingConfig )

Konfigurasi untuk perilaku situs. Konfigurasi ini ada di file firebase.json .

labels

map (key: string, value: string)

Label yang digunakan untuk metadata tambahan dan/atau pemfilteran.

Sebuah objek yang berisi daftar "key": value . Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Hanya keluaran. Waktu pembuatan versi.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z" .

createUser

object ( ActingUser )

Hanya keluaran. Mengidentifikasi pengguna yang membuat versi.

finalizeTime

string ( Timestamp format)

Hanya keluaran. Waktu saat versi tersebut FINALIZED .

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z" .

finalizeUser

object ( ActingUser )

Hanya keluaran. Mengidentifikasi pengguna yang FINALIZED versinya.

deleteTime

string ( Timestamp format)

Hanya keluaran. Waktu saat versi tersebut DELETED .

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z" .

deleteUser

object ( ActingUser )

Hanya keluaran. Mengidentifikasi pengguna yang DELETED versinya.

fileCount

string ( int64 format)

Hanya keluaran. Jumlah total file yang terkait dengan versi tersebut.

Nilai ini dihitung setelah versi FINALIZED .

versionBytes

string ( int64 format)

Hanya keluaran. Total ukuran byte versi yang disimpan.

Nilai ini dihitung setelah versi FINALIZED .

Status Versi

Status yang diketahui saat ini dari versi tertentu dalam siklus hidup penerapan.

Enum
VERSION_STATUS_UNSPECIFIED Status bawaan; tidak boleh digunakan dengan sengaja.
CREATED Versi telah dibuat, dan konten sedang ditambahkan ke versi tersebut.
FINALIZED Semua konten telah ditambahkan ke versi, dan versi tidak dapat diubah lagi.
DELETED Versi telah dihapus.
ABANDONED Versi tidak diperbarui ke FINALIZED dalam waktu 12 jam dan dihapus secara otomatis.
EXPIRED Versi tersebut berada di luar batas yang dikonfigurasi situs untuk jumlah versi yang dipertahankan, sehingga konten versi tersebut dijadwalkan untuk dihapus.
CLONING Versi ini sedang diklon dari versi lain. Semua konten masih disalin.

Konfigurasi Penyajian

Konfigurasi bagaimana permintaan masuk ke situs harus dirutekan dan diproses sebelum menyajikan konten. Jalur permintaan URL dicocokkan dengan pola URL yang ditentukan dalam konfigurasi, kemudian Hosting menerapkan konfigurasi yang berlaku sesuai dengan urutan prioritas tertentu.

Representasi JSON
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
Bidang
headers[]

object ( Header )

Array objek, yang setiap objeknya menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk menerapkan header respons kustom yang ditentukan.

redirects[]

object ( Redirect )

Array objek (disebut aturan pengalihan), yang setiap aturannya menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk merespons dengan pengalihan ke jalur tujuan yang ditentukan.

rewrites[]

object ( Rewrite )

Array objek (disebut aturan penulisan ulang), yang setiap aturannya menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk merespons seolah-olah layanan diberi URL tujuan yang ditentukan.

cleanUrls

boolean

Menentukan apakah akan menghapus ekstensi file dari file yang diunggah.

trailingSlashBehavior

enum ( TrailingSlashBehavior )

Mendefinisikan cara menangani garis miring di jalur URL.

i18n

object ( I18nConfig )

Opsional. Mendefinisikan perilaku penulisan ulang i18n.

Header menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk menerapkan header respons khusus yang ditentukan.

Representasi 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.
}
Bidang
headers

map (key: string, value: string)

Diperlukan. Header tambahan untuk ditambahkan ke respons.

Sebuah objek yang berisi daftar "key": value . Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

pattern bidang persatuan.
Diperlukan. Pola URL string yang cocok dengan jalur URL permintaan untuk menentukan apakah akan menerapkan header respons khusus ini. Dapat berupa glob gaya Bash atau ekspresi reguler RE2.

pattern hanya dapat berupa salah satu dari berikut ini:
glob

string

Glob yang disediakan pengguna untuk dicocokkan dengan jalur URL permintaan.

regex

string

Ekspresi reguler RE2 yang disediakan pengguna untuk dicocokkan dengan jalur URL permintaan.

Pengalihan

Redirect menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting merespons dengan pengalihan ke jalur tujuan yang ditentukan.

Representasi 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.
}
Bidang
statusCode

integer

Diperlukan. Kode HTTP status yang akan dikembalikan sebagai respons. Itu harus berupa kode status 3xx yang valid.

location

string

Diperlukan. Nilai yang akan dimasukkan ke dalam header lokasi HTTP respons.

Lokasi dapat berisi nilai grup pengambilan dari pola menggunakan awalan : untuk mengidentifikasi segmen dan * opsional untuk mengambil sisa URL. Misalnya:

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

pattern bidang persatuan.
Diperlukan. Pola URL string yang cocok dengan jalur URL permintaan untuk menentukan apakah akan menerapkan pengalihan ini. Dapat berupa glob gaya Bash atau ekspresi reguler RE2.

pattern hanya dapat berupa salah satu dari berikut ini:
glob

string

Glob yang disediakan pengguna untuk dicocokkan dengan jalur URL permintaan.

regex

string

Ekspresi reguler RE2 yang disediakan pengguna untuk dicocokkan dengan jalur URL permintaan.

Menulis kembali

Rewrite menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk merespons seolah-olah layanan diberi URL tujuan yang ditentukan.

Representasi 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.
}
Bidang
functionRegion

string

Opsional. Tentukan wilayah Cloud untuk pemanggilan Fungsi yang ditulis ulang. Jika tidak disediakan, defaultnya adalah us-central1.

pattern bidang persatuan.
Diperlukan. Pola URL string yang cocok dengan jalur URL permintaan untuk menentukan apakah akan menerapkan penulisan ulang ini. Dapat berupa glob gaya Bash atau ekspresi reguler RE2.

pattern hanya dapat berupa salah satu dari berikut ini:
glob

string

Glob yang disediakan pengguna untuk dicocokkan dengan jalur URL permintaan.

regex

string

Ekspresi reguler RE2 yang disediakan pengguna untuk dicocokkan dengan jalur URL permintaan.

behavior lapangan serikat pekerja.
Diperlukan. Perilaku penulisan ulang.

behavior hanya dapat berupa salah satu dari berikut ini:
path

string

Jalur URL tujuan penulisan ulang permintaan.

function

string

Fungsi untuk memproksi permintaan. Harus sama persis dengan nama fungsi yang diekspor.

run

object ( CloudRunRewrite )

Permintaan akan diteruskan ke Cloud Run.

CloudRunTulis Ulang

Penulisan ulang terkonfigurasi yang mengarahkan permintaan ke layanan Cloud Run. Jika layanan Cloud Run tidak ada saat menyetel atau memperbarui konfigurasi Firebase Hosting Anda, maka permintaan akan gagal. Setiap error dari layanan Cloud Run diteruskan ke pengguna akhir (misalnya, jika Anda menghapus suatu layanan, setiap permintaan yang diarahkan ke layanan tersebut akan menerima error 404 ).

Representasi JSON
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Bidang
serviceId

string

Diperlukan. ID layanan Cloud Run yang ditentukan pengguna.

region

string

Opsional. Wilayah yang disediakan pengguna tempat layanan Cloud Run dihosting.

Defaultnya adalah us-central1 jika tidak disediakan.

tag

string

Opsional. Tag TrafficConfig yang disediakan pengguna untuk mengirimkan lalu lintas.

Jika dihilangkan, lalu lintas dikirim ke URI seluruh layanan

Perilaku TrailingSlash

Menentukan apakah garis miring harus ditambahkan atau dihapus dari jalur URL permintaan.

Enum
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Tidak ada perilaku yang ditentukan.

File disajikan di lokasi persisnya saja, dan garis miring di akhir hanya ditambahkan ke indeks direktori.

ADD Garis miring tambahan ditambahkan ke indeks direktori serta jalur URL mana pun yang tidak diakhiri dengan ekstensi file.
REMOVE Garis miring tambahan dihapus dari indeks direktori serta dari jalur URL apa pun yang tidak diakhiri dengan ekstensi file.

I18nConfig

Jika disediakan, penulisan ulang i18n diaktifkan.

Representasi JSON
{
  "root": string
}
Bidang
root

string

Diperlukan. Jalur yang disediakan pengguna tempat konten spesifik negara dan bahasa akan dicari dalam direktori publik.

Metode

clone

Membuat versi baru di situs target yang ditentukan menggunakan konten versi yang ditentukan.

create

Membuat versi baru untuk situs tertentu.

delete

Menghapus versi yang ditentukan.

get

Dapatkan versi tertentu yang telah dibuat untuk situs tertentu.

list

Mencantumkan versi yang telah dibuat untuk situs tertentu.

patch

Memperbarui metadata yang ditentukan untuk versi yang ditentukan.

populateFiles

Menambahkan file konten ke versi yang ditentukan.