DocsICP FilingConsole
Documentation

ListBrowserInstanceGroup

Updated at:
Copy as MD
Product
My Favorites

Queries cloud browser groups and their current status by paging.

Operation description

This topic describes how to use this operation in the monthly active user (MAU) billing scenario.

Query conditions

You can filter by browser group identity, name, business region, office network, set, authorized user group, and status. Only one status value can be specified at a time.

Paging

Use PageNumber and PageSize for paging. Use the returned TotalCount to determine whether to continue querying the next page.

What to do next

To view the detailed configuration of a single browser group, invoke GetBrowserInstanceGroup with the returned identity.

Example notes

The - in the examples indicates that the field is not applicable or not returned in the current scenario. It is not an actual character string returned by the operation. Resource identities in the examples are masked. Use the actual query results in your environment.

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
PageSize

integer

No

The number of records per page.

20
PageNumber

integer

No

The page number, starting from page 1.

1
Status

array

No

Filters by browser group status.

Limit: Only one status value can be specified at a time.

string

No

The browser group status.

  • 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 :

    Published successfully.

  • FAILED :

    Publishing failed.

  • MAINTAIN_FAILED :

    Update failed.

  • EXPIRED :

    Expired.

  • MAINTAINING :

    Updating.

  • DELETING :

    Deleting.

  • UNAVAILABLE :

    Unavailable.

  • CEASED :

    Suspended due to overdue payment.

  • DEPLOYING :

    Publishing.

PUBLISHED
BrowserInstanceGroupId

string

No

The cloud browser group ID for exact match queries.

big-0c7loey7fzjq****
AppInstanceGroupSetId

string

No

The browser group set ID for exact match queries of active members in the set.

set-3jm9d0abc00example
CloudBrowserName

string

No

Performs a contains match by browser group name or ID.

Office
BizRegionId

string

No

Filters browser groups by business region.

cn-hangzhou
Tag

array<object>

No

The tag filter parameters. This parameter is not supported in customer-facing scenarios. Do not specify this parameter.

object

No

The tag filter item. Do not specify this parameter in customer-facing scenarios.

Key

string

No

The tag key. Do not specify this parameter in customer-facing scenarios.

-
Value

string

No

The tag value. Do not specify this parameter in customer-facing scenarios.

-
BrowserInstanceGroupName

string

No

The browser group name. Fuzzy match is supported.

Office
UserGroupIds

array

No

Filters by authorized user group IDs.

string

No

The authorized user group ID used for filtering.

ug-12345
ExcludedUserGroupIds

array

No

Excludes browser groups that are authorized to the specified user groups.

string

No

The authorized user group ID used for exclusion.

ug-12345
OfficeSiteId

string

No

Filters browser groups by office network ID.

cn-hangzhou+dir-843734****
Tier

string

No

Filters by version of the browser.

  • Basic: Basic Edition.

  • Pro: Premium Edition.

Use Pro to query MAU browser groups.

Valid values:

  • Basic :

    Basic Edition.

  • Pro :

    Premium Edition.

Pro

Response elements

Element

Type

Description

Example

object

The query result.

BrowserInstanceGroupModels

array<object>

The list of browser groups on the current page.

array<object>

The browser group information.

AuthNotificationEnabled

boolean

Indicates whether authorization and deauthorization notification emails are enabled. true indicates enabled. false indicates disabled.

true
AuthorizedUserInfo

object

The authorized user statistics of 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 is located.

cn-hangzhou
BrowserConfig

object

The current browser configuration.

BrowserParam

string

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

--incognito
CookiesSync

string

The cookie synchronization configuration. The string true indicates enabled. false indicates 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 group.

big-0c7loey7fzjq****
BrowserInstanceGroupName

string

The name of the cloud browser group.

OfficeBrowser
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 pay-as-you-go.

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 for access. The resource identifiers in the example must be replaced.

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. Not applicable in MAU scenarios.

-
PeriodEndTime

string

The end time of the plan period. Not applicable in MAU scenarios. This field is not returned.

-
PeriodStartTime

string

The start time of the plan period. Not applicable in MAU scenarios. This field is not returned.

-
TotalDuration

integer

The total duration of the plan, in seconds. Not applicable in MAU scenarios.

-
UsedDuration

integer

The used duration of the plan, in seconds. Not applicable in MAU scenarios.

-
ExpiredTime

string

The expiration time of the browser group. Not applicable in MAU scenarios. This field is not returned.

-
GmtCreate

string

The creation time of the browser group.

The time is in RFC 3339 format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX, which includes milliseconds and a time zone offset. The actual POP response uses the UTC offset +00:00.

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
Network

object

The workspace 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 ID of the workspace to which the browser group belongs.

cn-hangzhou+dir-843734****
VSwitchIds

array

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

string

The vSwitch ID.

vsw-bp1example
OsType

string

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

Valid values:

  • Linux :

    Linux operating system.

  • Windows :

    Windows operating system.

  • Android :

    Android operating system.

Windows
Policy

object

The policy configuration returned for the browser group. 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 is disabled.

  • on :

    Screenshot protection is enabled.

on
AuthorizeAccessPolicyRules

array<object>

The client access IP address whitelist rules.

object

A configuration entry in the list.

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: Access is allowed.

  • deny: Access is denied.

Valid values:

  • allow :

    Access is allowed.

  • deny :

    Access is denied.

allow
ClientTypes

array<object>

The client access control configuration list.

object

A configuration entry in the list.

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 this 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 disabled.

  • 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 disabled.

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

  • ON: Watermark is enabled.

  • OFF: Watermark is disabled.

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

Valid values:

  • OFF :

    Watermark is disabled.

  • ON :

    Watermark is enabled.

ON
WatermarkTypes

array

The list of watermark content types. Valid values:

  • EndUserId: The user identifier.

  • InstanceGroupId: The delivery group identifier.

  • ClientTime: The current time on the client.

Use watermark types that are supported by the browser and client.

string

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

Valid values:

  • EndUserId :

    user identifier.

  • InstanceGroupId :

    delivery group identifier.

  • ClientTime :

    current time on the client.

EndUserId
Status

string

The browser group status.

  • 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 :

    Published successfully.

  • FAILED :

    Publishing 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-payment 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
Tags

array<object>

The list of resource tags.

object

The resource tag information.

Key

string

The tag key.

usage
Value

string

The tag value.

office
Tier

string

The version of the browser. Valid values:

  • Basic: Basic Edition.

  • Pro: Premium Edition.

In MAU scenarios, the value is Pro.

Valid values:

  • Basic :

    Basic Edition.

  • Pro :

    Premium Edition.

Pro
Timers

array<object>

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

object

A configuration entry in the list.

Interval

integer

The session retention duration after disconnection, in minutes. -1 indicates that the session is not unbound due to this timeout. The session 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. 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 user quota.

100
PageNumber

integer

The current page number.

1
PageSize

integer

The number of entries per page.

20
RequestId

string

The request ID, which is used for troubleshooting.

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

integer

The total number of browser groups that match the filter conditions.

5

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.