REST Resource: sites.channels

资源:频道

Channel 表示网站的发布流。所有网站都有一个默认的 live 渠道,用于向 Firebase 提供的子网域及任何关联的自定义网域提供内容。

JSON 表示法
{
  "name": string,
  "url": string,
  "release": {
    object (Release)
  },
  "createTime": string,
  "updateTime": string,
  "retainedReleaseCount": integer,
  "labels": {
    string: string,
    ...
  },

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
字段
name

string

频道的完全限定资源名称,格式如下:

sites/SITE_ID/channels/CHANNEL_ID

url

string

仅限输出。可供查看此频道的当前版本的内容的网址。此网址是 Firebase 提供的 web.app 子网域。

您也可以在 Firebase 提供的 firebaseapp.com 子网域中查看此渠道的当前版本的内容。

如果此渠道是 Hosting 网站的 live 渠道,则您也可以在任何关联的自定义网域中查看此渠道的当前版本的内容。

release

object (Release)

仅限输出。频道的当前版本(如果有)。

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"

retainedReleaseCount

integer

要在频道上保留以用于回滚或其他目的的先前版本的数量。

必须是一个介于 1 到 100 的数字。对于新渠道,默认值为 10。

labels

map (key: string, value: string)

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

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

联合字段 expiration

expiration 只能是下列其中一项:

expireTime

string (Timestamp format)

自动删除频道的时间。

如果为 null,系统不会自动删除该频道。无论是直接设置还是通过 ttl 字段设置,此字段都会出现在输出中。

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

ttl

string (Duration format)

仅限输入。此频道的存留时间。将 expireTime 设置为请求时间之后的提供时长。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

方法

create

在指定网站中创建一个新渠道。

delete

删除指定网站的指定渠道。

get

检索指定网站的指定渠道的信息。

list

列出指定网站的渠道。

patch

更新指定网站的指定渠道的信息。