ListBrowserInstanceGroup-阿里云帮助中心

Performs a paging query of cloud browser groups and their current statuses.

Operation description

This topic describes how paged query cloud browser groups in the monthly active user (MAU) billing scenario.

Query conditions

You can filter cloud browser groups by browser group ID, name, business region, office network, set, authorized user group, and status. You can specify only one status value at a time for status filtering.

Pagination

Use PageNumber and PageSize paged query data by page. You can determine whether paged query the next page based on the returned TotalCount.

What to do next

To view the detailed configurations of a single browser group, call GetBrowserInstanceGroup by using the returned ID.

Example notes

The hyphen (-) in the examples indicates that the field is not applicable or not returned in the current scenario, and is not an actual string returned by the API operation. The common resource IDs in the examples are desensitized. Use the actual query results when you use the API 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
PageSize	integer	No	The number of entries to return on each page.	20
PageNumber	integer	No	The page number. Pages start from page 1.	1
Status	array	No	Filters cloud browser groups by status. Limit: You can specify only one status at a time.
	string	No	The status of the browser group. Valid values: `DEPLOYING`: Deploying. `PUBLISHED`: Published. `FAILED`: Failed. `EXPIRED`: Expired. `CEASED`: Suspended due to overdue payment. `MAINTAINING`: Updating. `MAINTAIN_FAILED`: Update failed. `DELETING`: Deleting. `UNAVAILABLE`: Unavailable. Valid values: PUBLISHED : Published successfully. FAILED : Publication 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 ID of the cloud browser group. This parameter is used for exact match.	big-0c7loey7fzjq****
AppInstanceGroupSetId	string	No	The ID of the browser group set. This parameter is used to query the valid members of the set by exact match.	set-3jm9d0abc00example
CloudBrowserName	string	No	Filters cloud browser groups by name or ID based on partial match.	Office
BizRegionId	string	No	Filters cloud browser groups by business region.	cn-hangzhou
Tag	array<object>	No	The tag filtering parameter. This parameter is not supported in customer-facing scenarios. Do not specify this parameter.
	object	No	The tag filter. 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 name of the browser group. Fuzzy match is supported.	Office
UserGroupIds	array	No	Filters cloud browser groups by the IDs of authorized user groups.
	string	No	The ID of the authorized user group used for filtering.	ug-12345
ExcludedUserGroupIds	array	No	Excludes cloud browser groups that are authorized to the specified user groups.
	string	No	The ID of the authorized user group used for exclusion.	ug-12345
OfficeSiteId	string	No	Filters cloud browser groups by the ID of the office network to which they belong.	cn-hangzhou+dir-843734****
Tier	string	No	Filters cloud browser groups by browser version. Valid values: `Basic`: Basic Edition. `Pro`: Premium Edition. Use `Pro` when you query MAU browser groups. Valid values: Basic : Basic Edition. Pro : Pro Edition.	Pro

Response elements

Element	Type	Description	Example
	object	The query results.
BrowserInstanceGroupModels	array<object>	The list of browser instance groups on the current page.
	array<object>	The browser instance group information.
AuthNotificationEnabled	boolean	Specifies whether notification emails for authorization and revocation are enabled. A value of `true` indicates that the feature is enabled. 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.
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. A value of `false` indicates that synchronization is disabled. Valid values: true : Synchronization is enabled. false : Synchronization is 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 group belongs.	set-3jm9d0abc00example
ChargeType	string	The billing method. In the 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 follows the RFC 3339 standard in the `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` format, which includes milliseconds and 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 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
Network	object	The office network and website access restriction configurations.
AccessRestriction	string	The website access restriction mode. Valid values: `ALLOW_ALL`: Allows all domain names. `ALLOW_LIST`: Allows only websites in the whitelist. The returned value reflects the existing configuration of the browser instance group. Valid values: ALLOW_ALL : Allows all domain names. ALLOW_LIST : Allows only websites in the whitelist.	ALLOW_ALL
OfficeSiteId	string	The ID of the office network to which the browser instance group belongs.	cn-hangzhou+dir-843734****
VSwitchIds	array	The list of vSwitch IDs used by the browser instance group. This parameter is available for scenarios where a custom network is configured.
	string	The vSwitch ID.	vsw-bp1example
OsType	string	The operating system type of the browser instance 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 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. Valid values: `on`: Enables screen capture prevention. `off`: Disables screen capture prevention. Valid values: off : Disables screen capture prevention. on : Enables screen capture prevention.	on
AuthorizeAccessPolicyRules	array<object>	The IP address whitelist rules for client access.
	object	A configuration item 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. Valid values: `allow`: Allows access. `deny`: Denies access. Valid values: allow : Allows access. deny : Denies access.	allow
ClientTypes	array<object>	The list of client access control configurations.
	object	A configuration item in the list.
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 limit. `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 not case-sensitive. Valid values: `off`: Prohibits transfer 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`: Allows transfer in both directions. Valid values: read : Allows copy and paste from the local PC to the cloud browser. readwrite : Allows transfer in both directions. write : Allows copy and paste from the cloud browser to the local PC. off : Prohibits transfer in both directions.	readwrite
MultiScreen	string	The dual-screen switch for the cloud browser.	off
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	The watermark switch. The value is case-insensitive. Valid values: `ON`: Enables the watermark. `OFF`: Disables the watermark. If the watermark is disabled, the watermark content type list is not used. Valid values: OFF : Disables the watermark. ON : Enables the watermark.	ON
WatermarkTypes	array	The list of watermark content types. Valid values: `EndUserId`: The user identifier. `InstanceGroupId`: The delivery group identifier. `ClientTime`: The current time of the client. Use the watermark types supported by the browser and the client.
	string	The watermark content type. `EndUserId` indicates the user identifier, `InstanceGroupId` indicates the delivery group identifier, and `ClientTime` indicates the current time of the client. Valid values: EndUserId : The user identifier. InstanceGroupId : The delivery group identifier. ClientTime : The current time of the client.	EndUserId
Status	string	The status of the browser group. Valid values: `DEPLOYING`: Deploying. `PUBLISHED`: Published. `FAILED`: Failed. `EXPIRED`: Expired. `CEASED`: Suspended due to overdue payment. `MAINTAINING`: Updating. `MAINTAIN_FAILED`: Update failed. `DELETING`: Deleting. `UNAVAILABLE`: Unavailable. Valid values: PUBLISHED : Published successfully. FAILED : Publication 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 method. In the MAU scenario, `mau` is returned, which indicates billing by monthly active users. Valid values: mau : Billed by monthly active users. MonthPackage : Monthly duration package. Duration : Billed by duration. PostPaid : Pay-as-you-go. PrePaid : Subscription.	mau
SupportUserGroupMixedAuth	boolean	Indicates whether mixed authorization of users and user groups is supported. A value of `true` indicates that it is supported, and a value of `false` indicates that it is not supported. Evaluate this parameter based on the current authorization mode.	false
Tags	array<object>	The list of resource tags returned.
	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 the MAU scenario, the value is `Pro`. Valid values: Basic : Basic Edition. Pro : Pro Edition.	Pro
Timers	array<object>	The session timer configuration returned. This is used to view the effective settings and does not indicate that the create operation supports configuring this parameter.
	object	A configuration item in the list.
Interval	integer	The session retention duration after disconnection, in minutes. A value of `-1` indicates that the session is not unbound due to the timeout of this duration, but is still affected by authorization and other session release policies.	15
TimerType	string	The timer configuration type. A value of `SESSION_TIMEOUT` indicates the session retention duration after disconnection. Valid values: SESSION_TIMEOUT : The 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 number of user quotas.	100
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	20
RequestId	string	The ID of the request.	01A0C2ED-95F2-1A37-9FC6-4A395179****
TotalCount	integer	The total number of browser groups that meet 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": "OfficeBrowser",
      "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": "Office network access",
            "Policy": "allow"
          }
        ],
        "ClientTypes": [
          {
            "ClientType": "windows",
            "Status": "on"
          }
        ],
        "ClipboardPolicy": {
          "Clipboard": "readwrite"
        },
        "MultiScreen": "off",
        "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.