All Products
Search

This Product

    Elastic Desktop Service:CreateSimpleOfficeSite

    Document Center

    Elastic Desktop Service:CreateSimpleOfficeSite

    Last Updated:Mar 17, 2026

    WUYING Workspace supports convenience accounts and enterprise AD accounts. This operation creates an office network (formerly known as 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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. Call DescribeRegions to get a list of regions where WUYING Workspace is available.

    cn-hangzhou
    CidrBlock

    string

    No

    The IPv4 CIDR block for the office network's VPC. This parameter is required for premium office networks. The system automatically creates a VPC based on the IPv4 CIDR block that you enter. We recommend that you use one of the following CIDR blocks or their subnets:

    • 10.0.0.0/12 (The valid mask length is 12 to 24.)

    • 172.16.0.0/12 (The valid mask length is 12 to 24.)

    • 192.168.0.0/16 (The valid mask length is 16 to 24.)

    172.16.0.0/12
    CenId

    string

    No

    The ID of the Cloud Enterprise Network (CEN) instance.

    Note

    To connect to cloud desktops over a VPC, add the office network to a CEN instance. This CEN instance is connected to your on-premises network through a VPN gateway or a leased line.

    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 account, you do not need to specify this parameter.

    • If the CEN instance belongs to another Alibaba Cloud account, specify the ID of that account.

    118272523431****
    VerifyCode

    string

    No

    The verification code. If the CEN instance belongs to another Alibaba Cloud account, you must first call SendVerifyCode to obtain a verification code.

    123456
    Bandwidth

    integer

    No

    The peak public bandwidth, in Mbps. Valid values: 10 to 200. This parameter is available only 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. It must start with a letter 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 public network access.

    Valid values:

    • true :

      Enables public network access.

    • false :

      Disables public network access. (Default)

    false
    EnableAdminAccess

    boolean

    No

    Specifies whether to grant local administrator permissions to users of the cloud desktops.

    Valid values:

    • true :

      Grants local administrator permissions. (Default)

    • false :

      Does not grant local administrator permissions.

    true
    DesktopAccessType

    string

    No

    The allowed connection types for cloud desktops.

    Note

    VPC connections depend on Alibaba Cloud PrivateLink. This service is free of charge. When you set this parameter to `VPC` or `Any`, the system automatically enables PrivateLink.

    Valid values:

    • VPC :

      Allows only clients within a VPC to connect to cloud desktops.

    • Internet :

      Allows only clients on the public network to connect to cloud desktops. (Default)

    • Any :

      Allows clients to connect using any method. Clients can choose their connection method.

    Internet
    NeedVerifyZeroDevice

    boolean

    No

    Specifies whether to enable trusted device verification.

    Valid values:

    • true :

      Enables trusted device verification.

    • false :

      Disables trusted device verification.

    true
    VSwitchId

    array

    No

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

    string

    No

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

    vsw-bp12mw1f8k3jgy****
    CloudBoxOfficeSite

    boolean

    No

    Specifies whether the office network is a CloudBox-based office network.

    Valid values:

    • true :

      The office network is a CloudBox-based office network.

    • false :

      The office network is a public office network.

    false
    VpcType

    string

    No

    The type of the office network.

    Valid values:

    • standard :

      Premium office network

    • basic :

      Basic office network

    standard
    AccountType

    string

    No

    AuthorityHost

    string

    No

    TenantId

    string

    No

    DomainName

    string

    No

    ClientId

    string

    No

    ClientSecret

    string

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    The response.

    OfficeSiteId

    string

    The ID of the office network.

    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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.