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 trang web hiển thị.

Biểu diễn dưới dạng 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
}
Trường
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 nội dung phản hồi khi bạn gọi 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 gọi versions.create để tạo phiên bản mới (trạng thái CREATED), tải tất 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 ý rằng nếu bạn để phiên bản ở trạng thái CREATED hơn 12 giờ, 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 gọi versions.delete.
config

object (ServingConfig)

Cấu hình 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 và/hoặc lọc bổ sung.

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ỉ có đầu ra. Thời gian tạo phiên bản.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
createUser

object (ActingUser)

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

string (Timestamp format)

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

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
finalizeUser

object (ActingUser)

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

string (Timestamp format)

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

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
deleteUser

object (ActingUser)

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

string (int64 format)

Chỉ có đầ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 phiên bản là FINALIZED.
versionBytes

string (int64 format)

Chỉ có đầ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 phiên bản là FINALIZED.

Trạng thái phiên bản

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 được 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à không thể thay đổi phiên bản được nữa.
DELETED Phiên bản này đã bị xoá.
ABANDONED Phiên bản chưa được cập nhật lên FINALIZED trong vòng 12 giờ và đã tự động bị xoá.
EXPIRED Phiên bản này nằm ngoài giới hạn do trang web định cấu hình về số lượng phiên bản được giữ lại, do đó, nội dung của phiên bản bị lên lịch xoá.
CLONING Phiên bản này đang được sao chép từ một phiên bản khác. Vẫn đang sao chép tất cả nội dung.

Cấu hình phân phát

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 phân phát nội dung. Đường dẫn yêu cầu URL được so khớp với các mẫu URL đã chỉ định trong cấu hình, sau đó tính năng Lưu trữ sẽ áp dụng cấu hình phù hợp theo thứ tự ưu tiên cụ thể.

Biểu diễn dưới dạng JSON 
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
Trường
headers[]

object (Header)

Một mảng đối tượng, trong đó mỗi đối tượng chỉ định một mẫu URL mà nếu khớp với đường dẫn URL yêu cầu, thì tính năng Lưu trữ sẽ kích hoạt tính năng Lưu trữ để áp dụng các tiêu đề phản hồi tuỳ 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 mà, nếu khớp với đường dẫn URL yêu cầu, thì tính năng Lưu trữ sẽ kích hoạt để phản hồi bằng lệnh chuyển hướng đến đường dẫn đích được chỉ định.
rewrites[]

object (Rewrite)

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

boolean

Xác định xem có cần thả đuôi tệp khỏi 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 trong đườ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 mà, 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 tuỳ chỉnh đã chỉ định.

Biểu diễn dưới dạng 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.
}
Trường
headers

map (key: string, value: string)

Bắt buộc. Các tiêu đề bổ sung để thêm vào câu trả lờ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" }.
Trường kết hợp pattern.
Bắt buộc. Mẫu URL chuỗi cần so khớp với đường dẫn URL yêu cầu nhằm xác định xem có áp dụng tiêu đề phản hồi tuỳ chỉnh này hay không. Có thể là hình 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 trạng thái sau:
glob

string

Hình ảnh cầu do người dùng cung cấp để so 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 mà, nếu khớp với đường dẫn URL yêu cầu, thì tính năng Lưu trữ sẽ kích hoạt để phản hồi bằng lệnh chuyển hướng đến đường dẫn đích được chỉ định.

Biểu diễn dưới dạng 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.
}
Trường
statusCode

integer

Bắt buộc. Mã HTTP trạng thái cần trả về trong phản hồi. Mã trạng thái phải là mã trạng thái 3xx hợp lệ.
location

string

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

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

"glob": "/:capture*",
"statusCode": 301,
"location": "https://example.com/foo/:capture"
Trường kết hợp pattern.
Bắt buộc. Mẫu URL chuỗi cần so khớp với đường dẫn URL yêu cầu nhằm xác định xem có áp dụng lệnh chuyển hướng này hay không. Có thể là hình 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 trạng thái sau:
glob

string

Hình ảnh cầu do người dùng cung cấp để so 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ẫu URL mà, 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 dưới dạng 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.
}
Trường
functionRegion

string

Không bắt buộc. Chỉ định một khu vực Đá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, giá trị mặc định sẽ là us-central1.
Trường kết hợp pattern.
Bắt buộc. Mẫu URL chuỗi cần so khớp với đường dẫn URL yêu cầu nhằm xác định xem có áp dụng mẫu ghi lại này hay không. Có thể là hình 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 trạng thái sau:
glob

string

Hình ảnh cầu do người dùng cung cấp để so 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.
Trường kết hợp behavior.
Bắt buộc. Hành vi viết lại.

behavior chỉ có thể là một trong những trạng thái sau:
path

string

Đường dẫn URL để ghi lại yêu cầu.
function

string

Hàm để proxy yêu cầu. Phải khớp chính xác với tên hàm được xuất.
run

object (CloudRunRewrite)

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

Viết lại trên CloudRun

Một lệnh viết lại đã định cấu hình sẽ chuyển hướng các yêu cầu đến một dịch vụ Cloud Run. Nếu dịch vụ Cloud Run không tồn tại khi bạn đặt hoặc cập nhật cấu hình Lưu trữ Firebase, thì yêu cầu sẽ không thực hiện được. Mọi lỗi từ dịch vụ Cloud Run sẽ được chuyển đến người dùng cuối (ví dụ: nếu bạn xoá một dịch vụ, mọi yêu cầu gửi đến dịch vụ đó đều sẽ nhận được lỗi 404).

Biểu diễn dưới dạng JSON 
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Trường
serviceId

string

Bắt buộc. Mã nhận dạng 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.

Giá trị 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 toàn dịch vụ

Hành vi TrailingSlash

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

Enum
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Chưa xác định hành vi nào.

Tệp chỉ được phân phát tại vị trí chính xác của tệp, trong khi dấu gạch chéo ở cuối chỉ được thêm vào chỉ mục thư mục.
ADD Bạn có thể thêm dấu gạch chéo ở cuối vào chỉ mục thư mục cũng như vào bất kỳ đường dẫn URL nào không kết thúc bằng đuôi tệp.
REMOVE Dấu gạch chéo ở cuối bị xoá khỏi chỉ mục thư mục cũng như khỏi mọi đường dẫn URL không kết thúc bằng đuôi tệp.

Cấu hình I18n

Nếu được cung cấp, tính năng viết lại theo tiêu chuẩn i18n sẽ được bật.

Biểu diễn dưới dạng JSON 
{
  "root": string
}
Trường
root

string

Bắt buộc. Đường dẫn do người dùng cung cấp để tìm kiếm nội dung dành riêng cho quốc gia và ngôn ngữ trong danh bạ công khai.

Phương thức

clone

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

create

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

delete

 Xoá phiên bản đã chỉ định.

get

 Lấy phiên bản 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ụ thể.

patch

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

populateFiles

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