REST Resource: projects.locations.backends

资源:后端

后端是 App Hosting 的主要资源。

JSON 表示法
{
  "name": string,
  "displayName": string,
  "servingLocality": enum (ServingLocality),
  "codebase": {
    object (Codebase)
  },
  "uri": string,
  "managedResources": [
    {
      object (ManagedResource)
    }
  ],
  "serviceAccount": string,
  "appId": string,
  "environment": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string
}
字段
name

string

标识符。后端的资源名称。

格式:

projects/{project}/locations/{locationId}/backends/{backendId}

displayName

string

可选。人类可读的名称。上限为 63 个字符。

servingLocality

enum (ServingLocality)

必需。不可变。指定 App Hosting 将如何为此后端提供内容。它将包含在单个区域 (REGIONAL_STRICT) 中,或允许使用 App Hosting 的全球复制服务基础架构 (GLOBAL_ACCESS)。

codebase

object (Codebase)

可选。如果已指定,则为与外部源代码库的连接,以监控对后端的事件驱动型更新。

uri

string

仅限输出。与后端通信的主要 URI。

managedResources[]

object (ManagedResource)

仅限输出。由此后端管理的资源列表。

serviceAccount

string

必需。用于 Cloud Build 和 Cloud Run 的服务账号的名称。应具有角色/firebaseapphosting.googleapis.com/computeRunner 或同等权限。

appId

string

可选。与后端关联的 Web 应用的 ID

environment

string

可选。后端的环境名称,用于从特定于环境的配置中加载环境变量。

reconciling

boolean

仅限输出。此字段如果为 true,则表示系统正在 LRO 期间对后端进行调整。

createTime

string (Timestamp format)

仅限输出。创建后端的时间。

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

updateTime

string (Timestamp format)

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

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

deleteTime

string (Timestamp format)

仅限输出。删除后端的时间。

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

labels

map (key: string, value: string)

可选。可用于对对象进行整理和分类的非结构化键值对映射。

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

annotations

map (key: string, value: string)

可选。非结构化键值对映射,可由外部工具设置,用于存储和任意元数据。它们不可查询,在修改对象时应保留。

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

uid

string

仅限输出。系统分配的唯一标识符。

etag

string

仅限输出。服务器基于其他值计算的校验和;更新或删除时发送,以确保对预期资源完成操作。

ServingLocality

指定 App Hosting 复制和提供后端数据的方式。

枚举
SERVING_LOCALITY_UNSPECIFIED 未指定。如果使用,将返回错误。
REGIONAL_STRICT 在此模式下,App Hosting 从您选择的父级区域提供后端的内容。App Hosting 仅在所选区域内维护数据和服务基础架构,而不会将您的数据复制到其他区域。
GLOBAL_ACCESS 在此模式下,App Hosting 从全球多个入网点 (POP) 提供后端的内容。App Hosting 将后端的配置和缓存数据复制到这些 POP,并使用全球 CDN 来进一步减少响应延迟时间。项目中由 App Hosting 维护的 Cloud 资源(例如 Cloud Run 服务、Cloud Build build 和 Artifact Registry 映像)仍仅限在后端的父区域中。CDN 缓存的响应可能会在缓存的 TTL 期间存储在 POP 中。

代码库

与外部源代码库的连接,以监控后端的事件驱动型更新。

JSON 表示法
{
  "repository": string,
  "rootDirectory": string
}
字段
repository

string

必需。连接到此后端的 Developer Connect gitRepositoryLink 的资源名称,格式为:

projects/{项目}/locations/{位置}/connections/{连接}/gitRepositoryLinks/{仓库链接}

必须通过 Firebase 控制台使用 Firebase App Hosting GitHub 应用建立 gitRepositoryLink 连接。

rootDirectory

string

可选。如果提供了 repository,则为要用作已部署 Web 应用的根目录的代码库根目录的相对目录。

代管式资源

项目上由 App Hosting 管理的外部资源。

JSON 表示法
{

  // Union field managed_resource can be only one of the following:
  "runService": {
    object (RunService)
  }
  // End of list of possible types for union field managed_resource.
}
字段

联合字段 managed_resource

managed_resource 只能是下列其中一项:

runService

object (RunService)

由 App Hosting 管理的 Cloud Run service

RunService

代管式 Cloud Run service

JSON 表示法
{
  "service": string
}
字段
service

string

可选。Cloud Run service 的名称,格式为:

projects/{项目}/locations/{位置}/services/{服务 ID}

方法

create

在给定的项目和位置中创建新后端。

delete

删除单个后端。

get

获取有关后端的信息。

getTraffic

获取有关后端流量的信息。

list

列出给定项目和位置中的后端。

patch

更新单个后端的信息。

updateTraffic

更新后端的流量。