DocsICP FilingConsole
Documentation

CreateBrowserInstanceGroup

Updated at:
Copy as MD
Product
My Favorites

Creates a cloud browser group billed by monthly active users (MAU).

Operation description

Prerequisites

  • Prepare an available office network, image, and specifications in the target business region, and ensure that the account has the corresponding browser configurations and resource quotas.

  • Specify CloudBrowserName and BizRegionId. You must set OsType to Windows.

  • The authorized users must be created in advance and match the account type. The authorized user groups must belong to the current account and match the account type of the office network.

  • Users and UserGroupIds cannot be specified at the same time.

MAU billing parameters

  • Set ChargeType to PostPaid.

  • You must explicitly set SubPayType to mau. Omitting this field does not enable MAU billing.

  • Set ChargeResourceMode to AppInstance.

  • You do not need to specify Period, PeriodUnit, AppPackageType, AutoPay, AutoRenew, or NodePool.

Post-call operations

A successful API response does not indicate that the browser resources are ready. After creation, query the status of the browser group and use it only after confirming that it is connectable.

This operation creates a new cloud browser group and does not require a delivery group to be created in advance.

Example instructions

Field examples demonstrate how to specify values. Replace resource identifiers with the actual values under the current account. Capacity examples do not represent default values or upper limits.

An example value of - indicates that the field is not required. When calling the API, omit the corresponding parameter instead of passing the - character.

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
CloudBrowserName

string

Yes

The name of the cloud browser group. This parameter is required. It is used to distinguish different browser groups in business management scenarios.

Business office browser
ChargeType

string

No

The billing method.

For MAU scenarios: Set this parameter to PostPaid, which indicates pay-as-you-go.

Valid values:

  • PostPaid :

    Pay-as-you-go.

PostPaid
SubPayType

string

No

The billing sub-type.

You must explicitly set this parameter to mau, which indicates billing by monthly active users (MAU). Omitting this field does not enable MAU billing.

Valid values:

  • mau :

    Billed by monthly active users.

mau
Period

integer

No

The number of subscription periods.

You do not need to specify this parameter.

-
PeriodUnit

string

No

The unit of the subscription period.

You do not need to specify this parameter.

-
AppPackageType

string

No

The package identifier.

You do not need to specify this parameter.

-
AutoPay

boolean

No

The automatic payment parameter.

You do not need to specify this parameter.

-
AutoRenew

boolean

No

The auto-renewal parameter.

You do not need to specify this parameter.

-
PromotionId

string

No

The promotion ID, which is used to specify the promotional offer applied to the order.

Applicability and specific discounts are subject to the promotion rules. You do not need to specify this parameter if no promotional offer is applied.

17440009****
Users

array<object>

No

The list of authorized users. You can specify up to 200 users. The users must be created in advance and match the account type.

Limit: This parameter cannot be specified together with a non-empty UserGroupIds parameter.

object

No

EndUserId

string

No

Authorized user ID of authorized user to be authorized.

alice
BizRegionId

string

Yes

The business region ID. This parameter is required.

cn-hangzhou
Network

object

No

The office network and website access restriction configurations. The selected office network must belong to the current account and reside in the region specified by BizRegionId.

AccessRestriction

string

No

The website access restriction mode.

  • ALLOW_ALL: Allows access to all domain names.

  • ALLOW_LIST: Allows access only to websites in the whitelist.

Valid values:

  • ALLOW_ALL :

    Allows access to all domain names.

  • ALLOW_LIST :

    Allows access only to websites in the whitelist.

ALLOW_ALL
OfficeSiteId

string

No

The ID of the created office network. The office network must belong to the current account and reside in the target region specified by BizRegionId.

cn-hangzhou+dir-643067****
RestrictedURLs

array<object>

No

The list of websites that are allowed for access. This parameter is used in ALLOW_LIST mode.

Limits:

  • You can specify up to 20 URLs directly. To specify more than 20 URLs, use RestrictedURLsFilePath to import URLs from a file.

  • This parameter cannot be specified together with RestrictedURLsFilePath.

  • URLs in the list cannot be duplicated.

object

No

URL

string

No

The URL of the website that is allowed for access.

aliyun.com
RestrictedURLsFilePath

string

No

The path of the uploaded website whitelist file. This parameter is used in ALLOW_LIST mode.

To specify more than 20 URLs, import URLs from a file. By default, you can configure up to 1,000 URLs.

This parameter cannot be specified together with RestrictedURLs.

cn-hangzhou/aig_upm/xxx/temp/BrowserRestrictionUrls/URL_whitelist_template.csv
VSwitchIds

array

No

The list of vSwitch IDs.

Usage condition: This parameter is required only when you use a custom office network. Do not specify this parameter for other types of office networks.

Select vSwitches that match the target business region and the custom office network.

string

No

The ID of the vSwitch used by the custom office network.

vsw-bp1et6n3163lhr2k****
Policy

object

No

Configures policies for the clipboard, video, watermark, session, and client access.

AppContentProtection

string

No

The screen capture prevention switch.

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

No

The IP address whitelist for client access, which is used to restrict the source IP addresses of clients that can access the cloud browser.

object

No

CidrIp

string

No

The source CIDR block of the client that is allowed to access the cloud browser. Use the CIDR format.

192.168.1.0/24
Description

string

No

The description of the IP address whitelist rule for client access.

Office network access
ClientTypes

array<object>

No

The client access control list.

object

No

ClientType

string

No

The type of the client for which you want to configure an access policy.

  • windows: Windows client.

  • macos: macOS client.

  • html5: Web client.

  • android: Android client.

  • ios: iOS client.

Valid values:

  • html5 :

    Web client.

  • android :

    Android client.

  • windows :

    Windows client.

  • ios :

    iOS client.

  • macos :

    macOS client.

windows
Status

string

No

The access policy switch for the client type.

  • 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

No

Configures the clipboard transfer direction, content types, 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

No

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

  • off: Prohibits copy and paste 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 copy and paste in both directions.

Valid values:

  • read :

    Allows copying from the local PC to the cloud browser.

  • readwrite :

    Allows bidirectional copy and paste.

  • write :

    Allows copying from the cloud browser to the local PC.

  • off :

    Prohibits bidirectional copy and paste.

readwrite
ClipboardReadLimit

integer

No

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

Value limits: The value ranges from 1 to 102400. The unit is specified by ClipboardSizeUnit.

The value range does not change with unit conversion.

1024
ClipboardScope

string

No

The clipboard control granularity. Valid values:

  • global: Unified control.

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

Valid values:

  • grained :

    Controls the clipboard separately by content type.

  • global :

    Controls the clipboard uniformly.

grained
ClipboardSizeUnit

string

No

The clipboard size unit. Valid values:

  • B: Bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    Kilobytes (1024 bytes).

KB
ClipboardWriteLimit

integer

No

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

Value limits: The value ranges from 1 to 102400. The unit is specified by ClipboardSizeUnit.

The value range does not change with unit conversion.

1024
FileClipboard

string

No

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

  • off: Prohibits copy and paste 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 copy and paste in both directions.

Valid values:

  • read :

    Allows copying from the local PC to the cloud browser.

  • readwrite :

    Allows bidirectional copy and paste.

  • write :

    Allows copying from the cloud browser to the local PC.

  • off :

    Prohibits bidirectional copy and paste.

off
RichTextClipboard

string

No

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

  • off: Prohibits copy and paste 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 copy and paste in both directions.

Valid values:

  • read :

    Allows copying from the local PC to the cloud browser.

  • readwrite :

    Allows bidirectional copy and paste.

  • write :

    Allows copying from the cloud browser to the local PC.

  • off :

    Prohibits bidirectional copy and paste.

off
RichTextClipboardLimit

integer

No

The rich text clipboard size limit.

Value limits: The value ranges from 1 to 204800. The unit is specified by RichTextClipboardSizeUnit.

The value range does not change with unit conversion.

1024
RichTextClipboardReadLimit

integer

No

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

Value limits: The value ranges from 1 to 204800. The unit is specified by RichTextClipboardReadSizeUnit.

The value range does not change with unit conversion.

1
RichTextClipboardReadSizeUnit

string

No

The clipboard size unit. Valid values:

  • B: Bytes.

  • KB: 1024 bytes.

Default value: KB.

Valid values:

  • B :

    Bytes.

  • KB :

    Kilobytes (1024 bytes).

KB
RichTextClipboardSizeUnit

string

No

The clipboard size unit. Valid values:

  • B: Bytes.

  • KB: 1024 bytes.

Valid values:

  • B :

    Bytes.

  • KB :

    Kilobytes (1024 bytes).

KB
RichTextClipboardWriteLimit

integer

No

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

Value limits: The value ranges from 1 to 204800. The unit is specified by RichTextClipboardWriteSizeUnit.

The value range does not change with unit conversion.

1
RichTextClipboardWriteSizeUnit

string

No

The clipboard size unit. Valid values:

  • B: Bytes.

  • KB: 1024 bytes.

Default value: KB.

Valid values:

  • B :

    Bytes.

  • KB :

    Kilobytes (1024 bytes).

KB
TextClipboard

string

No

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

  • off: Prohibits copy and paste 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 copy and paste in both directions.

Valid values:

  • read :

    Allows copying from the local PC to the cloud browser.

  • readwrite :

    Allows bidirectional copy and paste.

  • write :

    Allows copying from the cloud browser to the local PC.

  • off :

    Prohibits bidirectional copy and paste.

readwrite
TextClipboardReadLimit

integer

No

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

Value limits: The value ranges from 1 to 102400. The unit is specified by TextClipboardReadSizeUnit.

The value range does not change with unit conversion.

1
TextClipboardReadSizeUnit

string

No

The clipboard size unit. Valid values:

  • B: Bytes.

  • KB: 1024 bytes.

Default value: KB.

Valid values:

  • B :

    Bytes.

  • KB :

    Kilobytes (1024 bytes).

KB
TextClipboardWriteLimit

integer

No

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

Value limits: The value ranges from 1 to 102400. The unit is specified by TextClipboardWriteSizeUnit.

The value range does not change with unit conversion.

1
TextClipboardWriteSizeUnit

string

No

The clipboard size unit. Valid values:

  • B: Bytes.

  • KB: 1024 bytes.

Default value: KB.

Valid values:

  • B :

    Bytes.

  • KB :

    Kilobytes (1024 bytes).

KB
DisconnectKeepSession

string

No

The data retention policy for sessions after disconnection. Valid values:

  • customTime: Retains the session based on the data retention policy. Custom durations through DisconnectKeepSessionTime are not supported.

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

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

Valid values:

  • customTime :

    Retains the session for a specified duration.

  • persistent :

    Prevents automatic release of the session based on the disconnection duration.

customTime
DisconnectKeepSessionTime

integer

No

Not supported. Leave this parameter empty.

-
FileManager

string

No

The floating ball file manager switch. Valid values:

  • on: Enabled.

  • off: Disabled.

Default value: off.

Valid values:

  • off :

    Hides the file manager.

  • on :

    Shows the file manager.

off
Html5FileTransfer

string

No

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

  • off: Prohibits transfer.

  • upload: Allows only uploads.

  • download: Allows only downloads.

  • full: Allows both uploads and downloads.

Configure this parameter in conjunction with the clipboard policy.

Valid values:

  • download :

    Allows only file downloads.

  • upload :

    Allows only file uploads.

  • off :

    Prohibits file transfer.

  • full :

    Allows file uploads and downloads.

full
MultiScreen

string

No

The cloud browser dual-screen switch.

off
NoOperationDisconnect

string

No

The automatic disconnection switch for idle sessions. The value is not case-sensitive. Valid values:

  • on: Enabled.

  • off: Disabled.

When enabled, use NoOperationDisconnectTime to set the idle timeout.

Valid values:

  • off :

    Disables automatic disconnection for idle sessions.

  • on :

    Enables automatic disconnection for idle sessions.

on
NoOperationDisconnectTime

integer

No

The idle timeout in seconds before a disconnection is triggered.

Usage condition: When NoOperationDisconnect is enabled, you must specify a value greater than 0.

300
PolicyVersion

string

No

The policy version. The value is not case-sensitive. Valid values:

  • DEFAULT: Legacy policy.

  • CENTER: Centralized policy.

Default value: DEFAULT. The effective policy version is subject to the policy configurations available for the account.

Valid values:

  • CENTER :

    Centralized policy.

  • DEFAULT :

    Legacy policy.

CENTER
VideoPolicy

object

No

The video display policy for browser sessions.

FrameRate

integer

No

The frame rate for browser sessions.

60
WatermarkPolicy

object

No

The watermark display configuration for browser sessions.

WatermarkSwitch

string

No

The watermark switch. The value is case-insensitive. Valid values:

  • ON: Enables the watermark.

  • OFF: Disables the watermark. When 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

No

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

No

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
Timers

array<object>

No

Not supported. Leave this parameter empty.

-

object

No

Interval

integer

No

Not supported. Leave this parameter empty.

-
TimerType

string

No

Not supported. Leave this parameter empty.

Valid values:

  • SESSION_TIMEOUT :

    Session timeout handling after disconnection.

-
BrowserConfig

object

No

The browser configuration.

Bookmarks

array<object>

No

The list of browser bookmarks. Limits: This parameter cannot be specified together with a non-empty BookmarksFilePath, and bookmark URLs must be unique.

object

No

BookmarkFolder

string

No

The folder where the bookmark is located. The length cannot exceed 64 characters after leading and trailing spaces are removed.

Work portal
BookmarkName

string

Yes

The name of the bookmark. This parameter is required and cannot be empty when you create a bookmark. The length cannot exceed 64 characters after leading and trailing spaces are removed.

Alibaba Cloud official website
BookmarkURL

string

Yes

The URL of the bookmark. This parameter is required when you create a bookmark. The length cannot exceed 1024 characters after leading and trailing spaces are removed.

https://www.aliyun.com
BookmarksFilePath

string

No

The path of the uploaded bookmark file. This parameter cannot be specified together with a non-empty Bookmarks parameter. File format: CSV without a header. Specify the following four columns in order:

  1. Bookmark name.

  2. URL.

  3. Folder.

  4. Root directory type: bookmark_bar indicates the bookmarks bar, and other indicates other bookmarks. Limits:

  • Fields are separated by commas. Field content cannot contain commas or line breaks, and quote escaping is not supported.

  • The file path must belong to the upload directory specified for the current account and cannot contain ..

cn-hangzhou/aig_upm/xxx/temp/BrowserBookmarks/BrowserBookmarkTemplate.csv
BrowserParam

string

No

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

--incognito
CookiesSync

boolean

No

Specifies whether to synchronize cookies.

false
Homepage

string

No

The homepage URL that opens when the browser starts. The URL must conform to the URI syntax.

https://www.aliyun.com
OsType

string

No

The operating system type. This parameter is required. Only Windows is supported. Other operating systems are not supported.

Valid values:

  • Windows :

    The Windows operating system.

Windows
SecurityPolicy

object

No

The connection security policy of the browser group.

SkipUserAuthCheck

boolean

No

Specifies whether to skip the user authorization check when connecting to the application. Valid values:

  • true: Skips the check.

  • false: Performs the check. If SecurityPolicy is configured but this field is omitted, the user authorization check is performed. Note: This field cannot be used to skip OpenAPI identity authentication and RAM permission verification.

false
Tag

array<object>

No

Not supported. Leave this parameter empty.

-

object

No

Key

string

No

Not supported. Leave this parameter empty.

-
Value

string

No

Not supported. Leave this parameter empty.

-
UserInfo

object

No

The authorized user account information. The information must match the user and office network types.

Type

string

No

The account type of the authorized user. Valid values:

  • simple: The convenience account.

  • ad: The AD domain account. The account type must match the user and office network account types.

Valid values:

  • ad :

    The AD domain account.

  • simple :

    The convenience account.

simple
NodePool

object

No

The node pool configuration. You do not need to specify this parameter.

-
NodeAmount

integer

No

The number of nodes. You do not need to specify this parameter.

-
NodeInstanceType

string

No

The node specifications identity.

You do not need to specify this parameter.

-
StrategyType

string

No

The node scaling strategy. You do not need to specify this parameter.

-
ChargeResourceMode

string

No

The resource billing method. For MAU scenarios: Set this parameter to AppInstance, which indicates billing by instance resources.

Valid values:

  • AppInstance :

    Bills by instance resources.

AppInstance
UserGroupIds

array

No

The list of authorized user group IDs. You can specify up to 10 user group IDs. The user groups must belong to the current account and match the office network account type. Limits: This parameter cannot be specified together with a non-empty Users parameter.

string

No

The ID of a user group that belongs to the current account and matches the office network account type.

ug-1
InstanceType

string

No

The instance specification identifier. Select a specification that matches the target region, operating system, and inventory conditions. If this parameter is omitted, the default specification is used.

appstreaming.general.basic
ImageId

string

No

The image ID used by the cloud browser. The image must be compatible with the operating system. If this parameter is omitted, the default image available for the account is used. If no default image is available, the creation may fail. Usage conditions: When CookiesSync is enabled, explicitly specify an image that supports cookie synchronization.

img-bp13mu****
StoragePolicy

object

No

The user data storage configuration of the browser group.

UserProfile

object

No

The user data roaming configuration, which is used to retain user configuration data.

UserProfileSize

integer

No

The size of the user data roaming disk. Unit: GB.

30
UserProfileSwitch

boolean

No

Specifies whether to enable user data roaming. Valid values:

  • true: Enables user data roaming.

  • false: Disables user data roaming. In Windows scenarios, if this parameter is explicitly specified, the specified value is used. If this parameter is omitted, the user roaming configuration of the current account is used.

true
MaxAmount

integer

No

The capacity configuration in MAU billing scenarios.

5
AuthNotificationEnabled

boolean

No

Specifies whether to send notification emails for authorization and deauthorization. Valid values:

  • true: Sends notification emails.

  • false: Does not send notification emails.

true

Response elements

Element

Type

Description

Example

object

The request ID and result of creating a cloud browser group.

BrowserInstanceGroupModel

object

The creation result of the cloud browser group, including the resource ID and order ID.

BrowserInstanceGroupId

string

The ID of the newly created cloud browser group. The return of this ID does not indicate that the resource is ready.

big-0bz55ixxxxx9xi9w9
OrderId

string

The ID of the order generated for this creation.

12345****
RequestId

string

The unique ID of the request, which can be used for troubleshooting.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

{
  "BrowserInstanceGroupModel": {
    "BrowserInstanceGroupId": "big-0bz55ixxxxx9xi9w9",
    "OrderId": "12345****"
  },
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

HTTP status code

Error code

Error message

Description
500 ServiceUnavailable Service unavailable. Please try again later. Service unavailable. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.