DocsICP FilingConsole
Documentation

CreateBrowserInstanceGroup

Updated at:
Copy as MD
Product
My Favorites

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

Operation description

Before you begin

  • Prepare an available office network, image, and instance type in the target business region. Make sure that the account has the required browser configurations and resource quotas.

  • Specify CloudBrowserName and BizRegionId. Set OsType to Windows.

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

  • Users and UserGroupIds cannot both be non-empty.

MAU billing parameters

  • Set ChargeType to PostPaid.

  • Set SubPayType to mau explicitly. Omitting this field does not enable MAU billing.

  • Set ChargeResourceMode to AppInstance.

  • Do not specify Period, PeriodUnit, AppPackageType, AutoPay, AutoRenew, or NodePool.

Post-call processing

A successful response does not indicate that the browser resources are ready. After creation, query the browser group status and confirm that the group is connectable before use.

This operation creates a new cloud browser group. You do not need to create a delivery group in advance.

Example description

The example values of fields are provided to demonstrate how to specify the fields. Replace resource identifiers with actual values under your account. Capacity examples do not represent default values or upper limits.

An example value of - indicates that the field does not need to be specified. Omit the corresponding parameter when you call the operation. Do not pass 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 cannot be empty. The name is used to distinguish different browser groups in business management scenarios.

BusinessOfficeBrowser
ChargeType

string

No

The billing type.

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

Valid values:

  • PostPaid :

    Pay-as-you-go.

PostPaid
SubPayType

string

No

The billing subtype.

Set this parameter to mau explicitly, which indicates billing by monthly active users. Omitting this field does not enable MAU billing.

Valid values:

  • mau :

    Billing by monthly active users.

mau
Period

integer

No

The number of subscription periods.

Do not specify this parameter.

-
PeriodUnit

string

No

The unit of the subscription period.

Do not specify this parameter.

-
AppPackageType

string

No

The plan identifier.

Do not specify this parameter.

-
AutoPay

boolean

No

The automatic payment parameter.

Do not specify this parameter.

-
AutoRenew

boolean

No

The auto-renewal parameter.

Do not specify this parameter.

-
PromotionId

string

No

The promotion ID. Specifies the promotional campaign to apply to the order.

Whether the promotion is applicable depends on the campaign rules. Do not specify this parameter if no promotional campaign is used.

17440009****
Users

array<object>

No

The list of authorized users. A maximum of 200 users can be specified. Users must be created in advance and must match the account type.

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

object

No

EndUserId

string

No

The identity of the authorized user to be granted authorization.

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 be located 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 allowlist.

Valid values:

  • ALLOW_ALL :

    Allows access to all domain names.

  • ALLOW_LIST :

    Allows access only to websites in the allowlist.

ALLOW_ALL
OfficeSiteId

string

No

The ID of the office network that has been created. The office network must belong to the current account and be located in the target region specified by BizRegionId.

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

array<object>

No

The list of allowed websites. This parameter is used in ALLOW_LIST mode.

Restrictions:

  • A maximum of 20 URLs can be specified directly. If more than 20 URLs are required, use RestrictedURLsFilePath to import them 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 allowed website.

aliyun.com
RestrictedURLsFilePath

string

No

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

If more than 20 URLs are required, use file import. A maximum of 1,000 URLs can be configured by default.

This parameter cannot be specified together with RestrictedURLs.

cn-hangzhou/aig_upm/xxx/temp/BrowserRestrictionUrls/URL白名单模版.csv
VSwitchIds

array

No

The list of vSwitch IDs.

Usage condition: Specify this parameter 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

The clipboard, video, watermark, session, and client access policy configurations.

AppContentProtection

string

No

Specifies whether to enable screen capture prevention.

  • 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 client access IP address whitelist. This parameter 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 clients that are allowed to access the cloud browser.

192.168.1.0/24
Description

string

No

The description of the client access IP address whitelist rule.

OfficeNetworkAccess
ClientTypes

array<object>

No

The client access control list.

object

No

ClientType

string

No

The client type 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 client type.

  • off: Denies access from this client type.

Valid values:

  • off :

    Denies access from this client type.

  • on :

    Allows access from this client type.

on
ClipboardPolicy

object

No

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

Clipboard

string

No

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

  • off: Bidirectional transfer is disabled.

  • 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: Bidirectional transfer is allowed.

Valid values:

  • read :

    allows copy from the local PC to the cloud browser.

  • readwrite :

    allows bidirectional copy and paste.

  • write :

    allows copy from the cloud browser to the local PC.

  • off :

    disables bidirectional copy and paste.

readwrite
ClipboardReadLimit

integer

No

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

Value range: 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.

  • global: Unified control.

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

Valid values:

  • grained :

    separate clipboard control by content type.

  • global :

    unified clipboard control.

grained
ClipboardSizeUnit

string

No

The clipboard size unit.

  • 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 range: 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 case-insensitive.

  • off: Bidirectional transfer is disabled.

  • 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: Bidirectional transfer is allowed.

Valid values:

  • read :

    allows copy from the local PC to the cloud browser.

  • readwrite :

    allows bidirectional copy and paste.

  • write :

    allows copy from the cloud browser to the local PC.

  • off :

    disables bidirectional copy and paste.

off
RichTextClipboard

string

No

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

  • off: Bidirectional transfer is disabled.

  • 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: Bidirectional transfer is allowed.

Valid values:

  • read :

    allows copy from the local PC to the cloud browser.

  • readwrite :

    allows bidirectional copy and paste.

  • write :

    allows copy from the cloud browser to the local PC.

  • off :

    disables bidirectional copy and paste.

off
RichTextClipboardLimit

integer

No

The rich text clipboard size limit.

Value range: 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 range: 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.

  • B: Bytes.

  • KB: 1024 bytes.

Default value: KB.

Valid values:

  • B :

    bytes.

  • KB :

    kilobytes (1024 bytes)

KB
RichTextClipboardSizeUnit

string

No

The clipboard size unit.

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

  • 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 case-insensitive.

  • off: Bidirectional transfer is disabled.

  • 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: Bidirectional transfer is allowed.

Valid values:

  • read :

    allows copy from the local PC to the cloud browser.

  • readwrite :

    allows bidirectional copy and paste.

  • write :

    allows copy from the cloud browser to the local PC.

  • off :

    disables bidirectional copy and paste.

readwrite
TextClipboardReadLimit

integer

No

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

Value range: 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.

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

  • B: Bytes.

  • KB: 1024 bytes.

Default value: KB.

Valid values:

  • B :

    bytes.

  • KB :

    kilobytes (1024 bytes)

KB
DisconnectKeepSession

string

No

The session data retention policy after disconnection.

  • customTime: Retains the session based on the session data retention policy. Customizing the duration through DisconnectKeepSessionTime is not supported.

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

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

Valid values:

  • customTime :

    retains the session for a specified duration.

  • persistent :

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

customTime
DisconnectKeepSessionTime

integer

No

Not supported. You do not need to specify this parameter.

-
FileManager

string

No

Specifies whether to enable the floating ball file manager.

  • on: Enabled.

  • off: Disabled.

Default value: off.

Valid values:

  • off :

    hides the file manager.

  • on :

    displays the file manager.

off
Html5FileTransfer

string

No

The file transfer policy for the web client.

  • off: File transfer is disabled.

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

    allows file download only.

  • upload :

    allows file upload only.

  • off :

    disables file transfer.

  • full :

    allows file upload and download.

full
NoOperationDisconnect

string

No

Specifies whether to enable automatic disconnection on inactivity. The value is case-insensitive.

  • on: Enabled.

  • off: Disabled.

When enabled, set the wait duration through NoOperationDisconnectTime.

Valid values:

  • off :

    disables automatic disconnection on inactivity.

  • on :

    enables automatic disconnection on inactivity.

on
NoOperationDisconnectTime

integer

No

The wait duration before disconnection is triggered after user inactivity. Unit: seconds.

Prerequisite: When NoOperationDisconnect is enabled, specify a value greater than 0.

300
PolicyVersion

string

No

The policy version. The value is case-insensitive.

  • DEFAULT: Legacy policy.

  • CENTER: Centralized policy.

Default value: DEFAULT. The actual effective policy version depends on the policy configuration available for the account.

Valid values:

  • CENTER :

    centralized policy.

  • DEFAULT :

    legacy policy.

CENTER
VideoPolicy

object

No

The video display policy for the browser session.

FrameRate

integer

No

The frame rate of the browser session.

60
WatermarkPolicy

object

No

The watermark display configuration for browser sessions.

WatermarkSwitch

string

No

The watermark switch. The value is case-insensitive.

  • ON: Enables the watermark.

  • OFF: Disables the watermark.

When 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.

  • EndUserId: The user identifier.

  • InstanceGroupId: The delivery group identifier.

  • ClientTime: The current time on the client.

Use watermark types supported by the browser and client.

string

No

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
Timers

array<object>

No

Not supported. You do not need to specify this parameter.

-

object

No

Interval

integer

No

Not supported. You do not need to specify this parameter.

-
TimerType

string

No

Not supported. You do not need to specify this parameter.

Valid values:

  • SESSION_TIMEOUT :

    Session timeout handling after disconnection.

-
BrowserConfig

object

No

The browser configuration.

Bookmarks

array<object>

No

The list of browser bookmarks.

Limit: Cannot be specified together with a non-empty BookmarksFilePath. Bookmark URLs must be unique.

object

No

BookmarkFolder

string

No

The folder in which the bookmark is located. The length after trimming leading and trailing whitespace cannot exceed 64 characters.

Work Portal
BookmarkName

string

Yes

The bookmark name. This parameter is required and cannot be empty when you create a bookmark. The length after trimming leading and trailing whitespace cannot exceed 64 characters.

Alibaba Cloud Official Website
BookmarkURL

string

Yes

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

https://www.aliyun.com
BookmarksFilePath

string

No

The path of the uploaded bookmark file. Cannot be specified together with a non-empty Bookmarks.

File format: A headerless CSV file with four columns in the following 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 values cannot contain commas or line breaks. 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/浏览器书签模版.csv
BrowserParam

string

No

The browser startup parameters. For example, --incognito opens the browser in incognito mode.

--incognito
CookiesSync

boolean

No

Specifies whether to synchronize cookies.

false
Homepage

string

No

The homepage URL that opens when the browser starts. The value must conform to 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 :

    Windows operating system.

Windows
SecurityPolicy

object

No

The connection security policy for the browser group.

SkipUserAuthCheck

boolean

No

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

  • true: Skips the check.

  • false: Performs the check.

If this field is omitted when SecurityPolicy is configured, the user authorization check is performed.

Note: This field cannot be used to skip OpenAPI identity authentication or RAM permission verification.

false
Tag

array<object>

No

Not supported. You do not need to specify this parameter.

-

object

No

Key

string

No

Not supported. You do not need to specify this parameter.

-
Value

string

No

Not supported. You do not need to specify this parameter.

-
UserInfo

object

No

The authorized user account information. The value must match the user and workspace network type.

Type

string

No

The account type of the authorized user.

  • simple: Convenience account.

  • ad: AD domain account.

The value must match the account type of the user and workspace network.

Valid values:

  • ad :

    AD domain account.

  • simple :

    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 policy.

You do not need to specify this parameter.

-
ChargeResourceMode

string

No

The resource billing mode.

For MAU scenarios: Set this parameter to AppInstance to bill by instance resource.

Valid values:

  • AppInstance :

    billing by instance resource.

AppInstance
UserGroupIds

array

No

The list of authorized user group identifiers. A maximum of 10 items are supported. The user groups must belong to the current account and match the workspace network account type.

Limit: Cannot be specified together with a non-empty Users.

string

No

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

ug-1
InstanceType

string

No

The instance type identifier. Select an instance type that matches the target region, operating system, and inventory conditions.

If this parameter is omitted, the default instance type is used.

appstreaming.general.basic
ImageId

string

No

The image identifier 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 condition: When CookiesSync is enabled, explicitly specify an image that supports cookie synchronization.

img-bp13mu****
StoragePolicy

object

No

The user data storage configuration for 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 cloud disk. Unit: GB.

30
UserProfileSwitch

boolean

No

Specifies whether to enable user data roaming.

  • true: Enabled.

  • false: Disabled.

In Windows scenarios, if this field is explicitly specified, the specified value is used. If this field is omitted, the user roaming configuration of the current account is used.

true
MaxAmount

integer

No

The capacity configuration for the MAU billing scenario.

5
AuthNotificationEnabled

boolean

No

Specifies whether to send authorization and deauthorization notification emails.

  • true: Sends the notification.

  • false: Does not send the notification.

true

Response elements

Element

Type

Description

Example

object

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

BrowserInstanceGroupModel

object

The creation result of the cloud browser group, which contains the resource identifier and order identifier.

BrowserInstanceGroupId

string

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

big-0bz55ixxxxx9xi9w9
OrderId

string

The order identifier generated by this creation request.

12345****
RequestId

string

The unique identifier of this 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.