All Products
Search
Document Center

Elastic Desktop Service:CreateSimpleOfficeSite

Last Updated:Mar 13, 2025

Creates an office network of the convenience account type. Elastic Desktop Service supports the following types of accounts: convenience accounts and enterprise AD accounts.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:CreateSimpleOfficeSitecreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
CidrBlockstringNo

The IPv4 CIDR block that you want the office network to use in the virtual private cloud (VPC) of the office network. The system automatically creates a VPC for the office network based on the IPv4 CIDR block. We recommend that you set this parameter to one of the following CIDR blocks and their subnets:

  • 10.0.0.0/12 (subnet mask range: 12 to 14 bits)
  • 172.16.0.0/12 (subnet mask range: 12 to 24 bits)
  • 192.168.0.0/16 (subnet mask range: 16 to 24 bits)
172.16.0.0/12
CenIdstringNo

The Cloud Enterprise Network (CEN) instance ID.

Note If you want end users to connect to cloud computers from Alibaba Cloud Workspace clients over VPCs, you can attach the office network to a CEN instance. The CEN instance is the one that connects to your on-premises network over VPN Gateway or Express Connect.
cen-3gwy16dojz1m65****
CenOwnerIdlongNo

The ID of the Alibaba Cloud account to which the Cloud Enterprise Network (CEN) instance belongs.

  • If you do not specify the CenId parameter, or the CEN instance that is specified by the CenId parameter belongs to the current Alibaba Cloud account, skip this parameter.
  • If you specify the CenId parameter and the CEN instance that you specify for the CenId parameter belongs to another Alibaba Cloud account, enter the ID of the Alibaba Cloud account.
118272523431****
VerifyCodestringNo

The verification code. If the CEN instance that you specify for the CenId parameter belongs to another Alibaba Cloud account, you must call the SendVerifyCode operation to obtain the verification code.

123456
BandwidthintegerNo

The maximum public bandwidth. Value range: 10 to 200. Unit: Mbit/s. This parameter is available if you set EnableInternetAccess to true.

10
OfficeSiteNamestringNo

The office network name. The name must be 2 to 255 characters in length. It can contain digits, colons (:), underscores (_), and hyphens (-). It must start with a letter and cannot start with http:// or https://.

TestOfficeSite_Simple
EnableInternetAccessbooleanNo

Specifies whether to enable Internet access.

Valid values:

  • true

  • false (default)

false
EnableAdminAccessbooleanNo

Specifies whether to grant the local administrator permissions to users that are authorized to use cloud computers in the office network.

Valid values:

  • true (default)
  • false
true
DesktopAccessTypestringNo

The method to connect to cloud computers from Alibaba Cloud Workspace clients.

Note The VPC connection depends on Alibaba Cloud PrivateLink. You can use PrivateLink for free. When you set this parameter to VPC or Any, PrivateLink is automatically activated.````
Internet
NeedVerifyZeroDevicebooleanNo

Specifies whether to enable trusted device verification.

true
VSwitchIdarrayNo

The IDs of the vSwitches that you want to specify in VPCs. This parameter is required only when you create CloudBox-based office networks.

stringNo

The ID of the vSwitch that you want to specify in a VPC. This parameter is required only when you create a CloudBox-based office network.

vsw-bp12mw1f8k3jgy****
CloudBoxOfficeSitebooleanNo

Specifies whether to create a CloudBox-based office network.

Valid values:

  • true

  • false

false
VpcTypestringNo

The network type of the office network.

Valid values:

  • standard: advanced
  • basic: basic
standard

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

OfficeSiteIdstring

The office network ID.

cn-hangzhou+os-c5cy7q578s8jc****
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "OfficeSiteId": "cn-hangzhou+os-c5cy7q578s8jc****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-02-25The Error code has changedView Change Details
2023-11-15The request parameters of the API has changedView Change Details
2021-10-28The request parameters of the API has changedView Change Details