Use the CreateSimpleOfficeSite API to create a convenience office network - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Elastic Desktop Service supports two account systems: convenience accounts and enterprise AD accounts. Creates an office network (formerly workspace) based on convenience accounts.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:CreateSimpleOfficeSite

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the regions supported by Elastic Desktop Service.	cn-hangzhou
CidrBlock	string	No	The IPv4 CIDR block of the VPC for the office network. This parameter is required for advanced office networks. The system uses automatic creation of a VPC based on the specified IPv4 CIDR block. Use one of the following CIDR blocks or their subnets: `10.0.0.0/12` (valid mask range: 12 to 24 bits) `172.16.0.0/12` (valid mask range: 12 to 24 bits) `192.168.0.0/16` (valid mask range: 16 to 24 bits)	172.16.0.0/12
CenId	string	No	The instance ID of the Cloud Enterprise Network (CEN) instance. Note To connect to cloud desktops over a VPC connection, add the office network to a CEN instance. The CEN instance is the one that the on-premises network connects to by using a VPN or Express Connect circuit.	cen-3gwy16dojz1m65****
CenOwnerId	integer	No	The Alibaba Cloud account ID to which the CEN instance belongs. If CenId is not specified or the specified CEN instance belongs to the current Alibaba Cloud account, you do not need to specify this parameter. If the specified CEN instance belongs to another Alibaba Cloud account, specify the Alibaba Cloud account ID of that account.	118272523431****
VerifyCode	string	No	The verification code. If the specified CEN instance belongs to another Alibaba Cloud account, call SendVerifyCode to obtain the verification code first.	123456
Bandwidth	integer	No	The peak Internet bandwidth. Valid values: 10 to 200. Unit: Mbit/s. You can specify this parameter when `EnableInternetAccess` is set to `true`.	10
OfficeSiteName	string	No	The name of the office network. The name must be 2 to 255 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter or Chinese character and cannot start with `http://` or `https://`.	TestOfficeSite_Simple
EnableInternetAccess	boolean	No	Specifies whether to enable public network access. Valid values: true : Enabled. false : Disabled. [Default value]	false
EnableAdminAccess	boolean	No	Specifies whether to grant local administrator permissions to users who use cloud desktops. Valid values: true : Local administrator permissions are granted. [Default value] false : Local administrator permissions are not granted.	true
DesktopAccessType	string	No	The access method allowed when connecting to cloud desktops. Note The VPC connection method depends on the Alibaba Cloud PrivateLink service, which is free of charge. If this parameter is set to `VPC` or `Any`, the system automatically activates the PrivateLink service. Valid values: VPC : Only clients within a VPC can connect to cloud desktops. Internet : Only clients over a public network connection can connect to cloud desktops. [Default value] Any : No restriction. Users can choose the connection method when connecting to cloud desktops by using clients.	Internet
NeedVerifyZeroDevice	boolean	No	Specifies whether to enable trusted device verification. Valid values: true : Trusted device verification is enabled. false : Trusted device verification is disabled.	true
VSwitchId	array	No	The ID of the vSwitch in the VPC. This parameter is required when you create a CloudBox office network.
	string	No	The ID of the vSwitch in the VPC. This parameter is required when you create a CloudBox office network.	vsw-bp12mw1f8k3jgy****
CloudBoxOfficeSite	boolean	No	Specifies whether the office network is a CloudBox office network. Valid values: true : CloudBox office network. false : Internet office network.	false
VpcType	string	No	The type of the office network. Valid values: standard : Advanced office network. basic : Basic office network.	standard
AccountType	string	No	The account type.	SIMPLE
AuthorityHost	string	No	The authority URL of the identity authentication service.	https://login.microsoftonline.com
TenantId	string	No	The tenant ID of the identity provider.	72f988bf-86f1-41af-91ab-2d7cd011****
DomainName	string	No	The domain name of the enterprise AD.	domain.local
ClientId	string	No	The client ID registered with the identity provider application.	a2c8f7e4-1b3d-4c5e-9f0a-6d7b8c9e****
ClientSecret	string	No	The client secret registered with the identity provider application.	sct-9f3e2d1c****
Eid	string	No	The enterprise ID (EID).	e-1234abcd****
AccessAttribute	string	No	The access attribute of the office network (workspace).	Private

Response elements

Element	Type	Description	Example
	object	The response parameters.
OfficeSiteId	string	The office network ID.	cn-hangzhou+os-c5cy7q578s8jc****
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

{
  "OfficeSiteId": "cn-hangzhou+os-c5cy7q578s8jc****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NetworkSpace.VpcInfoExist	vpc info already exist.	Office network already exists for the corresponding VPC
400	OfficeSiteNameInvalid	Office site name invalid.	Office site name invalid.
400	INSUFFICIENT_QUOTA	Insufficient quota.	The user quota is insufficient.
403	CREATE_SLR_ERROR	You are not authorized to do this action.	You are not authorized to do this action. Resource: acs:ram:::role/* Action: ram:CreateServiceLinkedRole

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.