REST Resource: projects.sites.customDomains

{
  "name": string,
  "annotations": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "expireTime": string,
  "etag": string,
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "requiredDnsUpdates": {
    object (DnsUpdates)
  },
  "issues": [
    {
      object (Status)
    }
  ],
  "certPreference": enum (Type),
  "cert": {
    object (Certificate)
  },
  "redirectTarget": string,
  "reconciling": boolean,
  "labels": {
    string: string,
    ...
  }
}

string

仅限输出。CustomDomain 的完全限定名称。

map (key: string, value: string)

您可以添加注解，以保留有关 CustomDomain 的人类可读和机器可读的元数据。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

string (Timestamp format)

仅限输出。自定义网域的创建时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

string (Timestamp format)

仅限输出。上次更新 CustomDomain 的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

string (Timestamp format)

仅限输出。CustomDomain 的删除时间；null。删除的自定义网域会保留大约 30 天，之后 Hosting 会将其完全移除。如需恢复已删除的自定义网域，请发出 customDomains.undelete 请求。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

string (Timestamp format)

仅限输出。软删除的 CustomDomain 从 Hosting 中完全移除前的最短时间；null。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

string

仅限输出。一个字符串，表示 CustomDomain 的当前状态，可让您在会修改 CustomDomain 的请求中确认其初始状态。使用该标记可确保在发出 customDomains.patch、customDomains.delete 和 customDomains.undelete 请求时保持一致。

enum (HostState)

仅限输出。此 CustomDomain 所指域名的 HostState。

enum (OwnershipState)

仅限输出。此 CustomDomain 所指域名的 OwnershipState。

object (DnsUpdates)

仅限输出。您应该对域名的 DNS 记录进行一组更新，以便 Hosting 代表该域名提供安全内容。

object (Status)

仅限输出。Hosting 系统在尝试让 Hosting 能够为您的域名提供安全内容时遇到的一组错误。请解决这些问题，以确保 CustomDomain 正常运行。

enum (Type)

一个字段，可让您指定 Hosting 为您的域名创建的 SSL 证书类型。Spark 方案自定义网域只能使用 GROUPED 证书类型，而 Blaze 方案网域可以选择任何选项。

object (Certificate)

仅限输出。Hosting 对此自定义网域的域名所具备的 SSL 证书。对于新的自定义网域，这通常表示 Hosting 想要创建证书，而不是实际证书。如需了解详情，请查看 state 字段。

string

此 CustomDomain 应将流量定向到的域名。如果指定，Hosting 将使用 HTTP 301 代码响应针对此自定义网域的请求，并改为将流量路由到指定的 redirectTarget。

boolean

仅限输出。一个字段，如果为 true，则表示 Hosting 的系统正在参与攻击，以使自定义网域的状态与您的首选状态保持一致。在发出 customDomains.create 请求后首次预配 CustomDomain 时，或在 customDomains.patch 请求后创建新的 SSL 证书以与更新后的 certPreference 匹配时，最常出现这种情况。true

map (key: string, value: string)

用于额外元数据和/或过滤的标签。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

{
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}

object (DnsRecordSet)

Hosting 在检查网域时发现的一组 DNS 记录。

object (DnsRecordSet)

Hosting 需要这组 DNS 记录才能在网域上提供安全内容。

string (Timestamp format)

Hosting 上次检查自定义网域的 DNS 记录的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}

string

仅限输出。记录集相关的域名。

object (Status)

仅限输出。查询您域名的 DNS 记录时托管服务遇到错误。注意：Hosting 会忽略 NXDOMAIN 错误，因为这些错误通常只表示尚未设置域名。

object (DnsRecord)

仅限输出。域名上的记录。

{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action)
}

string

仅限输出。记录与域名相关的域名，例如foo.bar.com.。

enum (Type)

仅限输出。记录的类型，用于确定记录包含哪些数据。

string

仅限输出。记录的数据。该值的含义取决于记录类型：- A 和 AAAA：域名的 IP 地址。- CNAME：要检查记录的其他域。- TXT：与域名关联的任意文本字符串。Hosting 使用 TXT 记录来确定哪些 Firebase 项目有权代表域名执行操作。- CAA：记录的标志、标记和值，例如0 issue "pki.goog"。

enum (Action)

仅限输出。指示此记录的所需操作的枚举。

{
  "type": enum (Type),
  "state": enum (CertState),
  "verification": {
    object (CertVerification)
  },
  "issues": [
    {
      object (Status)
    }
  ],
  "createTime": string,
  "expireTime": string
}

enum (Type)

仅限输出。证书的类型。

enum (CertState)

仅限输出。证书的状态。只有 CERT_ACTIVE 和 CERT_EXPIRING_SOON 状态可为域名提供 SSL 覆盖范围。如果状态为 PROPAGATING，并且 Hosting 之前具有域名的有效证书，则先前的有效证书将为域名提供 SSL 覆盖范围，直到当前证书传播。

object (CertVerification)

仅限输出。您可以添加到 DNS 记录或现有的非 Hosting 托管服务提供商的一组 ACME 验证，以允许 Hosting 先为您的域名创建 SSL 证书，然后再将流量引向托管。您可以在从旧提供商到 Hosting 的零停机过渡期间使用这些挑战。

object (Status)

仅限输出。Hosting 在尝试为您的域名创建证书时遇到的一组错误。请解决这些问题，以确保 Hosting 能与网站访问者安全通信。

string (Timestamp format)

仅限输出。证书的创建时间。对于 TEMPORARY 证书，这是 Hosting 首次为您的域名生成验证的时间。对于所有其他证书类型，该时间是实际证书的创建时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

string (Timestamp format)

仅限输出。证书的到期时间。此后，无法再使用该证书在 Hosting 和网站访问者之间提供安全通信。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

{
  "dns": {
    object (DnsUpdates)
  },
  "http": {
    object (HttpUpdate)
  }
}

object (DnsUpdates)

仅限输出。添加到 DNS 记录的 TXT 记录，用于确认您打算让 Hosting 为您的域名创建 SSL 证书。

object (HttpUpdate)

仅限输出。要添加到现有的非 Hosting 托管服务的文件，用于确认您打算让 Hosting 为您的域名创建 SSL 证书。

{
  "path": string,
  "desired": string,
  "discovered": string,
  "lastCheckTime": string,
  "checkError": {
    object (Status)
  }
}

string

仅限输出。文件的路径。

string

仅限输出。要在路径中提供的文本字符串。

string

仅限输出。Hosting 在其上次检查期间是否能够在指定路径上找到所需的文件内容。

string (Timestamp format)

仅限输出。Hosting 系统上次检查文件内容的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

object (Status)

仅限输出。上次内容检查时出错。如果为 null，则表示检查已成功完成。