首页 无影云桌面 API参考(云桌面管控) API目录 工作区 CreateSimpleOfficeSite - 创建使用便捷账号的工作区

CreateSimpleOfficeSite - 创建使用便捷账号的工作区

创建一个使用便捷账号的工作区。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。可以调用DescribeRegions获取无影云桌面支持的地域列表。

cn-hangzhou
CidrBlockstring

工作区对应的安全办公网络包含的IPv4网段。系统将根据输入的IPv4网段,自动创建一个专有网络VPC。建议您使用10.0.0.0/12,172.16.0.0/12,192.168.0.0/16及其子网作为IPv4网段。如果设置了10或者172网段,掩码有效范围为1224位,如果设置了192网段,掩码有效范围为1624位。

172.16.0.0/12
CenIdstring

云企业网CEN实例ID。

说明如果想要通过VPC连接的方式接入云桌面,可以将工作区网络加入到云企业网实例中。该云企业网实例为本地网络通过VPN或者专线接入的云企业网实例。
cen-3gwy16dojz1m65****
CenOwnerIdlong

云企业网实例所属的阿里云账号ID。

  • 如果未配置CenId,或者配置的CenId属于本阿里云账号,该参数无需配置。
  • 如果配置的CenId属于其他阿里云账号,请填写所属阿里云账号的ID。
118272523431****
VerifyCodestring

验证码。如果配置的CenId属于其他阿里云账号,必须先调用SendVerifyCode获取验证码。

123456
Bandwidthinteger

公网带宽峰值。取值范围:10~200。带宽单位为 Mbps。 当EnableInternetAccess配置为true时可以设置该参数。

10
OfficeSiteNamestring

工作区名称。长度为2~255个英文或中文字符。必须以大小字母或中文开头,不能以http://和https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

TestOfficeSite_Simple
EnableInternetAccessboolean

是否开通公网访问功能。默认不开通。

false
EnableAdminAccessboolean

是否为使用云桌面的用户赋予本地管理员权限。

true
DesktopAccessTypestring

连接云桌面时允许使用的接入方式。

说明VPC连接方式依赖于阿里云私网连接PrivateLink服务,该服务不收取费用。该参数设置为VPC或者Any时,系统将自动为您开通私网连接服务。
Internet
NeedVerifyZeroDeviceboolean

是否开启可信设备校验。

true
VSwitchIdarray

专有网络VPC中的交换机ID,创建云盒工作区时需要填写。

string

专有网络VPC中的交换机ID,创建云盒工作区时需要填写。

vsw-bp12mw1f8k3jgy****
CloudBoxOfficeSiteboolean

是否为云盒工作区。

false

返回参数

名称类型描述示例值
object

返回信息集合。

OfficeSiteIdstring

工作区ID。

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

请求ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-10-28OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:VerifyCode
阿里云首页 无影云桌面 相关技术圈