REST Resource: sites.versions

Zasób: wersja

Version to konfiguracja i zbiór plików statycznych, które określają sposób wyświetlania witryny.

Reprezentacja 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
}
Pola
name

string

W pełni kwalifikowana nazwa zasobu wersji w formacie:

sites/ SITE_ID /versions/ VERSION_ID

Ta nazwa jest podawana w treści odpowiedzi podczas wywoływania versions.create .

status

enum ( VersionStatus )

Stan wdrożenia wersji.

Aby wdrożenie przebiegło pomyślnie, wywołaj versions.create , aby utworzyć nową wersję (status CREATED ), prześlij wszystkie żądane pliki do wersji, a następnie zaktualizuj wersję do stanu FINALIZED .

Pamiętaj, że jeśli pozostawisz wersję w stanie CREATED na dłużej niż 12 godzin, system automatycznie oznaczy ją jako ABANDONED .

Możesz także zmienić status wersji na DELETED , versions.delete .

config

object ( ServingConfig )

Konfiguracja zachowania witryny. Ta konfiguracja istnieje w pliku firebase.json .

labels

map (key: string, value: string)

Etykiety używane do dodatkowych metadanych i/lub filtrowania.

Obiekt zawierający listę par "key": value . Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Tylko wyjście. Czas utworzenia wersji.

Znacznik czasu w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundową i maksymalnie dziewięcioma cyframi ułamkowymi. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z" .

createUser

object ( ActingUser )

Tylko wyjście. Identyfikuje użytkownika, który utworzył wersję.

finalizeTime

string ( Timestamp format)

Tylko wyjście. Czas, w którym wersja została FINALIZED .

Znacznik czasu w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundową i maksymalnie dziewięcioma cyframi ułamkowymi. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z" .

finalizeUser

object ( ActingUser )

Tylko wyjście. Identyfikuje użytkownika, który FINALIZED wersję.

deleteTime

string ( Timestamp format)

Tylko wyjście. Czas, w którym wersja została DELETED .

Znacznik czasu w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundową i maksymalnie dziewięcioma cyframi ułamkowymi. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z" .

deleteUser

object ( ActingUser )

Tylko wyjście. Identyfikuje użytkownika, który DELETED wersję.

fileCount

string ( int64 format)

Tylko wyjście. Całkowita liczba plików skojarzonych z wersją.

Wartość ta jest obliczana po FINALIZED wersji.

versionBytes

string ( int64 format)

Tylko wyjście. Całkowity rozmiar przechowywanej wersji w bajtach.

Wartość ta jest obliczana po FINALIZED wersji.

Stan wersji

Bieżący znany stan określonej wersji w cyklu życia wdrożenia.

Wyliczenia
VERSION_STATUS_UNSPECIFIED Stan domyślny; nie należy używać celowo.
CREATED Wersja została utworzona i zawartość jest obecnie dodawana do wersji.
FINALIZED Cała zawartość została dodana do wersji i wersji nie można już zmienić.
DELETED Wersja została usunięta.
ABANDONED Wersja nie została zaktualizowana do FINALIZED w ciągu 12 godzin i została automatycznie usunięta.
EXPIRED Wersja przekracza skonfigurowany w witrynie limit liczby zachowywanych wersji, więc zawartość wersji została zaplanowana do usunięcia.
CLONING Wersja jest klonowana z innej wersji. Cała zawartość jest nadal kopiowana.

Konfiguracja udostępniania

Konfiguracja sposobu kierowania i przetwarzania żądań przychodzących do witryny przed udostępnieniem zawartości. Ścieżki żądań URL są dopasowywane do określonych wzorców adresów URL w konfiguracji, a następnie Hosting stosuje odpowiednią konfigurację zgodnie z określoną kolejnością priorytetów .

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

object ( Header )

Tablica obiektów, gdzie każdy obiekt określa wzorzec adresu URL, który po dopasowaniu do ścieżki adresu URL żądania powoduje, że Hosting zastosuje określone niestandardowe nagłówki odpowiedzi.

redirects[]

object ( Redirect )

Tablica obiektów (zwana regułami przekierowań), gdzie każda reguła określa wzorzec adresu URL, który po dopasowaniu do ścieżki adresu URL żądania powoduje, że Hosting odpowiada przekierowaniem do określonej ścieżki docelowej.

rewrites[]

object ( Rewrite )

Tablica obiektów (zwana regułami przepisywania), gdzie każda reguła określa wzorzec adresu URL, który po dopasowaniu do ścieżki adresu URL żądania powoduje, że Hosting reaguje tak, jakby usługa otrzymała określony docelowy adres URL.

cleanUrls

boolean

Określa, czy usunąć rozszerzenie pliku z przesłanych plików.

trailingSlashBehavior

enum ( TrailingSlashBehavior )

Definiuje sposób obsługi końcowego ukośnika w ścieżce adresu URL.

i18n

object ( I18nConfig )

Opcjonalny. Definiuje zachowanie przepisywania i18n.

Header określa wzorzec adresu URL, który, jeśli jest dopasowany do ścieżki adresu URL żądania, powoduje, że Hosting stosuje określone niestandardowe nagłówki odpowiedzi.

Reprezentacja 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.
}
Pola
headers

map (key: string, value: string)

Wymagany. Dodatkowe nagłówki, które należy dodać do odpowiedzi.

Obiekt zawierający listę par "key": value . Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

pattern pola Unii.
Wymagany. Wzorzec adresu URL ciągu pasującego do ścieżki adresu URL żądania w celu ustalenia, czy zastosować ten niestandardowy nagłówek odpowiedzi. Może to być glob w stylu Bash lub wyrażenie regularne RE2.

pattern może być tylko jednym z następujących:
glob

string

Glob dostarczony przez użytkownika, który ma być zgodny ze ścieżką URL żądania.

regex

string

Dostarczone przez użytkownika wyrażenie regularne RE2 pasujące do ścieżki adresu URL żądania.

Przeadresować

Redirect określa wzorzec adresu URL, który, jeśli jest dopasowany do ścieżki adresu URL żądania, powoduje, że Hosting odpowiada przekierowaniem do określonej ścieżki docelowej.

Reprezentacja 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.
}
Pola
statusCode

integer

Wymagany. Kod HTTP stanu, który ma zostać zwrócony w odpowiedzi. Musi to być prawidłowy kod stanu 3xx.

location

string

Wymagany. Wartość, która ma zostać umieszczona w nagłówku lokalizacji HTTP odpowiedzi.

Lokalizacja może zawierać wartości grupy przechwytywania ze wzorca, używając przedrostka : w celu zidentyfikowania segmentu i opcjonalnego * w celu przechwycenia pozostałej części adresu URL. Na przykład:

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

pattern pola Unii.
Wymagany. Ciągowy wzorzec adresu URL pasujący do ścieżki adresu URL żądania w celu ustalenia, czy zastosować to przekierowanie. Może to być glob w stylu Bash lub wyrażenie regularne RE2.

pattern może być tylko jednym z następujących:
glob

string

Glob dostarczony przez użytkownika, który ma być zgodny ze ścieżką URL żądania.

regex

string

Dostarczone przez użytkownika wyrażenie regularne RE2 pasujące do ścieżki adresu URL żądania.

Przepisać

Rewrite określa wzorzec adresu URL, który, jeśli jest dopasowany do ścieżki adresu URL żądania, powoduje, że Hosting reaguje tak, jakby usługa otrzymała określony docelowy adres URL.

Reprezentacja 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.
}
Pola
functionRegion

string

Opcjonalny. Określ region chmury dla przepisanych wywołań funkcji. Jeśli nie zostanie podany, domyślnie jest to us-central1.

pattern pola Unii.
Wymagany. Wzorzec adresu URL ciągu pasującego do ścieżki adresu URL żądania w celu ustalenia, czy zastosować to przepisanie. Może to być glob w stylu Bash lub wyrażenie regularne RE2.

pattern może być tylko jednym z następujących:
glob

string

Glob dostarczony przez użytkownika, który ma być zgodny ze ścieżką URL żądania.

regex

string

Dostarczone przez użytkownika wyrażenie regularne RE2 pasujące do ścieżki adresu URL żądania.

behavior na polu Unii.
Wymagany. Zachowanie przepisywania.

behavior może być tylko jednym z poniższych:
path

string

Ścieżka URL, do której należy ponownie zapisać żądanie.

function

string

Funkcja do wysyłania żądań proxy. Musi dokładnie odpowiadać wyeksportowanej nazwie funkcji.

run

object ( CloudRunRewrite )

Żądanie zostanie przekazane do Cloud Run.

CloudRunRewrite

Skonfigurowane przepisanie, które kieruje żądania do usługi Cloud Run. Jeśli usługa Cloud Run nie istnieje podczas ustawiania lub aktualizowania konfiguracji Firebase Hosting, żądanie nie powiedzie się. Wszelkie błędy usługi Cloud Run przekazywane są użytkownikowi końcowemu (np. jeśli usuniesz usługę, wszelkie żądania kierowane do tej usługi otrzymają błąd 404 ).

Reprezentacja JSON
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Pola
serviceId

string

Wymagany. Zdefiniowany przez użytkownika identyfikator usługi Cloud Run.

region

string

Opcjonalny. Region podany przez użytkownika, w którym hostowana jest usługa Cloud Run.

Domyślnie us-central1 jeśli nie podano.

tag

string

Opcjonalny. Dostarczony przez użytkownika tag TrafficConfig, do którego można wysyłać ruch.

W przypadku pominięcia ruch jest wysyłany do identyfikatora URI obejmującego całą usługę

TrailingSlashZachowanie

Określa, czy ukośnik końcowy powinien zostać dodany, czy usunięty ze ścieżki adresu URL żądania.

Wyliczenia
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Nie określono żadnego zachowania.

Pliki są udostępniane tylko w ich dokładnej lokalizacji, a końcowe ukośniki są dodawane tylko do indeksów katalogów.

ADD Końcowe ukośniki są dodawane do indeksów katalogów, a także do dowolnej ścieżki adresu URL, która nie kończy się rozszerzeniem pliku.
REMOVE Końcowe ukośniki są usuwane z indeksów katalogów, a także ze wszystkich ścieżek URL, które nie kończą się rozszerzeniem pliku.

I18nKonfig

Jeśli jest podany, przepisywanie i18n jest włączone.

Reprezentacja JSON
{
  "root": string
}
Pola
root

string

Wymagany. Podana przez użytkownika ścieżka, w której będą wyszukiwane treści specyficzne dla kraju i języka w katalogu publicznym.

Metody

clone

 Tworzy nową wersję w określonej witrynie docelowej przy użyciu zawartości określonej wersji.

create

 Tworzy nową wersję dla określonej witryny.

delete

 Usuwa określoną wersję.

get

 Pobierz określoną wersję utworzoną dla określonej witryny.

list

 Wyświetla listę wersji utworzonych dla określonej witryny.

patch

 Aktualizuje określone metadane dla określonej wersji.

populateFiles

 Dodaje pliki zawartości do określonej wersji.