CreateSimpleOfficeSite - 创建基于便捷账号的办公网络

更新时间:
复制为 MD 格式

无影云电脑支持便捷账号和企业AD账号这两种账号体系。本接口用于创建一个基于便捷账号的办公网络(原工作区)。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:CreateSimpleOfficeSite

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

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

cn-hangzhou

CidrBlock

string

办公网络 VPC 包含的 IPv4 网段。高级办公网络必填参数,系统将根据输入的 IPv4 网段,自动创建一个专有网络 VPC。建议您使用以下网段及其子网作为 IPv4 网段:

  • 10.0.0.0/12(掩码有效范围为 12~24 位)

  • 172.16.0.0/12(掩码有效范围为 12~24 位)

  • 192.168.0.0/16(掩码有效范围为 16~24 位)

172.16.0.0/12

CenId

string

云企业网 CEN 实例 ID。

说明

如果想要通过 VPC 连接的方式接入云电脑,可以将办公网络加入到云企业网实例中。该云企业网实例为本地网络通过 VPN 或者专线接入的云企业网实例。

cen-3gwy16dojz1m65****

CenOwnerId

integer

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

  • 如果未配置 CenId,或者配置的 CenId 属于本阿里云账号,该参数无需配置。

  • 如果配置的 CenId 属于其他阿里云账号,请填写所属阿里云账号的 ID。

118272523431****

VerifyCode

string

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

123456

Bandwidth

integer

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

10

OfficeSiteName

string

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

TestOfficeSite_Simple

EnableInternetAccess

boolean

是否开通公网访问功能。

枚举值:

  • true :

    开通

  • false :

    不开通 [默认值]

false

EnableAdminAccess

boolean

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

枚举值:

  • true :

    赋予本地管理员权限 [默认值]

  • false :

    不赋予本地管理员权限

true

DesktopAccessType

string

连接云电脑时允许使用的接入方式。

说明

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

枚举值:

  • VPC :

    只允许处于 VPC 网络内的客户端连接云电脑。

  • Internet :

    只允许客户端通过公网连接云电脑。[默认值]

  • Any :

    不限制方式。使用客户端连接云电脑时可以自行选择连接方式。

Internet

NeedVerifyZeroDevice

boolean

是否开启可信设备校验。

枚举值:

  • true :

    开启可信设备校验

  • false :

    不开启可信设备校验

true

VSwitchId

array

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

string

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

vsw-bp12mw1f8k3jgy****

CloudBoxOfficeSite

boolean

是否为云盒办公网络。

枚举值:

  • true :

    云盒办公网络

  • false :

    公网办公网络

false

VpcType

string

办公网络的类型。

枚举值:

  • standard :

    高级办公网络

  • basic :

    基础办公网络

standard

AccountType

string

AuthorityHost

string

TenantId

string

DomainName

string

ClientId

string

ClientSecret

string

Eid

string

AccessAttribute

string

返回参数

名称

类型

描述

示例值

object

返回信息集合。

OfficeSiteId

string

办公网络 ID。

cn-hangzhou+os-c5cy7q578s8jc****

RequestId

string

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 NetworkSpace.VpcInfoExist vpc info already exist. 对应VPC已存在办公网络

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

变更历史

更多信息,参考变更详情