REST Resource: projects.locations.backends.domains

Tài nguyên: Miền

Tên miền liên kết với phần phụ trợ.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "type": enum (Type),
  "disabled": boolean,
  "serve": {
    object (ServingBehavior)
  },
  "customDomainStatus": {
    object (CustomDomainStatus)
  },
  "reconciling": boolean,
  "deleteTime": string,
  "purgeTime": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string
}
Trường
name

string

Giá trị nhận dạng. Tên tài nguyên của miền, ví dụ: /projects/p/locations/l/backends/b/domains/foo.com
displayName

string

Không bắt buộc. Tên miền có thể thay đổi mà con người có thể đọc được. Giới hạn 63 ký tự. ví dụ: prod domain.
createTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian tạo miề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".
updateTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian cập nhật miền lần gần đây nhất.

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".
type

enum (Type)

Chỉ có đầu ra. Loại miền.
disabled

boolean

Không bắt buộc. Liệu miền có bị vô hiệu hoá hay không. Giá trị mặc định là false.
serve

object (ServingBehavior)

Không bắt buộc. Hành vi phân phát của miền. Nếu được chỉ định, miền sẽ phân phát nội dung khác với nội dung trực tiếp của phần phụ trợ.
customDomainStatus

object (CustomDomainStatus)

Chỉ có đầu ra. Biểu thị trạng thái và cấu hình của miền loại CUSTOM. Thẻ này chỉ có trên các miền thuộc loại đó.
reconciling

boolean

Chỉ có đầu ra. Một trường (nếu đúng) cho biết bản dựng có LRO đang diễn ra.
deleteTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm miền bị xoá.

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".
purgeTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian mà miền bị xoá tạm thời sẽ được xoá hoàn toàn, được kết xuất thành miền bị xoá vĩnh viễ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".
labels

map (key: string, value: string)

Không bắt buộc. Nhãn dưới dạng cặp khoá-giá trị.

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" }.
annotations

map (key: string, value: string)

Không bắt buộc. Chú giải dưới dạng cặp khoá-giá trị.

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" }.
uid

string

Chỉ có đầu ra. Giá trị nhận dạng duy nhất do hệ thống chỉ định.
etag

string

Chỉ có đầu ra. Giá trị tổng kiểm do máy chủ tính dựa trên các giá trị khác; có thể được gửi khi cập nhật hoặc xoá để đảm bảo thao tác được thực hiện trên tài nguyên dự kiến.

Loại

Loại miền.

Enum
TYPE_UNSPECIFIED Bạn chưa xác định loại dữ liệu (điều này không nên xảy ra).
DEFAULT Miền mặc định, do Lưu trữ ứng dụng cung cấp và miền được quản lý. Các miền này được tạo tự động bằng phần phụ trợ gốc và bạn không thể xoá các miền này trừ phi xoá miền gốc đó. Bạn không thể chuyển những miền này sang phần phụ trợ khác. Bạn có thể tắt miền mặc định thông qua trường disabled.
CUSTOM Miền tuỳ chỉnh, do nhà phát triển sở hữu. Miền tuỳ chỉnh cho phép bạn liên kết miền bạn sở hữu với phần phụ trợ Lưu trữ ứng dụng và định cấu hình miền đó để phân phát nội dung trong phần phụ trợ.

Hành vi phân phát

Cho biết liệu tính năng Lưu trữ ứng dụng có phân phát nội dung trên miền hay không.

Biểu diễn dưới dạng JSON 
{

  // Union field serving_behavior can be only one of the following:
  "redirect": {
    object (Redirect)
  }
  // End of list of possible types for union field serving_behavior.
}
Trường
Trường kết hợp serving_behavior. Nếu được chỉ định, hãy tuỳ chỉnh hành vi phân phát của một miền. serving_behavior chỉ có thể là một trong những trạng thái sau đây:
redirect

object (Redirect)

Không bắt buộc. Hành vi chuyển hướng cho một miền, nếu được cung cấp.

Chuyển hướng

Chỉ định hành vi chuyển hướng cho một miền.

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

string

Bắt buộc. URI của đích đến dự kiến của lệnh chuyển hướng. URI này sẽ được thêm vào trước đường dẫn yêu cầu ban đầu. URI không có giao thức được giả định là HTTPS.
status

string (int64 format)

Không bắt buộc. Mã trạng thái để sử dụng trong phản hồi chuyển hướng. Phải là mã trạng thái HTTP 3XX hợp lệ. Giá trị mặc định là 302 nếu không có giá trị này.

Trạng thái miền tuỳ chỉnh

Trạng thái mối liên kết của một miền tuỳ chỉnh với một phần phụ trợ.

Biểu diễn dưới dạng JSON 
{
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "certState": enum (CertState),
  "requiredDnsUpdates": [
    {
      object (DnsUpdates)
    }
  ],
  "issues": [
    {
      object (Status)
    }
  ]
}
Trường
hostState

enum (HostState)

Chỉ có đầu ra. Theo dõi xem một miền tuỳ chỉnh có được phát hiện là đang chuyển hướng lưu lượng truy cập đến dịch vụ Lưu trữ ứng dụng một cách thích hợp hay không.
ownershipState

enum (OwnershipState)

Chỉ có đầu ra. Theo dõi xem phần phụ trợ có được phép phân phát nội dung trên miền hay không, dựa trên bản ghi DNS của miền.
certState

enum (CertState)

Chỉ có đầu ra. Theo dõi trạng thái chứng chỉ SSL cho miền.
requiredDnsUpdates[]

object (DnsUpdates)

Chỉ có đầu ra. Liệt kê những bản ghi cần phải thêm vào hoặc xoá khỏi DNS của miền tuỳ chỉnh để hoàn tất việc thiết lập và bắt đầu phân phát nội dung. Trường này xuất hiện trong quá trình giới thiệu. Cũng xuất hiện sau khi giới thiệu nếu một hoặc nhiều trạng thái ở trên không *_ACTIVE, cho biết bản ghi DNS của miền đang ở trạng thái không hợp lệ.
issues[]

object (Status)

Chỉ có đầu ra. Danh sách các vấn đề về cấu hình miền. Cho phép người dùng tự khắc phục sự cố với bản ghi DNS.

Trạng thái máy chủ lưu trữ

Trạng thái máy chủ lưu trữ của miền. Trạng thái máy chủ lưu trữ được xác định bằng cách kiểm tra từng địa chỉ IP liên kết với miền của bạn để xem miền đó có đang phân phát thông qua phân đoạn phù hợp của Nguồn lưu trữ ứng dụng hay không.

Enum
HOST_STATE_UNSPECIFIED Trạng thái máy chủ lưu trữ của miền tuỳ chỉnh của bạn chưa được chỉ định. Thông báo sẽ không hợp lệ nếu bạn không chỉ định thông báo này.
HOST_UNHOSTED Miền tuỳ chỉnh của bạn không được liên kết với bất kỳ địa chỉ IP nào.
HOST_UNREACHABLE Không truy cập được vào miền tuỳ chỉnh của bạn. Dịch vụ lưu trữ ứng dụng Các truy vấn DNS để tìm địa chỉ IP của miền của bạn đã gây ra lỗi. Hãy xem trường issues của CustomDomainStatus để biết thêm thông tin.
HOST_NON_FAH Miền của bạn chỉ có các địa chỉ IP không thể phân giải thành Lưu trữ ứng dụng.
HOST_CONFLICT Miền của bạn có địa chỉ IP phân giải đến cả dịch vụ Lưu trữ ứng dụng và các dịch vụ khác. Để đảm bảo kết quả nhất quán, hãy xoá các bản ghi A và AAAA liên quan đến các dịch vụ không lưu trữ ứng dụng.
HOST_WRONG_SHARD Miền của bạn có địa chỉ IP phân giải đến khu vực không chính xác và/hoặc phân đoạn sao chép của Lưu trữ ứng dụng.
HOST_ACTIVE Tất cả các yêu cầu đối với miền của bạn đều được dịch vụ Lưu trữ ứng dụng phân phát, qua phân đoạn được chỉ định cho miền của bạn. Nếu OwnershipState của miền tuỳ chỉnh cũng là OWNERSHIP_ACTIVE, thì dịch vụ Lưu trữ ứng dụng sẽ phân phát nội dung của phần phụ trợ theo các yêu cầu đối với miền đó.

Trạng thái sở hữu

Trạng thái quyền sở hữu của miền tuỳ chỉnh.

Enum
OWNERSHIP_STATE_UNSPECIFIED Bạn chưa chỉ định trạng thái quyền sở hữu của miền tuỳ chỉnh. Điều này không bao giờ xảy ra.
OWNERSHIP_MISSING Miền tùy chỉnh của bạn không có bản ghi quyền sở hữu liên quan đến dịch vụ Lưu trữ ứng dụng; không phần phụ trợ nào được phép phân phát trên miền trong phân đoạn Gốc này.
OWNERSHIP_UNREACHABLE Không truy cập được vào miền tuỳ chỉnh của bạn. Dịch vụ lưu trữ ứng dụng Đã xảy ra lỗi khi dùng truy vấn DNS để tìm bản ghi quyền sở hữu miền của bạn. Hãy xem trường issues của CustomDomainStatus để biết thêm thông tin.
OWNERSHIP_MISMATCH Miền tùy chỉnh của bạn thuộc sở hữu của một miền tùy chỉnh khác trong Lưu trữ ứng dụng. Xoá các bản ghi xung đột và thay thế bằng các bản ghi cho miền tuỳ chỉnh hiện tại của bạn.
OWNERSHIP_CONFLICT Miền tùy chỉnh của bạn có các bản ghi TXT xung đột cho biết quyền sở hữu của cả một hoặc nhiều miền tùy chỉnh hiện tại của bạn. Xoá các bản ghi quyền sở hữu không liên quan để cấp quyền sở hữu miền tuỳ chỉnh hiện tại.
OWNERSHIP_PENDING Bản ghi DNS của miền tuỳ chỉnh của bạn được định cấu hình đúng. Dịch vụ Lưu trữ ứng dụng sẽ chuyển quyền sở hữu miền của bạn sang miền tùy chỉnh này trong vòng 24 giờ.
OWNERSHIP_ACTIVE Miền tuỳ chỉnh của bạn sở hữu miền riêng.

Chứng chỉ

Trạng thái của dịch vụ Lưu trữ ứng dụng có chứng chỉ SSL đối với tên miền của bạn. Thông tin này có thể thể hiện trạng thái của chứng chỉ thực tế hoặc đối với các miền tuỳ chỉnh mới, tính năng Lưu trữ ứng dụng đang cố gắng tạo chứng chỉ.

Enum
CERT_STATE_UNSPECIFIED Trạng thái của chứng chỉ chưa được chỉ định. Thông báo sẽ không hợp lệ nếu bạn không chỉ định thông báo này.
CERT_PREPARING Trạng thái ban đầu của mỗi chứng chỉ thể hiện ý định tạo chứng chỉ của tính năng Lưu trữ ứng dụng trước khi thực hiện yêu cầu đối với Tổ chức phát hành chứng chỉ.
CERT_VALIDATING Dịch vụ Lưu trữ ứng dụng đang xác thực xem bản ghi DNS của một tên miền có đang ở trạng thái cho phép tạo chứng chỉ thay cho tên miền hay không.
CERT_PROPAGATING Chứng chỉ này được tạo gần đây và cần thời gian để truyền tải trong trình cân bằng tải của tính năng Lưu trữ ứng dụng.
CERT_ACTIVE Chứng chỉ này đang hoạt động, cung cấp kết nối bảo mật cho tên miền mà chứng chỉ đó đại diện.
CERT_EXPIRING_SOON Chứng chỉ này sắp hết hạn, tất cả tên miền trên chứng chỉ đó sẽ được cấp chứng chỉ mới.
CERT_EXPIRED Chứng chỉ đã hết hạn. Dịch vụ Lưu trữ ứng dụng không thể phân phát nội dung bảo mật trên tên miền của bạn nữa.

Nội dung cập nhật về doanh nghiệp dựa trên nền tảng kỹ thuật số

Một tập hợp các bản cập nhật bản ghi DNS mà bạn nên thực hiện để cho phép tính năng Lưu trữ ứng dụng phân phát nội dung bảo mật theo các yêu cầu đối với miền của bạn. Những nội dung cập nhật này cho biết trạng thái hiện tại của miền và các miền con có liên quan Các bản ghi DNS khi dịch vụ Lưu trữ ứng dụng truy vấn những bản ghi này lần gần đây nhất và tập hợp bản ghi mong muốn mà dịch vụ Lưu trữ ứng dụng cần xem trước khi miền tuỳ chỉnh của bạn có thể hoàn toàn hoạt động.

Biểu diễn dưới dạng JSON 
{
  "domainName": string,
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}
Trường
domainName

string

Chỉ có đầu ra. Tên miền mà bản cập nhật DNS liên quan.
discovered[]

object (DnsRecordSet)

Chỉ có đầu ra. Tập hợp bản ghi DNS mà dịch vụ Lưu trữ ứng dụng phát hiện được khi kiểm tra một miền.
desired[]

object (DnsRecordSet)

Chỉ có đầu ra. Bộ bản ghi DNS của dịch vụ Lưu trữ ứng dụng cần có để có thể cung cấp nội dung bảo mật trên miền.
checkTime

string (Timestamp format)

Chỉ có đầu ra. Lần lưu trữ ứng dụng gần đây nhất đã kiểm tra bản ghi DNS của miền tùy chỉnh của 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".

Nhóm DnsRecord

Tập hợp các bản ghi DNS liên quan đến việc thiết lập và duy trì miền tuỳ chỉnh trong dịch vụ Lưu trữ ứng dụng.

Biểu diễn dưới dạng JSON 
{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}
Trường
domainName

string

Chỉ có đầu ra. Tên miền mà nhóm bản ghi liên quan.
checkError

object (Status)

Chỉ có đầu ra. Đã xảy ra lỗi với dịch vụ Lưu trữ ứng dụng khi truy vấn bản ghi DNS của miền. Lưu ý: Tính năng Lưu trữ ứng dụng sẽ bỏ qua NXDOMAIN lỗi, vì các lỗi này thường chỉ có nghĩa là tên miền chưa được thiết lập.
records[]

object (DnsRecord)

Chỉ có đầu ra. Bản ghi trên miền.

Bản ghi Dns

Biểu thị bản ghi DNS của một miền.

Bản ghi DNS là các bản ghi tài nguyên xác định cách hoạt động của các hệ thống và dịch vụ khi xử lý các yêu cầu đối với một miền. Ví dụ: khi thêm bản ghi A vào bản ghi DNS của miền, bạn đang thông báo cho các hệ thống khác (chẳng hạn như trình duyệt web của người dùng) liên hệ với các địa chỉ IPv4 đó để truy xuất tài nguyên liên quan đến miền của bạn (chẳng hạn như tệp Lưu trữ ứng dụng).

Biểu diễn dưới dạng JSON 
{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action),
  "relevantState": [
    enum (CustomDomainState)
  ]
}
Trường
domainName

string

Chỉ có đầu ra. Miền mà bản ghi liên quan, ví dụ: foo.bar.com..
type

enum (Type)

Chỉ có đầu ra. Loại bản ghi giúp xác định dữ liệu trong bản ghi.
rdata

string

Chỉ có đầu ra. Dữ liệu của bản ghi. Ý nghĩa của giá trị phụ thuộc vào loại bản ghi: – A và AAAA: Địa chỉ IP cho miền. - CNAME: Một miền khác để kiểm tra bản ghi. - TXT: Chuỗi văn bản tuỳ ý liên kết với miền. Tính năng Lưu trữ ứng dụng sử dụng các bản ghi TXT để xác định dự án Firebase nào có quyền hành động thay mặt miền. - CAA: Cờ, thẻ và giá trị của bản ghi, ví dụ: 0 issue "pki.goog".
requiredAction

enum (Action)

Chỉ có đầu ra. Một giá trị enum cho biết hành động bắt buộc đối với bản ghi này. Được điền sẵn khi bản ghi nằm trong một thay đổi bắt buộc trong nhóm bản ghi DnsUpdates discovered hoặc desired.
relevantState[]

enum (CustomDomainState)

Chỉ có đầu ra. Một giá trị enum cho biết bản ghi DNS này áp dụng cho(các) trạng thái nào. Điền sẵn hành động bắt buộc ADD hoặc REMOVE cho tất cả bản ghi.

Loại

Loại bản ghi DNS, bao gồm cả A, TXT, AAAA và CAA.

Enum
TYPE_UNSPECIFIED Chưa xác định loại bản ghi. Thông báo sẽ không hợp lệ nếu bạn không chỉ định thông báo này.
A Bản ghi A, như định nghĩa trong RFC 1035. Bản ghi xác định địa chỉ IPv4 mà một miền chuyển hướng lưu lượng truy cập đến.
CNAME Bản ghi CNAME, như xác định trong RFC 1035. Bản ghi CNAME hoặc bản ghi Tên chính tắc ánh xạ một miền với một miền chính tắc khác. Nếu có bản ghi CNAME, đó phải là bản ghi duy nhất trên miền.
TXT Bản ghi TXT, như xác định trong RFC 1035. Bản ghi TXT lưu giữ dữ liệu văn bản tuỳ ý trên một miền. Tính năng lưu trữ sử dụng bản ghi TXT để xác định những dự án Firebase có quyền hoạt động trên một miền.
AAAA Bản ghi AAAA, như được xác định trong RFC 3596 Bản ghi AAAA xác định địa chỉ IPv6 nào mà một miền hướng lưu lượng truy cập đến.
CAA

Bản ghi CAA, theo định nghĩa trong RFC 6844. Bản ghi CAA, hay Tổ chức phát hành chứng chỉ, xác định Tổ chức phát hành chứng chỉ (tổ chức tạo chứng chỉ SSL) nào được phép tạo chứng chỉ cho miền. Dịch vụ Lưu trữ ứng dụng sử dụng pki.goog làm CA chính.

Bản ghi CAA phân tầng. Bản ghi CAA trên foo.com cũng áp dụng cho bar.foo.com, trừ phi bar.foo.com có bộ bản ghi CAA riêng.

Bản ghi CAA là không bắt buộc. Nếu một miền và miền gốc không có bản ghi CAA, thì tất cả các CA đều được uỷ quyền để tạo chứng chỉ thay mặt cho miền đó. Nhìn chung, dịch vụ Lưu trữ ứng dụng chỉ yêu cầu bạn sửa đổi bản ghi CAA khi việc này là cần thiết để bỏ chặn việc tạo chứng chỉ SSL.

Hành động

Loại thao tác bạn nên thực hiện đối với bản ghi DNS này để định cấu hình miền cho mục đích Lưu trữ ứng dụng.

Enum
NONE Bạn không cần làm gì cả.
ADD Thêm bản ghi này vào bản ghi DNS của bạn.
REMOVE Hãy xoá bản ghi này khỏi bản ghi DNS của bạn.

Trạng thái miền tùy chỉnh

Một nhóm trạng thái liên quan đến hoạt động lành mạnh của miền tuỳ chỉnh.

Enum
CUSTOM_DOMAIN_STATE_UNSPECIFIED Thông báo này không hợp lệ nếu bạn không chỉ định thông báo này.
HOST_STATE Trạng thái máy chủ lưu trữ của miền tuỳ chỉnh.
OWNERSHIP_STATE Trạng thái quyền sở hữu của miền tuỳ chỉnh.
CERT_STATE Trạng thái chứng chỉ của miền tuỳ chỉnh.

Phương thức

create

 Liên kết một miền mới với phần phụ trợ.

delete

 Xoá một miền.

get

 Lấy thông tin về một miền.

list

 Liệt kê các miền của một phần phụ trợ.

patch

 Cập nhật thông tin cho một miền.