ListBrowserInstanceGroup - 查询云浏览器组列表

更新时间:
复制 MD 格式

分页查询云浏览器组及其当前状态。

接口说明

本文说明按月活跃用户(MAU)计费场景的查询用法。

查询条件

可按浏览器组标识、名称、业务地域、办公网络、集合、授权用户组和状态筛选。状态筛选一次只能指定一个值。

分页

使用 PageNumber 和 PageSize 分页查询。结合返回的 TotalCount 判断是否继续查询下一页。

后续操作

需要查看单个浏览器组的详细配置时,使用返回的标识调用 GetBrowserInstanceGroup。

示例说明

示例中的 - 仅表示当前场景不适用或不返回该字段,不是接口实际返回的字符串。普通资源标识示例已脱敏,使用时请以实际查询结果为准。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

PageSize

integer

否

每页返回的记录数。

20

PageNumber

integer

否

查询页码,从第 1 页开始。

1

Status

array

否

按浏览器组状态筛选。

限制: 一次只能传入一个状态。

string

否

浏览器组状态。

  • DEPLOYING:发布中。

  • PUBLISHED:发布成功。

  • FAILED:发布失败。

  • EXPIRED:已过期。

  • CEASED:欠费停服。

  • MAINTAINING:更新中。

  • MAINTAIN_FAILED:更新失败。

  • DELETING:删除中。

  • UNAVAILABLE:不可用。

枚举值:

  • PUBLISHED :

    发布成功

  • FAILED :

    发布失败

  • MAINTAIN_FAILED :

    更新失败

  • EXPIRED :

    已过期

  • MAINTAINING :

    更新中

  • DELETING :

    删除中

  • UNAVAILABLE :

    不可用

  • CEASED :

    欠费停服

  • DEPLOYING :

    发布中

PUBLISHED

BrowserInstanceGroupId

string

否

云浏览器组标识,用于精确查询。

big-0c7loey7fzjq****

AppInstanceGroupSetId

string

否

浏览器组集合标识,用于精确查询该集合的有效成员。

set-3jm9d0abc00example

CloudBrowserName

string

否

按浏览器组名称或标识进行包含匹配。

办公

BizRegionId

string

否

按业务地域筛选浏览器组。

cn-hangzhou

Tag

array<object>

否

标签筛选参数。当前对客场景暂不支持,请勿填写。

object

否

标签筛选项。当前对客场景不填写。

Key

string

否

标签键。当前对客场景不填写。

-

Value

string

否

标签值。当前对客场景不填写。

-

BrowserInstanceGroupName

string

否

浏览器组名称,支持模糊匹配。

办公

UserGroupIds

array

否

按已授权的用户组标识筛选。

string

否

用于筛选的授权用户组标识。

ug-12345

ExcludedUserGroupIds

array

否

排除已授权给指定用户组的浏览器组。

string

否

用于排除的授权用户组标识。

ug-12345

OfficeSiteId

string

否

按所属办公网络标识筛选浏览器组。

cn-hangzhou+dir-843734****

Tier

string

否

按浏览器版本筛选。

  • Basic:基础版。

  • Pro:高级版。

查询 MAU 浏览器组时使用 Pro。

枚举值:

  • Basic :

    基础版

  • Pro :

    高级版

Pro

返回参数

名称

类型

描述

示例值

object

查询结果。

BrowserInstanceGroupModels

array<object>

当前页的浏览器组列表。

array<object>

浏览器组信息。

AuthNotificationEnabled

boolean

是否启用授权及解除授权通知邮件。true 表示启用,false 表示关闭。

true

AuthorizedUserInfo

object

浏览器组的授权用户统计。

TotalCount

integer

已授权的用户总数。

0

TotalUserGroupCount

integer

已授权的用户组总数。

0

BizRegionId

string

浏览器组所在的业务地域。

cn-hangzhou

BrowserConfig

object

浏览器当前配置。

BrowserParam

string

浏览器启动参数,例如 --incognito 表示隐身窗口。

--incognito

CookiesSync

string

Cookie 同步配置。字符串 true 表示开启,false 表示关闭。

枚举值:

  • true :

    开启同步

  • false :

    关闭同步

true

Homepage

string

浏览器启动时打开的首页地址。

https://www.aliyun.com

BrowserInstanceGroupId

string

云浏览器组标识。

big-0c7loey7fzjq****

BrowserInstanceGroupName

string

云浏览器组名称。

办公浏览器

BrowserInstanceGroupSetId

string

所属浏览器组集合的标识。

set-3jm9d0abc00example

ChargeType

string

付费类型。MAU 场景返回 PostPaid,表示后付费。

枚举值:

  • PostPaid :

    后付费

  • PrePaid :

    预付费

PostPaid

DefaultAccessUrl

string

浏览器组的默认访问地址。请使用接口实际返回的地址访问;示例中的资源标识需要替换。

https://wuying.aliyun.com/integration?appId=browser&appInstanceGroupId=big-0c7loey7fzjq****

Duration

object

套餐时长信息。MAU 场景不涉及套餐时长,可返回空对象。

CurrentPayStage

string

套餐当前支付阶段。MAU 场景不涉及。

-

PeriodEndTime

string

套餐周期结束时间。MAU 场景不涉及,不返回该字段。

-

PeriodStartTime

string

套餐周期开始时间。MAU 场景不涉及,不返回该字段。

-

TotalDuration

integer

套餐总时长,单位为秒。MAU 场景不涉及。

-

UsedDuration

integer

套餐已使用时长,单位为秒。MAU 场景不涉及。

-

ExpiredTime

string

浏览器组过期时间。MAU 场景不涉及,不返回该字段。

-

GmtCreate

string

浏览器组创建时间。

使用 RFC 3339 格式,具体为 yyyy-MM-dd'T'HH:mm:ss.SSSXXX,包含毫秒和时区偏移;实际 POP 返回使用 UTC 偏移 +00:00。

2026-09-21T07:00:39.000+00:00

Homepage

string

浏览器组首页地址。

https://www.aliyun.com

ImageId

string

浏览器组使用的镜像标识。

imgc-070qhs8oeju4****

InstanceType

string

浏览器组使用的实例规格。

appstreaming.general.basic

Network

object

办公网络及网站访问限制配置。

AccessRestriction

string

网站访问限制模式。

  • ALLOW_ALL:允许所有域名。

  • ALLOW_LIST:仅允许名单内的网站。

返回值反映该浏览器组现有配置。

枚举值:

  • ALLOW_ALL :

    允许所有域名

  • ALLOW_LIST :

    仅允许名单内的网站

ALLOW_ALL

OfficeSiteId

string

浏览器组所属的办公网络标识。

cn-hangzhou+dir-843734****

VSwitchIds

array

浏览器组使用的交换机标识列表,供已配置定制网络的场景查看。

string

交换机标识。

vsw-bp1example

OsType

string

浏览器组的操作系统类型。当前 MAU 产品场景使用 Windows。

枚举值:

  • Linux :

    Linux 操作系统

  • Windows :

    Windows 操作系统

  • Android :

    安卓操作系统

Windows

Policy

object

浏览器组返回的策略配置。策略字段用于查看现有设置,不代表对应创建参数均可配置。

AppContentProtection

string

防截屏开关。

  • on:开启防截屏。

  • off:关闭防截屏。

枚举值:

  • off :

    关闭防截屏

  • on :

    开启防截屏

on

AuthorizeAccessPolicyRules

array<object>

客户端访问 IP 白名单规则。

object

列表中的一项配置。

CidrIp

string

允许访问的客户端来源网段。

192.168.1.0/24

Description

string

客户端访问规则的说明。

办公网络访问

Policy

string

客户端访问规则的动作。

  • allow:允许访问。

  • deny:拒绝访问。

枚举值:

  • allow :

    允许访问

  • deny :

    拒绝访问

allow

ClientTypes

array<object>

客户端访问控制配置列表。

object

列表中的一项配置。

ClientType

string

客户端类型。

  • windows:Windows 客户端。

  • macos:macOS 客户端。

  • html5:Web 客户端。

  • linux:Linux 客户端。

  • android:Android 客户端。

  • ios:iOS 客户端。

本字段反映已有访问配置,不代表当前产品开放所有客户端。

枚举值:

  • html5 :

    Web 客户端

  • linux :

    Linux 客户端

  • android :

    Android 客户端

  • windows :

    Windows 客户端

  • ios :

    iOS 客户端

  • macos :

    macOS 客户端

windows

Status

string

该客户端类型的访问策略开关。

  • on:允许该类客户端访问。

  • off:禁止该类客户端访问。

枚举值:

  • off :

    禁止该类客户端访问

  • on :

    允许该类客户端访问

on

ClipboardPolicy

object

设置剪贴板传输方向、内容类型和大小限制。read 表示本地 PC 到云浏览器,write 表示云浏览器到本地 PC。

Clipboard

string

剪贴板传输方向,取值不区分大小写。

  • off:双向禁止。

  • read:允许本地 PC 向云浏览器复制粘贴。

  • write:允许云浏览器向本地 PC 复制粘贴。

  • readwrite:双向允许。

枚举值:

  • read :

    允许本地 PC 向云浏览器复制粘贴

  • readwrite :

    双向允许

  • write :

    允许云浏览器向本地 PC 复制粘贴

  • off :

    双向禁止

readwrite

VideoPolicy

object

浏览器会话的视频显示策略。

FrameRate

integer

浏览器会话的画面帧率。

30

WatermarkPolicy

object

浏览器会话的水印显示配置。

WatermarkSwitch

string

水印开关,取值不区分大小写。

  • ON:开启水印。

  • OFF:关闭水印。

关闭时不使用水印内容类型列表。

枚举值:

  • OFF :

    关闭水印

  • ON :

    开启水印

ON

WatermarkTypes

array

水印内容类型列表。

  • EndUserId:用户标识。

  • InstanceGroupId:交付组标识。

  • ClientTime:客户端当前时间。

请使用浏览器及客户端支持的水印类型。

string

水印内容类型。EndUserId 表示用户标识,InstanceGroupId 表示交付组标识,ClientTime 表示客户端当前时间。

枚举值:

  • EndUserId :

    用户标识

  • InstanceGroupId :

    交付组标识

  • ClientTime :

    客户端当前时间

EndUserId

Status

string

浏览器组状态。

  • DEPLOYING:发布中。

  • PUBLISHED:发布成功。

  • FAILED:发布失败。

  • EXPIRED:已过期。

  • CEASED:欠费停服。

  • MAINTAINING:更新中。

  • MAINTAIN_FAILED:更新失败。

  • DELETING:删除中。

  • UNAVAILABLE:不可用。

枚举值:

  • PUBLISHED :

    发布成功

  • FAILED :

    发布失败

  • MAINTAIN_FAILED :

    更新失败

  • EXPIRED :

    已过期

  • MAINTAINING :

    更新中

  • DELETING :

    删除中

  • UNAVAILABLE :

    不可用

  • CEASED :

    欠费停服

  • DEPLOYING :

    发布中

PUBLISHED

SubPayType

string

付费子类型。MAU 场景实际返回 mau,表示按月活跃用户计费。

枚举值:

  • mau :

    按月活跃用户计费

  • MonthPackage :

    按月时长包

  • Duration :

    按时长计费

  • PostPaid :

    后付费

  • PrePaid :

    预付费

mau

SupportUserGroupMixedAuth

boolean

是否支持用户和用户组混合授权。true 表示支持,false 表示不支持;应结合当前授权模式判断。

false

Tags

array<object>

返回的资源标签列表。

object

资源标签信息。

Key

string

标签键。

usage

Value

string

标签值。

office

Tier

string

浏览器版本。

  • Basic:基础版。

  • Pro:高级版。

MAU 场景为 Pro。

枚举值:

  • Basic :

    基础版

  • Pro :

    高级版

Pro

Timers

array<object>

当前返回的会话定时配置,用于查看生效设置,不表示创建接口支持设置该参数。

object

列表中的一项配置。

Interval

integer

断开连接后的会话保留时长,单位为分钟。-1 表示不因该时长超时解绑,仍受授权和其他会话释放策略影响。

15

TimerType

string

定时配置类型。SESSION_TIMEOUT 表示断开连接后的会话保留时长。

枚举值:

  • SESSION_TIMEOUT :

    断开连接后的会话保留时长

SESSION_TIMEOUT

UserGroupAuthMode

string

当前授权模式。

  • Mixed:用户和用户组混合授权。

  • User:用户授权。

  • UserGroup:用户组授权。

枚举值:

  • User :

    用户授权

  • Mixed :

    用户和用户组混合授权

  • UserGroup :

    用户组授权

Mixed

UserLimit

object

用户配额信息。

UserQuota

integer

用户配额数量。

100

PageNumber

integer

当前页码。

1

PageSize

integer

每页记录数。

20

RequestId

string

本次请求的标识,用于排查问题。

01A0C2ED-95F2-1A37-9FC6-4A395179****

TotalCount

integer

符合筛选条件的浏览器组总数。

5

示例

正常返回示例

JSON格式

{
  "BrowserInstanceGroupModels": [
    {
      "AuthNotificationEnabled": true,
      "AuthorizedUserInfo": {
        "TotalCount": 0,
        "TotalUserGroupCount": 0
      },
      "BizRegionId": "cn-hangzhou",
      "BrowserConfig": {
        "BrowserParam": "--incognito",
        "CookiesSync": "true",
        "Homepage": "https://www.aliyun.com"
      },
      "BrowserInstanceGroupId": "big-0c7loey7fzjq****",
      "BrowserInstanceGroupName": "办公浏览器",
      "BrowserInstanceGroupSetId": "set-3jm9d0abc00example",
      "ChargeType": "PostPaid",
      "DefaultAccessUrl": "https://wuying.aliyun.com/integration?appId=browser&appInstanceGroupId=big-0c7loey7fzjq****",
      "Duration": {
        "CurrentPayStage": "-",
        "PeriodEndTime": "-",
        "PeriodStartTime": "-",
        "TotalDuration": 0,
        "UsedDuration": 0
      },
      "ExpiredTime": "-",
      "GmtCreate": "2026-09-21T07:00:39.000+00:00",
      "Homepage": "https://www.aliyun.com",
      "ImageId": "imgc-070qhs8oeju4****",
      "InstanceType": "appstreaming.general.basic",
      "Network": {
        "AccessRestriction": "ALLOW_ALL",
        "OfficeSiteId": "cn-hangzhou+dir-843734****",
        "VSwitchIds": [
          "vsw-bp1example"
        ]
      },
      "OsType": "Windows",
      "Policy": {
        "AppContentProtection": "on",
        "AuthorizeAccessPolicyRules": [
          {
            "CidrIp": "192.168.1.0/24",
            "Description": "办公网络访问",
            "Policy": "allow"
          }
        ],
        "ClientTypes": [
          {
            "ClientType": "windows",
            "Status": "on"
          }
        ],
        "ClipboardPolicy": {
          "Clipboard": "readwrite"
        },
        "VideoPolicy": {
          "FrameRate": 30
        },
        "WatermarkPolicy": {
          "WatermarkSwitch": "ON",
          "WatermarkTypes": [
            "EndUserId"
          ]
        }
      },
      "Status": "PUBLISHED",
      "SubPayType": "mau",
      "SupportUserGroupMixedAuth": false,
      "Tags": [
        {
          "Key": "usage",
          "Value": "office"
        }
      ],
      "Tier": "Pro",
      "Timers": [
        {
          "Interval": 15,
          "TimerType": "SESSION_TIMEOUT"
        }
      ],
      "UserGroupAuthMode": "Mixed",
      "UserLimit": {
        "UserQuota": 100
      }
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "RequestId": "01A0C2ED-95F2-1A37-9FC6-4A395179****",
  "TotalCount": 5
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。