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

Elastic Desktop Service (EDS) supports two types of accounts: convenience accounts and enterprise AD accounts. Use this API to create an office network (formerly a workspace) that uses 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 the DescribeRegions operation to get a list of regions that support Elastic Desktop Service (ECD).	cn-hangzhou
CidrBlock	string	No	The IPv4 CIDR block for the office site's Virtual Private Cloud (VPC). This parameter is required for standard office sites. The system automatically creates a VPC based on the specified IPv4 CIDR block. Use one of the following CIDR blocks or their subnets: `10.0.0.0/12` (The valid mask range is 12 to 24 bits.) `172.16.0.0/12` (The valid mask range is 12 to 24 bits.) `192.168.0.0/16` (The valid mask range is 16 to 24 bits.)	172.16.0.0/12
CenId	string	No	The ID of the Cloud Enterprise Network (CEN) instance. Note If you want to connect to cloud desktops over a VPC, attach the office site to the same CEN instance that is connected to your on-premises network by a VPN or an Express Connect circuit.	cen-3gwy16dojz1m65****
CenOwnerId	integer	No	The ID of the Alibaba Cloud account that owns the CEN instance. If you do not specify CenId, or if the CEN instance belongs to your Alibaba Cloud account, this parameter is not required. If the CEN instance is owned by another Alibaba Cloud account, specify the ID of that account.	118272523431****
VerifyCode	string	No	The verification code. If the CEN instance is owned by another Alibaba Cloud account, you must first call SendVerifyCode to obtain a verification code.	123456
Bandwidth	integer	No	The peak public bandwidth. Valid values: 10 to 200. Unit: Mbps. This parameter is valid only when `EnableInternetAccess` is set to `true`.	10
OfficeSiteName	string	No	The name of the office site. The name must be 2 to 255 characters in length. It must start with a letter or a Chinese character, and cannot start with `http://` or `https://`. The name can contain digits, colons (:), underscores (_), and hyphens (-).	TestOfficeSite_Simple
EnableInternetAccess	boolean	No	Specifies whether to enable internet access. Valid values: true : Internet access is enabled. false : Internet access is disabled. (Default)	false
EnableAdminAccess	boolean	No	Specifies whether to grant users local administrator privileges on their cloud desktops. Valid values: true : Grants local administrator privileges. (Default) false : Does not grant local administrator privileges.	true
DesktopAccessType	string	No	Specifies how clients can connect to cloud desktops. Note VPC connections rely on the Alibaba Cloud PrivateLink service, which is free of charge. If you set this parameter to `VPC` or `Any`, the system automatically enables the PrivateLink service. Valid values: VPC : Clients can connect to cloud desktops only from within a VPC. Internet : Clients can connect to cloud desktops only over the internet. (Default) Any : Clients can connect to cloud desktops from either a VPC or the internet.	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 vSwitch ID. This parameter is required when you create a Cloud Box office site.
	string	No		vsw-bp12mw1f8k3jgy****
CloudBoxOfficeSite	boolean	No	Specifies whether to create a Cloud Box office site. Valid values: true : Creates a Cloud Box office site. false : Creates a public office site.	false
VpcType	string	No	The type of the office site. Valid values: standard : A standard office site. basic : A basic office site.	standard
AccountType	string	No
AuthorityHost	string	No
TenantId	string	No
DomainName	string	No
ClientId	string	No
ClientSecret	string	No
Eid	string	No

Response elements

Element	Type	Description	Example
	object	The data returned for the request.
OfficeSiteId	string	The office site ID.	cn-hangzhou+os-c5cy7q578s8jc****
RequestId	string	The ID of the request.	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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.