DocsICP FilingConsole
Documentation

GetBrowserInstanceGroup

Updated at:
Copy as MD
Product
My Favorites

Queries the configuration, status, and authorization statistics of a specified cloud browser group.

Operation description

This topic describes the query usage for the monthly active user (MAU) billing scenario.

Before you begin

Obtain the cloud browser group ID under the current account. Call ListBrowserInstanceGroup to retrieve the ID.

Response

The response includes the current configuration, status, and authorization statistics of the browser group. The details return up to 20 bookmarks and 20 website access entries. To retrieve the complete lists, call ListBrowserBookmarks and ListBrowserRestrictedURLs.

What to do next

This operation only queries configurations and does not modify resources. After you read the returned status, perform the connection or management operation that corresponds to the status.

Example description

The - value in the examples indicates that the field is not applicable or not returned in the current scenario. It is not an actual string returned by the operation. Sample resource IDs are masked. Use the actual query results when you call this operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
BrowserInstanceGroupId

string

No

The cloud browser group ID. This parameter is required. Specify the ID of a browser group that is created under the current account.

big-0c7loey7fzjq****

Response elements

Element

Type

Description

Example

object

The query result.

BrowserInstanceGroupModel

object

The details of the browser group.

AuthNotificationEnabled

boolean

Indicates whether authorization and deauthorization notification emails are enabled. true indicates that the feature is enabled. false indicates that the feature is disabled.

true
AuthorizedUserInfo

object

The statistics of authorized users for the browser group.

TotalCount

integer

The total number of authorized users.

0
TotalUserGroupCount

integer

The total number of authorized user groups.

0
BizRegionId

string

The business region where the browser group resides.

cn-hangzhou
BrowserConfig

object

The current browser configuration.

Bookmarks

array<object>

The list of browser bookmarks. A maximum of 20 entries are returned. To query the complete bookmark list, call ListBrowserBookmarks.

object

A browser bookmark configuration.

BookmarkFolder

string

The folder in which the bookmark resides.

Work Portal
BookmarkId

string

The bookmark ID.

bm-12345
BookmarkName

string

The bookmark name.

Alibaba Cloud Official Website
BookmarkURL

string

The URL of the bookmark.

https://www.aliyun.com
BrowserParam

string

The browser startup parameters. For example, --incognito specifies the incognito window mode.

--incognito
CookiesSync

string

The cookie synchronization configuration. The string true indicates that synchronization is enabled. The string false indicates that synchronization is disabled.

Valid values:

  • true :

    Synchronization enabled.

  • false :

    Synchronization disabled.

true
Homepage

string

The homepage URL that opens when the browser starts.

https://www.aliyun.com
BrowserInstanceGroupId

string

The cloud browser group ID.

big-0c7loey7fzjq****
BrowserInstanceGroupName

string

The cloud browser group name.

Office Browser
BrowserInstanceGroupSetId

string

The ID of the browser group set to which the browser group belongs.

set-3jm9d0abc00example
ChargeType

string

The billing type. In MAU scenarios, PostPaid is returned, which indicates the pay-as-you-go billing method.

Valid values:

  • PostPaid :

    Pay-as-you-go.

  • PrePaid :

    Subscription.

PostPaid
DefaultAccessUrl

string

The default access URL of the browser group. Use the URL returned by the API to access the browser group. Replace the resource ID in the example with your actual value.

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

object

The plan duration information. In MAU scenarios, plan duration does not apply, and an empty object may be returned.

CurrentPayStage

string

The current payment stage of the plan. This field does not apply to MAU scenarios.

-
PeriodEndTime

string

The end time of the plan period. This field does not apply to MAU scenarios and is not returned.

-
PeriodStartTime

string

The start time of the plan period. This field does not apply to MAU scenarios and is not returned.

-
TotalDuration

integer

The total duration of the plan, in seconds. This field does not apply to MAU scenarios.

-
UsedDuration

integer

The used duration of the plan, in seconds. This field does not apply to MAU scenarios.

-
ExpiredTime

string

The expiration time of the browser group. This field does not apply to MAU scenarios and is not returned.

-
GmtCreate

string

The creation time of the browser group. The value is an RFC 3339 time string in the yyyy-MM-ddTHH:mm:ss.SSSXXX format, which includes milliseconds and a time zone offset. The +00:00 in the example indicates the UTC time zone.

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

string

The homepage URL of the browser group.

https://www.aliyun.com
ImageId

string

The image ID used by the browser group.

imgc-070qhs8oeju4****
InstanceType

string

The instance type used by the browser group.

appstreaming.general.basic
MaxAmount

integer

The maximum number of instances configured for the MAU scenario.

100
Network

object

The office network and website access restriction configuration.

AccessRestriction

string

The website access restriction mode.

  • ALLOW_ALL: All domain names are allowed.

  • ALLOW_LIST: Only websites in the allowlist are allowed.

The returned value reflects the current configuration of the browser group.

Valid values:

  • ALLOW_ALL :

    All domain names are allowed.

  • ALLOW_LIST :

    Only websites in the allowlist are allowed.

ALLOW_ALL
OfficeSiteId

string

The office network ID to which the browser group belongs.

cn-hangzhou+dir-843734****
RestrictedURLs

array<object>

The website access restriction list. A maximum of 20 entries are returned. To query the complete list, call ListBrowserRestrictedURLs.

object

An allowed website configuration entry.

RestrictedURLId

string

The ID of the website access restriction entry.

ru-12345
URL

string

The website URL in the access restriction entry.

aliyun.com
VSwitchIds

array

The list of vSwitch IDs used by the browser group. This is available for scenarios with custom network configurations.

string

The vSwitch ID.

vsw-bp1example
NodeInstanceType

object

The node specifications information. This field does not apply to MAU scenarios.

Cpu

string

The CPU configuration of the node. This field does not apply to MAU scenarios.

-
Memory

integer

The memory configuration of the node. This field does not apply to MAU scenarios.

-
NodePool

array<object>

The list of node pool information. In MAU scenarios, this field does not apply and an empty list may be returned.

object

The node pool information. This field does not apply to MAU scenarios.

NodeAmount

string

The total number of nodes. This field does not apply to MAU scenarios.

-
NodeUsed

string

The number of used nodes. This field does not apply to MAU scenarios.

-
OsType

string

The operating system type of the browser group. The current MAU product scenario uses Windows.

Valid values:

  • Windows :

    Windows operating system.

Windows
Policy

object

The policy configuration returned for the browser group. The policy fields are used to view existing settings and do not indicate that all corresponding creation parameters are configurable.

AppContentProtection

string

The screenshot protection switch.

  • on: Screenshot protection is enabled.

  • off: Screenshot protection is disabled.

Valid values:

  • off :

    Screenshot protection disabled.

  • on :

    Screenshot protection enabled.

on
AuthorizeAccessPolicyRules

array<object>

The client access IP address whitelist rules.

object

A client source IP access rule.

CidrIp

string

The client source CIDR block that is allowed to access the browser group.

192.168.1.0/24
Description

string

The description of the client access rule.

Office network access
Policy

string

The action of the client access rule.

  • allow: Access is allowed.

  • deny: Access is denied.

Valid values:

  • allow :

    Access allowed.

  • deny :

    Access denied.

allow
ClientTypes

array<object>

The list of client access control configurations.

object

The access switch configuration for a client type.

ClientType

string

The client type.

  • windows: Windows client.

  • macos: macOS client.

  • html5: Web client.

  • linux: Linux client.

  • android: Android client.

  • ios: iOS client.

This field reflects the existing access configuration and does not indicate that all client types are available for the current product.

Valid values:

  • html5 :

    Web client.

  • linux :

    Linux client.

  • android :

    Android client.

  • windows :

    Windows client.

  • ios :

    iOS client.

  • macos :

    macOS client.

windows
Status

string

The access policy switch for the client type.

  • on: Access from this client type is allowed.

  • off: Access from this client type is denied.

Valid values:

  • off :

    Access from this client type is denied.

  • on :

    Access from this client type is allowed.

on
ClipboardPolicy

object

The clipboard transfer direction, content type, and size limit settings. read indicates transfer from the local PC to the cloud browser. write indicates transfer from the cloud browser to the local PC.

Clipboard

string

The clipboard transfer direction. The value is case-insensitive.

  • off: Bidirectional transfer is denied.

  • read: Copy and paste from the local PC to the cloud browser is allowed.

  • write: Copy and paste from the cloud browser to the local PC is allowed.

  • readwrite: Bidirectional transfer is allowed.

Valid values:

  • read :

    Copy and paste from the local PC to the cloud browser is allowed.

  • readwrite :

    Bidirectional transfer is allowed.

  • write :

    Copy and paste from the cloud browser to the local PC is allowed.

  • off :

    Bidirectional transfer is denied.

readwrite
ClipboardReadLimit

integer

The clipboard size limit for inbound transfer (from the local PC to the cloud browser).

1024
ClipboardScope

string

The clipboard control granularity.

  • global: Unified control.

  • grained: Separate control by text, rich text, and file.

Valid values:

  • grained :

    Separate control by content type.

  • global :

    Unified control.

grained
ClipboardSizeUnit

string

The unit of the clipboard size.

  • B: bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    1024 bytes.

KB
ClipboardWriteLimit

integer

The clipboard size limit for outbound transfer (from the cloud browser to the local PC).

1024
FileClipboard

string

The clipboard transfer direction. The value is case-insensitive.

  • off: Bidirectional transfer is denied.

  • read: Copy and paste from the local PC to the cloud browser is allowed.

  • write: Copy and paste from the cloud browser to the local PC is allowed.

  • readwrite: Bidirectional transfer is allowed.

Valid values:

  • read :

    Copy and paste from the local PC to the cloud browser is allowed.

  • readwrite :

    Bidirectional transfer is allowed.

  • write :

    Copy and paste from the cloud browser to the local PC is allowed.

  • off :

    Bidirectional transfer is denied.

off
RichTextClipboard

string

The clipboard transfer direction. The value is case-insensitive.

  • off: Bidirectional transfer is denied.

  • read: Copy and paste from the local PC to the cloud browser is allowed.

  • write: Copy and paste from the cloud browser to the local PC is allowed.

  • readwrite: Bidirectional transfer is allowed.

Valid values:

  • read :

    Copy and paste from the local PC to the cloud browser is allowed.

  • readwrite :

    Bidirectional transfer is allowed.

  • write :

    Copy and paste from the cloud browser to the local PC is allowed.

  • off :

    Bidirectional transfer is denied.

off
RichTextClipboardLimit

integer

The rich text clipboard size limit.

1024
RichTextClipboardReadLimit

integer

The clipboard size limit for inbound transfer (from the local PC to the cloud browser).

1
RichTextClipboardReadSizeUnit

string

The unit of the clipboard size.

  • B: bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    1024 bytes.

KB
RichTextClipboardSizeUnit

string

The unit of the clipboard size.

  • B: bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    1024 bytes.

KB
RichTextClipboardWriteLimit

integer

The clipboard size limit for outbound transfer (from the cloud browser to the local PC).

1
RichTextClipboardWriteSizeUnit

string

The unit of the clipboard size.

  • B: bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    1024 bytes.

KB
TextClipboard

string

The clipboard transfer direction. The value is case-insensitive.

  • off: Bidirectional transfer is denied.

  • read: Copy and paste from the local PC to the cloud browser is allowed.

  • write: Copy and paste from the cloud browser to the local PC is allowed.

  • readwrite: Bidirectional transfer is allowed.

Valid values:

  • read :

    Copy and paste from the local PC to the cloud browser is allowed.

  • readwrite :

    Bidirectional transfer is allowed.

  • write :

    Copy and paste from the cloud browser to the local PC is allowed.

  • off :

    Bidirectional transfer is denied.

readwrite
TextClipboardReadLimit

integer

The clipboard size limit for inbound transfer (from the local PC to the cloud browser).

1
TextClipboardReadSizeUnit

string

The unit of the clipboard size.

  • B: bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    1024 bytes.

KB
TextClipboardWriteLimit

integer

The clipboard size limit for outbound transfer (from the cloud browser to the local PC).

1
TextClipboardWriteSizeUnit

string

The unit of the clipboard size.

  • B: bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    1024 bytes.

KB
DisconnectKeepSession

string

The data retention policy for sessions after disconnection.

  • customTime: The session is retained for the duration specified by DisconnectKeepSessionTime.

  • persistent: The session is not subject to automatic release based on disconnection duration.

Note: The persistent option is still subject to authorization and other release policies.

Valid values:

  • customTime :

    The session is retained for the duration specified by DisconnectKeepSessionTime

  • persistent :

    The session is not subject to automatic release based on disconnection duration.

customTime
DisconnectKeepSessionTime

integer

The session retention duration after disconnection. Unit: seconds. This value is for viewing the configuration only and does not indicate that this parameter can be set through the create operation.

1800
FileManager

string

The floating ball file manager switch.

  • on: Enabled.

  • off: Disabled.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

off
Html5FileTransfer

string

The file transfer policy for the web client.

  • off: Transfer is denied.

  • upload: Only upload is allowed.

  • download: Only download is allowed.

  • full: Both upload and download are allowed.

Configure this parameter together with the clipboard policy.

Valid values:

  • download :

    Only download is allowed.

  • upload :

    Only upload is allowed.

  • off :

    Transfer is denied.

  • full :

    Both upload and download are allowed.

full
NoOperationDisconnect

string

The switch for automatic disconnection upon no operation. The value is case-insensitive.

  • on: Enabled.

  • off: Disabled.

When enabled, use NoOperationDisconnectTime to set the wait duration.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

on
NoOperationDisconnectTime

integer

The wait duration before disconnection is triggered after no operation, in seconds. Whether this feature is enabled is indicated by NoOperationDisconnect.

600
PolicyId

string

The ID of the policy associated with the browser instance group.

pg-0bf5d87epuq5****
PolicyVersion

string

The policy version.

  • DEFAULT: Legacy policy.

  • CENTER: Centralized policy.

Valid values:

  • CENTER :

    Centralized policy.

  • DEFAULT :

    Legacy policy.

CENTER
VideoPolicy

object

The video display policy for browser sessions.

FrameRate

integer

The frame rate of browser sessions.

30
WatermarkPolicy

object

The watermark display configuration for browser sessions.

WatermarkSwitch

string

The watermark switch. The value is case-insensitive.

  • ON: Watermark enabled.

  • OFF: Watermark disabled.

When disabled, the watermark content type list is not used.

Valid values:

  • OFF :

    Watermark disabled.

  • ON :

    Watermark enabled.

ON
WatermarkTypes

array

The list of watermark content types.

  • EndUserId: User ID.

  • InstanceGroupId: Delivery group ID.

  • ClientTime: Current time on the client.

Use watermark types supported by the browser and client.

string

The watermark content type. EndUserId indicates the user ID, InstanceGroupId indicates the delivery group ID, and ClientTime indicates the current time on the client.

Valid values:

  • EndUserId :

    User ID.

  • InstanceGroupId :

    Delivery group ID.

  • ClientTime :

    Current time on the client.

EndUserId
Status

string

The status of the browser instance group.

  • DEPLOYING: Being deployed.

  • PUBLISHED: Deployed.

  • FAILED: Deployment failed.

  • EXPIRED: Expired.

  • CEASED: Suspended due to overdue payment.

  • MAINTAINING: Being updated.

  • MAINTAIN_FAILED: Update failed.

  • DELETING: Being deleted.

  • UNAVAILABLE: Unavailable.

Valid values:

  • PUBLISHED :

    Deployed.

  • FAILED :

    Deployment failed.

  • MAINTAIN_FAILED :

    Update failed.

  • EXPIRED :

    Expired.

  • MAINTAINING :

    Being updated.

  • DELETING :

    Being deleted.

  • UNAVAILABLE :

    Unavailable.

  • CEASED :

    Suspended due to overdue payment.

  • DEPLOYING :

    Being deployed.

PUBLISHED
SubPayType

string

The sub-billing type. In MAU scenarios, the actual returned value is mau, which indicates billing by monthly active users.

Valid values:

  • mau :

    Billing by monthly active users.

  • MonthPackage :

    Monthly duration package.

  • Duration :

    Billing by duration.

  • PostPaid :

    Pay-as-you-go.

  • PrePaid :

    Subscription.

mau
SupportUserGroupMixedAuth

boolean

Indicates whether mixed authorization of users and user groups is supported. true indicates supported, and false indicates not supported. Evaluate this value based on the current authorization mode.

false
Tier

string

The version of the browser.

  • Basic: Basic Edition.

  • Pro: Premium Edition.

In MAU scenarios, the value is Pro.

Valid values:

  • Basic :

    Basic edition.

  • Pro :

    Pro edition.

Pro
Timers

array<object>

The session timer configurations currently returned. These are for viewing the effective settings and do not indicate that the creation API supports setting this parameter.

object

A timer configuration entry.

Interval

integer

The session retention duration after disconnection, in minutes. A value of -1 indicates that the session is not unbound due to this timeout, but is still subject to authorization and other session release policies.

15
TimerType

string

The timer configuration type. SESSION_TIMEOUT indicates the session retention duration after disconnection.

Valid values:

  • SESSION_TIMEOUT :

    Session retention duration after disconnection.

SESSION_TIMEOUT
UserGroupAuthMode

string

The current authorization mode.

  • Mixed: Mixed authorization of users and user groups.

  • User: User authorization.

  • UserGroup: User group authorization.

Valid values:

  • User :

    User authorization.

  • Mixed :

    Mixed authorization of users and user groups.

  • UserGroup :

    User group authorization.

Mixed
UserLimit

object

The user quota information.

UserQuota

integer

The user quota.

100
RequestId

string

The request ID, which is used for troubleshooting.

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

Examples

Success response

JSON format

{
  "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****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.