REST Resource: sites.versions

Tài nguyên: Phiên bản

Version là một cấu hình và tập hợp các tệp tĩnh xác định cách hiển thị trang web.

Biểu diễn 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
}
Lĩnh vực
name

string

Tên tài nguyên đủ điều kiện cho phiên bản, ở định dạng:

sites/ SITE_ID /versions/ VERSION_ID

Tên này được cung cấp trong phần nội dung phản hồi khi bạn versions.create .

status

enum ( VersionStatus )

Trạng thái triển khai của phiên bản.

Để triển khai thành công, hãy versions.create để tạo phiên bản mới (trạng thái CREATED ), tải tất cả các tệp mong muốn lên phiên bản, sau đó cập nhật phiên bản lên trạng thái FINALIZED .

Lưu ý nếu bạn để phiên bản ở trạng thái CREATED quá 12 tiếng thì hệ thống sẽ tự động đánh dấu phiên bản đó là ABANDONED .

Bạn cũng có thể thay đổi trạng thái của một phiên bản thành DELETED bằng cách versions.delete .

config

object ( ServingConfig )

Cấu hình cho hoạt động của trang web. Cấu hình này tồn tại trong tệp firebase.json .

labels

map (key: string, value: string)

Các nhãn được sử dụng cho siêu dữ liệu bổ sung và/hoặc lọc.

Một đối tượng chứa danh sách các cặp "key": value . Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Chỉ đầu ra. Thời điểm phiên bản được tạo.

Dấu thời gian ở định dạng RFC3339 UTC "Zulu", với độ phân giải nano giây và tối đa chín chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z" .

createUser

object ( ActingUser )

Chỉ đầu ra. Xác định người dùng đã tạo phiên bản.

finalizeTime

string ( Timestamp format)

Chỉ đầu ra. Thời điểm phiên bản được FINALIZED .

Dấu thời gian ở định dạng RFC3339 UTC "Zulu", với độ phân giải nano giây và tối đa chín chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z" .

finalizeUser

object ( ActingUser )

Chỉ đầu ra. Xác định người dùng đã FINALIZED phiên bản.

deleteTime

string ( Timestamp format)

Chỉ đầu ra. Thời điểm phiên bản bị DELETED .

Dấu thời gian ở định dạng RFC3339 UTC "Zulu", với độ phân giải nano giây và tối đa chín chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z" .

deleteUser

object ( ActingUser )

Chỉ đầu ra. Xác định người dùng đã DELETED phiên bản.

fileCount

string ( int64 format)

Chỉ đầu ra. Tổng số tệp được liên kết với phiên bản.

Giá trị này được tính sau khi một phiên bản được FINALIZED .

versionBytes

string ( int64 format)

Chỉ đầu ra. Tổng kích thước byte được lưu trữ của phiên bản.

Giá trị này được tính sau khi một phiên bản được FINALIZED .

Phiên bảnTrạng thái

Trạng thái đã biết hiện tại của một phiên bản cụ thể trong vòng đời triển khai.

Enum
VERSION_STATUS_UNSPECIFIED Trạng thái mặc định; không nên cố ý sử dụng.
CREATED Phiên bản đã được tạo và nội dung hiện đang được thêm vào phiên bản.
FINALIZED Tất cả nội dung đã được thêm vào phiên bản và phiên bản không thể thay đổi được nữa.
DELETED Phiên bản đã bị xóa.
ABANDONED Phiên bản không được cập nhật lên FINALIZED trong vòng 12 giờ và tự động bị xóa.
EXPIRED Phiên bản nằm ngoài giới hạn do trang web định cấu hình cho số lượng phiên bản được giữ lại, do đó nội dung của phiên bản đã được lên lịch xóa.
CLONING Phiên bản đang được sao chép từ một phiên bản khác. Tất cả nội dung vẫn đang được sao chép.

Cấu hình phục vụ

Cấu hình về cách định tuyến và xử lý các yêu cầu đến một trang web trước khi cung cấp nội dung. Các đường dẫn yêu cầu URL được khớp với các mẫu URL được chỉ định trong cấu hình, sau đó Hosting sẽ áp dụng cấu hình phù hợp theo thứ tự ưu tiên cụ thể.

Biểu diễn JSON
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
Lĩnh vực
headers[]

object ( Header )

Một mảng đối tượng, trong đó mỗi đối tượng chỉ định một mẫu URL, nếu khớp với đường dẫn URL yêu cầu, sẽ kích hoạt Dịch vụ lưu trữ áp dụng các tiêu đề phản hồi tùy chỉnh đã chỉ định.

redirects[]

object ( Redirect )

Một mảng đối tượng (được gọi là quy tắc chuyển hướng), trong đó mỗi quy tắc chỉ định một mẫu URL, nếu khớp với đường dẫn URL yêu cầu, sẽ kích hoạt Dịch vụ lưu trữ phản hồi bằng chuyển hướng đến đường dẫn đích đã chỉ định.

rewrites[]

object ( Rewrite )

Một mảng đối tượng (được gọi là quy tắc viết lại), trong đó mỗi quy tắc chỉ định một mẫu URL, nếu khớp với đường dẫn URL yêu cầu, sẽ kích hoạt Dịch vụ lưu trữ phản hồi như thể dịch vụ được cung cấp URL đích đã chỉ định.

cleanUrls

boolean

Xác định xem có nên bỏ phần mở rộng tệp khỏi các tệp đã tải lên hay không.

trailingSlashBehavior

enum ( TrailingSlashBehavior )

Xác định cách xử lý dấu gạch chéo ở cuối đường dẫn URL.

i18n

object ( I18nConfig )

Không bắt buộc. Xác định hành vi viết lại i18n.

Header chỉ định một mẫu URL, nếu khớp với đường dẫn URL yêu cầu, sẽ kích hoạt Dịch vụ lưu trữ áp dụng các tiêu đề phản hồi tùy chỉnh được chỉ định.

Biểu diễn 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.
}
Lĩnh vực
headers

map (key: string, value: string)

Yêu cầu. Các tiêu đề bổ sung để thêm vào phản hồi.

Một đối tượng chứa danh sách các cặp "key": value . Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

pattern trường liên minh .
Yêu cầu. Mẫu URL chuỗi khớp với đường dẫn URL yêu cầu để xác định xem có áp dụng tiêu đề phản hồi tùy chỉnh này hay không. Có thể là biểu thức toàn cầu kiểu Bash hoặc biểu thức chính quy RE2.

pattern chỉ có thể là một trong những mẫu sau:
glob

string

Toàn cầu do người dùng cung cấp để khớp với đường dẫn URL yêu cầu.

regex

string

Biểu thức chính quy RE2 do người dùng cung cấp để khớp với đường dẫn URL yêu cầu.

Chuyển hướng

Redirect chỉ định một mẫu URL, nếu khớp với đường dẫn URL yêu cầu, sẽ kích hoạt Dịch vụ lưu trữ phản hồi bằng chuyển hướng đến đường dẫn đích đã chỉ định.

Biểu diễn 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.
}
Lĩnh vực
statusCode

integer

Yêu cầu. Mã HTTP trạng thái sẽ trả về trong phản hồi. Nó phải là mã trạng thái 3xx hợp lệ.

location

string

Yêu cầu. Giá trị để đặt vào tiêu đề vị trí HTTP của phản hồi.

Vị trí có thể chứa các giá trị nhóm thu thập từ mẫu bằng cách sử dụng tiền tố : để xác định phân đoạn và tùy chọn * để thu thập phần còn lại của URL. Ví dụ:

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

pattern trường liên minh .
Yêu cầu. Mẫu URL chuỗi khớp với đường dẫn URL yêu cầu để xác định xem có áp dụng chuyển hướng này hay không. Có thể là biểu thức toàn cầu kiểu Bash hoặc biểu thức chính quy RE2.

pattern chỉ có thể là một trong những mẫu sau:
glob

string

Toàn cầu do người dùng cung cấp để khớp với đường dẫn URL yêu cầu.

regex

string

Biểu thức chính quy RE2 do người dùng cung cấp để khớp với đường dẫn URL yêu cầu.

Viết lại

Rewrite chỉ định một mẫu URL, nếu khớp với đường dẫn URL yêu cầu, sẽ kích hoạt Dịch vụ lưu trữ phản hồi như thể dịch vụ được cung cấp URL đích đã chỉ định.

Biểu diễn 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.
}
Lĩnh vực
functionRegion

string

Không bắt buộc. Chỉ định vùng Đám mây cho các lệnh gọi Hàm được viết lại. Nếu không được cung cấp, mặc định là us-central1.

pattern trường liên minh .
Yêu cầu. Mẫu URL chuỗi phù hợp với đường dẫn URL yêu cầu để xác định xem có áp dụng cách viết lại này hay không. Có thể là biểu thức toàn cầu kiểu Bash hoặc biểu thức chính quy RE2.

pattern chỉ có thể là một trong những mẫu sau:
glob

string

Toàn cầu do người dùng cung cấp để khớp với đường dẫn URL yêu cầu.

regex

string

Biểu thức chính quy RE2 do người dùng cung cấp để khớp với đường dẫn URL yêu cầu.

Hành vi behavior vực liên minh.
Yêu cầu. Hành vi của việc viết lại.

behavior chỉ có thể là một trong những hành vi sau:
path

string

Đường dẫn URL để viết lại yêu cầu.

function

string

Chức năng proxy yêu cầu tới. Phải khớp chính xác với tên hàm đã xuất.

run

object ( CloudRunRewrite )

Yêu cầu sẽ được chuyển tiếp tới Cloud Run.

CloudRunViết lại

Bản ghi lại được định cấu hình sẽ chuyển các yêu cầu tới dịch vụ Cloud Run. Nếu dịch vụ Cloud Run không tồn tại khi cài đặt hoặc cập nhật cấu hình Firebase Hosting của bạn thì yêu cầu sẽ không thành công. Mọi lỗi từ dịch vụ Cloud Run đều được chuyển đến người dùng cuối (ví dụ: nếu bạn xóa một dịch vụ, mọi yêu cầu hướng đến dịch vụ đó sẽ nhận được lỗi 404 ).

Biểu diễn JSON
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Lĩnh vực
serviceId

string

Yêu cầu. ID do người dùng xác định của dịch vụ Cloud Run.

region

string

Không bắt buộc. Khu vực do người dùng cung cấp nơi lưu trữ dịch vụ Cloud Run.

Mặc định là us-central1 nếu không được cung cấp.

tag

string

Không bắt buộc. Thẻ TrafficConfig do người dùng cung cấp để gửi lưu lượng truy cập đến.

Khi bị bỏ qua, lưu lượng truy cập sẽ được gửi đến URI trên toàn dịch vụ

TrailingSlashHành vi

Xác định xem nên thêm hay xóa dấu gạch chéo ở cuối đường dẫn URL yêu cầu.

Enum
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Không có hành vi nào được chỉ định.

Các tệp chỉ được phân phối tại vị trí chính xác của chúng và dấu gạch chéo ở cuối chỉ được thêm vào chỉ mục thư mục.

ADD Dấu gạch chéo ở cuối được thêm vào chỉ mục thư mục cũng như bất kỳ đường dẫn URL nào không kết thúc bằng phần mở rộng tệp.
REMOVE Dấu gạch chéo ở cuối bị xóa khỏi chỉ mục thư mục cũng như khỏi bất kỳ đường dẫn URL nào không kết thúc bằng phần mở rộng tệp.

I18nConfig

Nếu được cung cấp, tính năng ghi lại i18n sẽ được bật.

Biểu diễn JSON
{
  "root": string
}
Lĩnh vực
root

string

Yêu cầu. Đường dẫn do người dùng cung cấp nơi nội dung cụ thể về quốc gia và ngôn ngữ sẽ được tìm kiếm trong thư mục công cộng.

phương pháp

clone

 Tạo một phiên bản mới trên trang đích được chỉ định bằng cách sử dụng nội dung của phiên bản đã chỉ định.

create

 Tạo một phiên bản mới cho trang web được chỉ định.

delete

 Xóa phiên bản được chỉ định.

get

 Lấy phiên bản được chỉ định đã được tạo cho trang web được chỉ định.

list

 Liệt kê các phiên bản đã được tạo cho trang web được chỉ định.

patch

 Cập nhật siêu dữ liệu được chỉ định cho phiên bản được chỉ định.

populateFiles

 Thêm tệp nội dung vào phiên bản được chỉ định.