GetBrowserInstanceGroup - 查询云浏览器组详情

更新时间:
复制 MD 格式

查询指定云浏览器组的配置、状态和授权统计。

接口说明

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

前置条件

已取得当前账号下的云浏览器组标识。可先调用 ListBrowserInstanceGroup 获取标识。

返回内容

返回浏览器组当前配置、状态及授权统计。详情中的书签和网站访问列表最多各返回前 20 条;完整列表分别通过 ListBrowserBookmarks 和 ListBrowserRestrictedURLs 查询。

后续操作

本接口只查询配置,不修改资源。读取返回状态后,再执行与该状态相符的连接或管理操作。

示例说明

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

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

BrowserInstanceGroupId

string

否

云浏览器组标识,必填。请填写当前账号下已创建的浏览器组标识。

big-0c7loey7fzjq****

返回参数

名称

类型

描述

示例值

object

查询结果。

BrowserInstanceGroupModel

object

浏览器组详情。

AuthNotificationEnabled

boolean

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

true

AuthorizedUserInfo

object

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

TotalCount

integer

已授权的用户总数。

0

TotalUserGroupCount

integer

已授权的用户组总数。

0

BizRegionId

string

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

cn-hangzhou

BrowserConfig

object

浏览器当前配置。

Bookmarks

array<object>

浏览器书签列表。详情最多返回前 20 条;查询完整书签列表请调用 ListBrowserBookmarks。

object

一条浏览器书签配置。

BookmarkFolder

string

书签所在文件夹。

工作门户

BookmarkId

string

书签标识。

bm-12345

BookmarkName

string

书签名称。

阿里云官网

BookmarkURL

string

书签 URL 地址。

https://www.aliyun.com

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-ddTHH:mm:ss.SSSXXX,包含毫秒和时区偏移。示例中的 +00:00 表示 UTC 零时区。

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

Homepage

string

浏览器组首页地址。

https://www.aliyun.com

ImageId

string

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

imgc-070qhs8oeju4****

InstanceType

string

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

appstreaming.general.basic

MaxAmount

integer

MAU 场景配置的最大实例数。

100

Network

object

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

AccessRestriction

string

网站访问限制模式。

  • ALLOW_ALL:允许所有域名。

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

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

枚举值:

  • ALLOW_ALL :

    允许所有域名

  • ALLOW_LIST :

    仅允许名单内的网站

ALLOW_ALL

OfficeSiteId

string

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

cn-hangzhou+dir-843734****

RestrictedURLs

array<object>

网站访问限制列表。详情最多返回前 20 条;查询完整列表请调用 ListBrowserRestrictedURLs。

object

一条允许访问的网址配置。

RestrictedURLId

string

网站访问限制条目标识。

ru-12345

URL

string

访问限制条目中的网站地址。

aliyun.com

VSwitchIds

array

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

string

交换机标识。

vsw-bp1example

NodeInstanceType

object

节点规格信息。MAU 场景不涉及。

Cpu

string

节点 CPU 配置。MAU 场景不涉及。

-

Memory

integer

节点内存配置。MAU 场景不涉及。

-

NodePool

array<object>

节点池信息列表。MAU 场景不涉及,可返回空列表。

object

节点池信息。MAU 场景不涉及。

NodeAmount

string

节点总数。MAU 场景不涉及。

-

NodeUsed

string

已使用节点数。MAU 场景不涉及。

-

OsType

string

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

枚举值:

  • Windows :

    Windows 操作系统

Windows

Policy

object

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

AppContentProtection

string

防截屏开关。

  • on:开启防截屏。

  • off:关闭防截屏。

枚举值:

  • off :

    关闭防截屏

  • on :

    开启防截屏

on

AuthorizeAccessPolicyRules

array<object>

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

object

一条客户端来源 IP 访问规则。

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

ClipboardReadLimit

integer

入云(本地 PC 到云浏览器)剪贴板大小限制。

1024

ClipboardScope

string

剪贴板控制粒度。

  • global:统一控制。

  • grained:按文本、富文本和文件分别控制。

枚举值:

  • grained :

    按内容类型细分控制

  • global :

    统一控制

grained

ClipboardSizeUnit

string

剪贴板大小单位。

  • B:字节。

  • KB:1024 字节。

枚举值:

  • B :

    字节

  • KB :

    1024 字节

KB

ClipboardWriteLimit

integer

出云(云浏览器到本地 PC)剪贴板大小限制。

1024

FileClipboard

string

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

  • off:双向禁止。

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

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

  • readwrite:双向允许。

枚举值:

  • read :

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

  • readwrite :

    双向允许

  • write :

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

  • off :

    双向禁止

off

RichTextClipboard

string

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

  • off:双向禁止。

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

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

  • readwrite:双向允许。

枚举值:

  • read :

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

  • readwrite :

    双向允许

  • write :

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

  • off :

    双向禁止

off

RichTextClipboardLimit

integer

富文本剪贴板大小限制。

1024

RichTextClipboardReadLimit

integer

入云(本地 PC 到云浏览器)剪贴板大小限制。

1

RichTextClipboardReadSizeUnit

string

剪贴板大小单位。

  • B:字节。

  • KB:1024 字节。

枚举值:

  • B :

    字节

  • KB :

    1024 字节

KB

RichTextClipboardSizeUnit

string

剪贴板大小单位。

  • B:字节。

  • KB:1024 字节。

枚举值:

  • B :

    字节

  • KB :

    1024 字节

KB

RichTextClipboardWriteLimit

integer

出云(云浏览器到本地 PC)剪贴板大小限制。

1

RichTextClipboardWriteSizeUnit

string

剪贴板大小单位。

  • B:字节。

  • KB:1024 字节。

枚举值:

  • B :

    字节

  • KB :

    1024 字节

KB

TextClipboard

string

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

  • off:双向禁止。

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

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

  • readwrite:双向允许。

枚举值:

  • read :

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

  • readwrite :

    双向允许

  • write :

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

  • off :

    双向禁止

readwrite

TextClipboardReadLimit

integer

入云(本地 PC 到云浏览器)剪贴板大小限制。

1

TextClipboardReadSizeUnit

string

剪贴板大小单位。

  • B:字节。

  • KB:1024 字节。

枚举值:

  • B :

    字节

  • KB :

    1024 字节

KB

TextClipboardWriteLimit

integer

出云(云浏览器到本地 PC)剪贴板大小限制。

1

TextClipboardWriteSizeUnit

string

剪贴板大小单位。

  • B:字节。

  • KB:1024 字节。

枚举值:

  • B :

    字节

  • KB :

    1024 字节

KB

DisconnectKeepSession

string

断开连接后的会话保留策略。

  • customTime:按 DisconnectKeepSessionTime 指定的时长保留。

  • persistent:不按断连时长自动释放。

注意: persistent 仍受授权和其他释放策略影响。

枚举值:

  • customTime :

    按 DisconnectKeepSessionTime 指定的时长保留

  • persistent :

    不按断连时长自动释放

customTime

DisconnectKeepSessionTime

integer

当前返回的断连会话保留时长,单位为秒。仅用于查看配置,不表示创建接口支持设置该参数。

1800

FileManager

string

悬浮球文件管理器开关。

  • on:开启。

  • off:关闭。

枚举值:

  • off :

    关闭

  • on :

    开启

off

Html5FileTransfer

string

网页端文件传输策略。

  • off:禁止传输。

  • upload:仅允许上传。

  • download:仅允许下载。

  • full:允许上传和下载。

请与剪贴板策略配合配置。

枚举值:

  • download :

    仅允许下载

  • upload :

    仅允许上传

  • off :

    禁止传输

  • full :

    允许上传和下载

full

NoOperationDisconnect

string

无操作自动断连开关,取值不区分大小写。

  • on:开启。

  • off:关闭。

开启时,通过 NoOperationDisconnectTime 设置等待时长。

枚举值:

  • off :

    关闭

  • on :

    开启

on

NoOperationDisconnectTime

integer

无操作后触发断连的等待时长,单位为秒;是否启用由 NoOperationDisconnect 表示。

600

PolicyId

string

浏览器组关联的策略标识。

pg-0bf5d87epuq5****

PolicyVersion

string

策略版本。

  • DEFAULT:旧策略。

  • CENTER:中心化策略。

枚举值:

  • CENTER :

    中心化策略

  • DEFAULT :

    旧策略

CENTER

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

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

RequestId

string

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

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

示例

正常返回示例

JSON格式

{
  "BrowserInstanceGroupModel": {
    "AuthNotificationEnabled": true,
    "AuthorizedUserInfo": {
      "TotalCount": 0,
      "TotalUserGroupCount": 0
    },
    "BizRegionId": "cn-hangzhou",
    "BrowserConfig": {
      "Bookmarks": [
        {
          "BookmarkFolder": "工作门户",
          "BookmarkId": "bm-12345",
          "BookmarkName": "阿里云官网",
          "BookmarkURL": "https://www.aliyun.com"
        }
      ],
      "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",
    "MaxAmount": 100,
    "Network": {
      "AccessRestriction": "ALLOW_ALL",
      "OfficeSiteId": "cn-hangzhou+dir-843734****",
      "RestrictedURLs": [
        {
          "RestrictedURLId": "ru-12345",
          "URL": "aliyun.com"
        }
      ],
      "VSwitchIds": [
        "vsw-bp1example"
      ]
    },
    "NodeInstanceType": {
      "Cpu": "-",
      "Memory": 0
    },
    "NodePool": [
      {
        "NodeAmount": "-",
        "NodeUsed": "-"
      }
    ],
    "OsType": "Windows",
    "Policy": {
      "AppContentProtection": "on",
      "AuthorizeAccessPolicyRules": [
        {
          "CidrIp": "192.168.1.0/24",
          "Description": "办公网络访问",
          "Policy": "allow"
        }
      ],
      "ClientTypes": [
        {
          "ClientType": "windows",
          "Status": "on"
        }
      ],
      "ClipboardPolicy": {
        "Clipboard": "readwrite",
        "ClipboardReadLimit": 1024,
        "ClipboardScope": "grained",
        "ClipboardSizeUnit": "KB",
        "ClipboardWriteLimit": 1024,
        "FileClipboard": "off",
        "RichTextClipboard": "off",
        "RichTextClipboardLimit": 1024,
        "RichTextClipboardReadLimit": 1,
        "RichTextClipboardReadSizeUnit": "KB",
        "RichTextClipboardSizeUnit": "KB",
        "RichTextClipboardWriteLimit": 1,
        "RichTextClipboardWriteSizeUnit": "KB",
        "TextClipboard": "readwrite",
        "TextClipboardReadLimit": 1,
        "TextClipboardReadSizeUnit": "KB",
        "TextClipboardWriteLimit": 1,
        "TextClipboardWriteSizeUnit": "KB"
      },
      "DisconnectKeepSession": "customTime",
      "DisconnectKeepSessionTime": 1800,
      "FileManager": "off",
      "Html5FileTransfer": "full",
      "NoOperationDisconnect": "on",
      "NoOperationDisconnectTime": 600,
      "PolicyId": "pg-0bf5d87epuq5****",
      "PolicyVersion": "CENTER",
      "VideoPolicy": {
        "FrameRate": 30
      },
      "WatermarkPolicy": {
        "WatermarkSwitch": "ON",
        "WatermarkTypes": [
          "EndUserId"
        ]
      }
    },
    "Status": "PUBLISHED",
    "SubPayType": "mau",
    "SupportUserGroupMixedAuth": false,
    "Tier": "Pro",
    "Timers": [
      {
        "Interval": 15,
        "TimerType": "SESSION_TIMEOUT"
      }
    ],
    "UserGroupAuthMode": "Mixed",
    "UserLimit": {
      "UserQuota": 100
    }
  },
  "RequestId": "01A0C2ED-95F2-1A37-9FC6-4A395179****"
}

错误码

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

变更历史

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