资源:Domain
与后端关联的域名。
JSON 表示法 |
---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "type": enum ( |
字段 | |
---|---|
name |
标识符。网域的资源名称,例如 |
displayName |
可选。直观易懂的域名可变。上限为 63 个字符。例如 |
createTime |
仅限输出。网域的创建时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
updateTime |
仅限输出。上次更新网域的时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
type |
仅限输出。网域的类型。 |
disabled |
可选。网域是否已停用。默认值为 false。 |
serve |
可选。网域的服务行为。如果指定,则网域将传送除其后端实时内容之外的内容。 |
customDomainStatus |
仅限输出。表示 |
reconciling |
仅限输出。一个字段,如果为 true,则表示 build 具有正在进行的 LRO。 |
deleteTime |
仅限输出。删除域名的时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
purgeTime |
仅限输出。软删除网域的完全清除时间,呈现永久删除后的效果。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
labels |
可选。采用键值对形式的标签。 包含一系列 |
annotations |
可选。键值对形式的注释。 包含一系列 |
uid |
仅限输出。系统分配的唯一标识符。 |
etag |
仅限输出。服务器基于其他值计算的校验和;更新或删除时发送,以确保对预期资源完成操作。 |
类型
网域的类型。
枚举 | |
---|---|
TYPE_UNSPECIFIED |
未指定类型(不应发生此情况)。 |
DEFAULT |
App Hosting 提供的默认网域和托管式网域。这些网域是通过其父级后端自动创建的,除非删除父级后端,否则无法删除这些网域,并且无法将这些网域移动到其他后端。您可以通过 disabled 字段停用默认网域。 |
CUSTOM |
开发者拥有的自定义网域。借助自定义网域,您可以将自己拥有的网域与 App Hosting 后端相关联,并配置该网域以提供后端的内容。 |
投放行为
指示 App Hosting 是否会在网域上提供内容。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 serving_behavior 。如果已指定,则会自定义网域的服务行为。serving_behavior 只能是下列其中一项: |
|
redirect |
可选。网域的重定向行为(如果提供)。 |
重定向
指定网域的重定向行为。
JSON 表示法 |
---|
{ "uri": string, "status": string } |
字段 | |
---|---|
uri |
必需。重定向预期目的地的 URI。此 URI 将作为原始请求路径的前缀。没有架构的 URI 会被假定为 HTTPS。 |
status |
可选。要在重定向响应中使用的状态代码。必须是有效的 HTTP 3XX 状态代码。如果不存在,则默认为 302。 |
自定义域名状态
自定义网域与后端的关联状态。
JSON 表示法 |
---|
{ "hostState": enum ( |
字段 | |
---|---|
hostState |
仅限输出。跟踪系统是否检测到自定义网域在将流量正确定向到 App Hosting。 |
ownershipState |
仅限输出。根据网域的 DNS 记录跟踪是否允许后端在网域上传送内容。 |
certState |
仅限输出。跟踪网域的 SSL 证书状态。 |
requiredDnsUpdates[] |
仅限输出。列出必须向自定义网域的 DNS 添加或从中移除的记录,才能完成设置并开始投放内容。此字段在初始配置过程中显示。如果上述一项或多项状态不是 *_ACTIVE,则还会在初始配置完成后显示,这表示网域的 DNS 记录处于错误状态。 |
issues[] |
仅限输出。网域配置问题列表。允许用户自行纠正 DNS 记录问题。 |
主机状态
您网域的主机状态。通过检查与您的网域关联的每个 IP 地址,查看主机状态是否通过 App Hosting 源的相应分片传送,确定主机状态。
枚举 | |
---|---|
HOST_STATE_UNSPECIFIED |
您的自定义网域的主机状态未指定。如果未指定,消息无效。 |
HOST_UNHOSTED |
您的自定义网域未与任何 IP 地址关联。 |
HOST_UNREACHABLE |
无法访问您的自定义网域。应用托管服务的用于查找您网域的 IP 地址的 DNS 查询出现错误。如需了解详情,请查看 CustomDomainStatus 的 issues 字段。 |
HOST_NON_FAH |
您的网域只有 IP 地址最终不会解析为 App Hosting。 |
HOST_CONFLICT |
您的网域的 IP 地址可解析为 App Hosting 和其他服务。为确保结果的一致性,请移除与非应用托管服务相关的 A 和 AAAA 记录。 |
HOST_WRONG_SHARD |
您网域的 IP 地址解析为 App Hosting 的错误区域和/或复制分片。 |
HOST_ACTIVE |
针对您的网域的所有请求均由 App Hosting 通过您网域的已分配分片处理。如果自定义网域的 OwnershipState 也是 OWNERSHIP_ACTIVE ,则 App Hosting 会针对网域的请求提供其后端的内容。 |
所有权状态
您的自定义网域的所有权状态。
枚举 | |
---|---|
OWNERSHIP_STATE_UNSPECIFIED |
您的自定义网域的所有权状态未指定。绝不应出现这种情况。 |
OWNERSHIP_MISSING |
您的自定义网域的网域没有与应用托管相关的所有权记录;没有后端有权在此来源分片中的网域上提供服务。 |
OWNERSHIP_UNREACHABLE |
无法访问您的自定义网域。应用托管服务的用于查找您的网域所有权记录的 DNS 查询导致了错误。如需了解详情,请查看 CustomDomainStatus 的 issues 字段。 |
OWNERSHIP_MISMATCH |
您的自定义网域归其他 App Hosting 自定义网域所有。移除有冲突的记录,并将其替换为您当前的自定义域名的记录。 |
OWNERSHIP_CONFLICT |
您的自定义网域存在相互冲突的 TXT 记录,而该记录表明了您当前的自定义网域(一个或多个其他网域)拥有所有权。移除不相关的所有权记录,以授予当前自定义网域的所有权。 |
OWNERSHIP_PENDING |
您的自定义网域的 DNS 记录已正确配置。App Hosting 会在 24 小时内将您的域名所有权转移至此自定义域名。 |
OWNERSHIP_ACTIVE |
您的自定义网域拥有其网域。 |
CertState
App Hosting 针对您的域名的 SSL 证书的状态。这可以表示实际证书的状态,对于新的自定义网域,可以表示 App Hosting 正在进行的证书创建尝试。
枚举 | |
---|---|
CERT_STATE_UNSPECIFIED |
证书的状态未指定。如果未指定,消息无效。 |
CERT_PREPARING |
每个证书的初始状态表示 App Hosting 在向证书授权机构发出请求之前创建证书的意图。 |
CERT_VALIDATING |
App Hosting 正在验证域名的 DNS 记录是否处于允许代表其创建证书的状态。 |
CERT_PROPAGATING |
该证书是最近创建的,需要一些时间在 App Hosting 的负载平衡器中传播。 |
CERT_ACTIVE |
该证书处于有效状态,为其所代表的域名提供安全连接。 |
CERT_EXPIRING_SOON |
此证书即将过期,其中的所有域名都将获得新证书。 |
CERT_EXPIRED |
证书已过期。App Hosting 无法再通过您的域名提供安全内容。 |
DNS 更新
一组 DNS 记录更新,您应进行这些更改,以允许 App Hosting 提供安全内容以响应针对您网域的请求。这些更新会显示您网域及相关子网域的当前状态DNS 记录(App Hosting 上次查询 DNS 记录的时间),以及 App Hosting 需要查看的一组所需记录,才能使自定义网域完全生效。
JSON 表示法 |
---|
{ "domainName": string, "discovered": [ { object ( |
字段 | |
---|---|
domainName |
仅限输出。DNS 更新相关的域名。 |
discovered[] |
仅限输出。App Hosting 在检查网域时发现的一组 DNS 记录。 |
desired[] |
仅限输出。App Hosting 为了在网域上提供安全内容而需要的这组 DNS 记录。 |
checkTime |
仅限输出。App Hosting 上次检查自定义网域的 DNS 记录的时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
DnsRecordSet
与 App Hosting 中自定义网域的设置和维护相关的一组 DNS 记录。
JSON 表示法 |
---|
{ "domainName": string, "checkError": { object ( |
字段 | |
---|---|
domainName |
仅限输出。记录集相关的域名。 |
checkError |
仅限输出。查询您网域的 DNS 记录时 App Hosting 服务遇到错误。注意:App Hosting 会忽略 |
records[] |
仅限输出。域名上的记录。 |
DNSRecord
表示网域的 DNS 记录。
DNS 记录是资源记录,用于定义系统和服务在处理网域请求时应采取的行为。例如,如果您将 A
记录添加到您网域的 DNS 记录,即表示您告知其他系统(例如用户的网络浏览器)联系这些 IPv4 地址,以检索与您的网域相关的资源(例如 App Hosting 文件)。
JSON 表示法 |
---|
{ "domainName": string, "type": enum ( |
字段 | |
---|---|
domainName |
仅限输出。记录所属的网域,例如 |
type |
仅限输出。记录的类型,用于确定记录包含哪些数据。 |
rdata |
仅限输出。记录的数据。该值的含义取决于记录类型:- A 和 AAAA:网域的 IP 地址。- CNAME:要检查记录的其他域。- TXT:与域关联的任意文本字符串。App Hosting 使用 TXT 记录来确定哪些 Firebase 项目有权代表网域执行操作。- CAA:记录的标志、标记和值,例如 |
requiredAction |
仅限输出。指示此记录的所需操作的枚举。当记录属于 |
relevantState[] |
仅限输出。指示此 DNS 记录适用的状态的枚举。通过 |
类型
DNS 记录的类型,包括 A
、TXT
、AAAA
和 CAA
。
枚举 | |
---|---|
TYPE_UNSPECIFIED |
未指定记录的类型。如果未指定,消息无效。 |
A |
A 记录,如 RFC 1035 中所定义。A 记录用于确定网域将流量定向到哪些 IPv4 地址。 |
CNAME |
CNAME 记录(如 RFC 1035 中所定义)。CNAME (即规范名称)记录可将网域映射到其他规范网域。如果存在 CNAME 记录,则它应该是网域中唯一的记录。 |
TXT |
TXT 记录(如 RFC 1035 中所定义)。TXT 记录用于保存网域上的任意文本数据。Hosting 使用 TXT 记录来确定哪个 Firebase 项目有权对网域执行操作。 |
AAAA |
AAAA 记录(如 RFC 3596 AAAA 记录定义)决定了网域将流量定向到哪个 IPv6 地址。 |
CAA |
CAA 记录,如 RFC 6844 中所定义。CAA(证书授权机构授权)记录决定了哪些证书授权机构(SSL 证书创建组织)有权为网域创建证书。App Hosting 使用 CAA 记录级联。 CAA 记录是可选的。如果网域及其父级没有 CAA 记录,则所有 CA 都有权代表该网域创建证书。一般来说,只有在为了解除阻止创建 SSL 证书而需要修改 CAA 记录时,App Hosting 才会要求您修改。 |
操作
配置要用于 App Hosting 的网域时,您应对此 DNS 记录执行的操作类型。
枚举 | |
---|---|
NONE |
您无需执行任何操作。 |
ADD |
将此记录添加到您的 DNS 记录中。 |
REMOVE |
从您的 DNS 记录中移除此记录。 |
自定义域名状态
与自定义网域的正常运行相关的一组状态。
枚举 | |
---|---|
CUSTOM_DOMAIN_STATE_UNSPECIFIED |
如果未指定,此消息无效。 |
HOST_STATE |
自定义网域的主机状态。 |
OWNERSHIP_STATE |
自定义网域的所有权状态。 |
CERT_STATE |
自定义网域的证书状态。 |
方法 |
|
---|---|
|
将新网域关联到后端。 |
|
删除单个网域。 |
|
获取网域的相关信息。 |
|
列出后端的网域。 |
|
更新单个网域的信息。 |