REST Resource: deployments.groups

资源:群组

与多个 OTA 配置相关联的组。

JSON 表示法
{
  "name": string,
  "enabled": boolean,
  "bypassRolloutSchedule": boolean,
  "descriptions": [
    {
      object (GroupDescription)
    }
  ],
  "defaultDescription": string,
  "production": boolean,
  "memberCount": string,
  "details": {
    object (GroupDetails)
  }
}
字段
name

string

必需。群组的名称。该参数只能包含字母、数字和下划线。

enabled

boolean

可选。是否启用该组。默认值为 false。

bypassRolloutSchedule

boolean

可选。该群组将绕过发布时间表。默认值为 false。

descriptions[]

object (GroupDescription)

可选。对此群组的说明,系统可能会向最终用户显示这些说明,告知他们为何会收到与“production”不一致的更新。

defaultDescription

string

必需。用于未明确匹配的语言区域的说明。

production

boolean

只读。指明组是否足够大,可被视为生产组。

memberCount

string (int64 format)

只读。组中当前的设备数量。

details

object (GroupDetails)

仅供输出。有关群组的更多详情。此字段只应在返回组时由服务器返回。

GroupDescription

一条经过翻译的说明。

JSON 表示法
{
  "description": string,
  "locales": [
    string
  ]
}
字段
description

string

此群组的本地化说明。请注意,系统可能会向最终用户显示此信息,以解释他们为何会收到特定更新。

locales[]

string

应针对哪些语言区域显示此说明。

GroupDetails

设备组的详细信息,包括关联的 OTA 配置。所有这些信息均为只读信息。

JSON 表示法
{
  "configs": [
    string
  ],
  "members": [
    {
      object (GroupMember)
    }
  ],
  "disabledConfigs": [
    string
  ],
  "versionTag": {
    object (VersionTag)
  }
}
字段
configs[]

string

群组的关联配置。

members[]

object (GroupMember)

此群组的成员。

disabledConfigs[]

string

组的关联已停用配置。

versionTag

object (VersionTag)

组版本。

方法

create

创建一个群组,并返回新的 Group

delete

删除 group

disable

停用定义的 groups

enable

启用定义的 groups

get

获取 group

list

列出部署的 groups

update

更新 group

updateConfigs

更新 group 下的 config