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 how to use the query operation in the monthly active user (MAU) billing scenario.

Before you begin

Obtain the ID of a cloud browser group within the current account. You can call ListBrowserInstanceGroup to obtain the ID.

Response content

Returns the current configuration, status, and authorization statistics of the browser group. The bookmark and website access lists in the details return up to the first 20 entries each. To query the complete lists, call ListBrowserBookmarks and ListBrowserRestrictedURLs respectively.

What to do next

This operation only queries the configuration and does not modify resources. After reading the returned status, perform connection or management operations that match the status.

Example description

In the examples, - indicates that the current scenario does not apply or the field is not returned. It is not a string actually returned by the operation. Examples of common resource IDs are masked. Use the actual query results.

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 ID of the cloud browser group. This parameter is required. Specify the ID of a browser group that is created within the current account.

big-0c7loey7fzjq****

Response elements

Element

Type

Description

Example

object

The query result.

BrowserInstanceGroupModel

object

The browser instance group details.

AuthNotificationEnabled

boolean

Specifies whether authorization and revocation notification emails are enabled. A value of true indicates that the feature is enabled, and a value of false indicates that the feature is disabled.

true
AuthorizedUserInfo

object

The statistics of authorized users for the browser instance 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 instance group is located.

cn-hangzhou
BrowserConfig

object

The current configuration of the browser.

Bookmarks

array<object>

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

object

A browser bookmark configuration.

BookmarkFolder

string

The folder where the bookmark is located.

Work portal
BookmarkId

string

The bookmark ID.

bm-12345
BookmarkName

string

The bookmark name.

Alibaba Cloud website
BookmarkURL

string

The URL of the bookmark.

https://www.aliyun.com
BrowserParam

string

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

--incognito
CookiesSync

string

The cookie synchronization configuration. A value of true indicates that synchronization is enabled, and a value of 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 ID of the cloud browser instance group.

big-0c7loey7fzjq****
BrowserInstanceGroupName

string

The name of the cloud browser instance group.

Office browser
BrowserInstanceGroupSetId

string

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

set-3jm9d0abc00example
ChargeType

string

The billing method. In the monthly active user (MAU) scenario, PostPaid is returned, which indicates pay-as-you-go.

Valid values:

  • PostPaid :

    Pay-as-you-go.

  • PrePaid :

    Subscription.

PostPaid
DefaultAccessUrl

string

The default access URL of the browser instance group. Use the actual URL returned by the API operation. Replace the resource ID in the example.

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

object

The package duration information. This parameter is not applicable to the MAU scenario and may return an empty object.

CurrentPayStage

string

The current payment stage of the package. This parameter is not applicable to the MAU scenario.

-
PeriodEndTime

string

The end time of the package cycle. This parameter is not applicable to the MAU scenario and is not returned.

-
PeriodStartTime

string

The start time of the package cycle. This parameter is not applicable to the MAU scenario and is not returned.

-
TotalDuration

integer

The total duration of the package, in seconds. This parameter is not applicable to the MAU scenario.

-
UsedDuration

integer

The used duration of the package, in seconds. This parameter is not applicable to the MAU scenario.

-
ExpiredTime

string

The expiration time of the browser instance group. This parameter is not applicable to the MAU scenario and is not returned.

-
GmtCreate

string

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

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

string

The homepage URL of the browser instance group.

https://www.aliyun.com
ImageId

string

The ID of the image used by the browser instance group.

imgc-070qhs8oeju4****
InstanceType

string

The instance type used by the browser instance group.

appstreaming.general.basic
MaxAmount

integer

The maximum number of instances configured in the MAU scenario.

100
Network

object

The office network and website access restriction configurations.

AccessRestriction

string

The website access restriction mode.

  • ALLOW_ALL: allows all domain names.

  • ALLOW_LIST: allows only websites in the list.

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

Valid values:

  • ALLOW_ALL :

    Allow all domain names.

  • ALLOW_LIST :

    Allow only websites in the list.

ALLOW_ALL
OfficeSiteId

string

The ID of the office network to which the browser instance group belongs.

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

array<object>

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

object

An allowed website URL configuration.

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 instance group. This parameter is available for scenarios where custom networks are configured.

string

The vSwitch ID.

vsw-bp1example
NodeInstanceType

object

The node specifications. This parameter is not applicable to the MAU scenario.

Cpu

string

The CPU configuration of the node. This parameter is not applicable to the MAU scenario.

-
Memory

integer

The memory configuration of the node. This parameter is not applicable to the MAU scenario.

-
NodePool

array<object>

The list of node pool information. This parameter is not applicable to the MAU scenario and may return an empty list.

object

The node pool information. This parameter is not applicable to the MAU scenario.

NodeAmount

string

The total number of nodes. This parameter is not applicable to the MAU scenario.

-
NodeUsed

string

The number of used nodes. This parameter is not applicable to the MAU scenario.

-
OsType

string

The operating system type of the browser instance group. Currently, Windows is used in the MAU scenario.

Valid values:

  • Windows :

    Windows operating system.

Windows
Policy

object

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

AppContentProtection

string

The screen capture prevention switch.

  • on: enables screen capture prevention.

  • off: disables screen capture prevention.

Valid values:

  • off :

    Disable screen capture prevention.

  • on :

    Enable screen capture prevention.

on
AuthorizeAccessPolicyRules

array<object>

The IP address whitelist rules for client access.

object

A client source IP address access rule.

CidrIp

string

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

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: allows access.

  • deny: denies access.

Valid values:

  • allow :

    Allow access.

  • deny :

    Deny access.

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. Valid values:

  • windows: Windows client.

  • macos: macOS client.

  • html5: Web client.

  • linux: Linux client.

  • android: Android client.

  • ios: iOS client.

This field reflects the existing access configurations and does not indicate that all clients are currently available for the 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. Valid values:

  • on: Allows access from this type of client.

  • off: Denies access from this type of client.

Valid values:

  • off :

    Denies access from this type of client.

  • on :

    Allows access from this type of client.

on
ClipboardPolicy

object

Sets the clipboard transfer direction, content type, and size limits. read indicates transfer from the local PC to the cloud browser, and write indicates transfer from the cloud browser to the local PC.

Clipboard

string

The clipboard transfer direction. The value is case-insensitive. Valid values:

  • off: Disabled in both directions.

  • read: Allows copy and paste from the local PC to the cloud browser.

  • write: Allows copy and paste from the cloud browser to the local PC.

  • readwrite: Enabled in both directions.

Valid values:

  • read :

    Allows copy and paste from the local PC to the cloud browser.

  • readwrite :

    Enabled in both directions.

  • write :

    Allows copy and paste from the cloud browser to the local PC.

  • off :

    Disabled in both directions.

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. Valid values:

  • global: Unified control.

  • grained: Separate control for text, rich text, and files.

Valid values:

  • grained :

    Separate control by content type.

  • global :

    Unified control.

grained
ClipboardSizeUnit

string

The clipboard size unit. Valid values:

  • 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. Valid values:

  • off: Disabled in both directions.

  • read: Allows copy and paste from the local PC to the cloud browser.

  • write: Allows copy and paste from the cloud browser to the local PC.

  • readwrite: Enabled in both directions.

Valid values:

  • read :

    Allows copy and paste from the local PC to the cloud browser.

  • readwrite :

    Enabled in both directions.

  • write :

    Allows copy and paste from the cloud browser to the local PC.

  • off :

    Disabled in both directions.

off
RichTextClipboard

string

The clipboard transfer direction. The value is case-insensitive. Valid values:

  • off: Disabled in both directions.

  • read: Allows copy and paste from the local PC to the cloud browser.

  • write: Allows copy and paste from the cloud browser to the local PC.

  • readwrite: Enabled in both directions.

Valid values:

  • read :

    Allows copy and paste from the local PC to the cloud browser.

  • readwrite :

    Enabled in both directions.

  • write :

    Allows copy and paste from the cloud browser to the local PC.

  • off :

    Disabled in both directions.

off
RichTextClipboardLimit

integer

The clipboard size limit for rich text.

1024
RichTextClipboardReadLimit

integer

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

1
RichTextClipboardReadSizeUnit

string

The clipboard size unit. Valid values:

  • B: Bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    1024 bytes.

KB
RichTextClipboardSizeUnit

string

The clipboard size unit. Valid values:

  • 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 clipboard size unit. Valid values:

  • B: Bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    1024 bytes.

KB
TextClipboard

string

The clipboard transfer direction. The value is case-insensitive. Valid values:

  • off: Disabled in both directions.

  • read: Allows copy and paste from the local PC to the cloud browser.

  • write: Allows copy and paste from the cloud browser to the local PC.

  • readwrite: Enabled in both directions.

Valid values:

  • read :

    Allows copy and paste from the local PC to the cloud browser.

  • readwrite :

    Enabled in both directions.

  • write :

    Allows copy and paste from the cloud browser to the local PC.

  • off :

    Disabled in both directions.

readwrite
TextClipboardReadLimit

integer

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

1
TextClipboardReadSizeUnit

string

The clipboard size unit. Valid values:

  • 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 clipboard size unit. Valid values:

  • B: Bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    1024 bytes.

KB
DisconnectKeepSession

string

The data retention policy after disconnection. Valid values:

  • customTime: Retains the session for the duration specified by DisconnectKeepSessionTime.

  • persistent: No automatic release based on disconnection duration.

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

Valid values:

  • customTime :

    Retains the session for the duration specified by DisconnectKeepSessionTime.

  • persistent :

    No automatic release based on disconnection duration.

customTime
DisconnectKeepSessionTime

integer

The returned retention duration for disconnected sessions, in seconds. This parameter is for viewing configurations only and does not indicate that the create operation supports setting this parameter.

1800
FileManager

string

The floating ball file manager switch. Valid values:

  • on: Enabled.

  • off: Disabled.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

off
Html5FileTransfer

string

The file transfer policy for the web client. Valid values:

  • off: Transfer disabled.

  • upload: Upload only.

  • download: Download only.

  • full: Upload and download allowed.

Configure this parameter in conjunction with the clipboard policy.

Valid values:

  • download :

    Download only.

  • upload :

    Upload only.

  • off :

    Transfer disabled.

  • full :

    Upload and download allowed.

full
MultiScreen

string

The dual-screen switch for cloud browsers.

off
NoOperationDisconnect

string

Specifies whether to automatically disconnect sessions after a period of inactivity. The value is case-insensitive. Valid values:

  • on: Enabled.

  • off: Disabled.

When enabled, use NoOperationDisconnectTime to set the idle timeout period.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

on
NoOperationDisconnectTime

integer

The idle timeout period in seconds before a session is automatically disconnected. This feature is enabled or disabled by the NoOperationDisconnect parameter.

600
PolicyId

string

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

pg-0bf5d87epuq5****
PolicyVersion

string

The policy version. Valid values:

  • 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 for browser sessions.

30
WatermarkPolicy

object

The watermark display configuration for browser sessions.

WatermarkSwitch

string

Specifies whether to enable watermarks. The value is case-insensitive. Valid values:

  • ON: Enabled.

  • OFF: Disabled.

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

Valid values:

  • OFF :

    Disabled.

  • ON :

    Enabled.

ON
WatermarkTypes

array

The list of watermark content types. Valid values:

  • EndUserId: User ID.

  • InstanceGroupId: Delivery group ID.

  • ClientTime: Current client time.

Use watermark types that are 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 client time.

Valid values:

  • EndUserId :

    User ID.

  • InstanceGroupId :

    Delivery group ID.

  • ClientTime :

    Current client time.

EndUserId
Status

string

The status of the browser instance group. Valid values:

  • DEPLOYING: Publishing.

  • PUBLISHED: Published.

  • FAILED: Publish failed.

  • EXPIRED: Expired.

  • CEASED: Suspended due to overdue payment.

  • MAINTAINING: Updating.

  • MAINTAIN_FAILED: Update failed.

  • DELETING: Deleting.

  • UNAVAILABLE: Unavailable.

Valid values:

  • PUBLISHED :

    Published.

  • FAILED :

    Publish failed.

  • MAINTAIN_FAILED :

    Update failed.

  • EXPIRED :

    Expired.

  • MAINTAINING :

    Updating.

  • DELETING :

    Deleting.

  • UNAVAILABLE :

    Unavailable.

  • CEASED :

    Suspended due to overdue payment.

  • DEPLOYING :

    Publishing.

PUBLISHED
SubPayType

string

The sub-billing type. In the MAU scenario, mau is returned, 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

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

false
Tier

string

The version of the browser. Valid values:

  • Basic: Basic Edition.

  • Pro: Premium Edition.

In the MAU scenario, the value is Pro.

Valid values:

  • Basic :

    Basic Edition.

  • Pro :

    Pro Edition.

Pro
Timers

array<object>

The session timer configurations returned in the current response. This parameter is used to view the effective settings and does not indicate that the create operation supports configuring this parameter.

object

A session timer configuration.

Interval

integer

The session retention period in minutes after disconnection. 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. A value of SESSION_TIMEOUT indicates the session retention period after disconnection.

Valid values:

  • SESSION_TIMEOUT :

    Session retention period after disconnection.

SESSION_TIMEOUT
UserGroupAuthMode

string

The current authorization mode. Valid values:

  • 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 number of user quotas.

100
RequestId

string

The ID of the request.

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

Examples

Success response

JSON format

{
  "BrowserInstanceGroupModel": {
    "AuthNotificationEnabled": true,
    "AuthorizedUserInfo": {
      "TotalCount": 0,
      "TotalUserGroupCount": 0
    },
    "BizRegionId": "cn-hangzhou",
    "BrowserConfig": {
      "Bookmarks": [
        {
          "BookmarkFolder": "Work Portal",
          "BookmarkId": "bm-12345",
          "BookmarkName": "Alibaba Cloud Official Website",
          "BookmarkURL": "https://www.aliyun.com"
        }
      ],
      "BrowserParam": "--incognito",
      "CookiesSync": "true",
      "Homepage": "https://www.aliyun.com"
    },
    "BrowserInstanceGroupId": "big-0c7loey7fzjq****",
    "BrowserInstanceGroupName": "Office Browser",
    "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": "Office network access",
          "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",
      "MultiScreen": "off",
      "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.