创建一台或多台云电脑。创建时若传入用户信息,可直接完成云电脑的分配。
接口说明
创建云电脑前,请先完成以下准备工作:
- 已创建办公网络(原工作区)和用户。相关接口或文档请参见:
- 便捷办公网络: CreateSimpleOfficeSite 、 CreateUsers 。
- AD 办公网络: CreateADConnectorOfficeSite 、创建 AD 用户。
- 已调用 CreateBundle 创建云电脑模板,或确认使用已有云电脑模板。
- 已调用 CreatePolicyGroup 创建策略,或确认使用已有策略。
如需让云电脑自动执行自定义命令脚本,可使用UserCommands
字段配置自定义命令。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecd:CreateDesktops | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
GroupId | string | 否 | 云电脑池 ID。 | dg-boyczi8enfyc5**** |
BundleId | string | 是 | 云电脑模板 ID。 | b-je9hani001wfn**** |
DesktopName | string | 否 | 云电脑名称。命名规则如下:
| DemoComputer01 |
UserName | string | 否 | 说明
此参数不开放使用。
| username |
VpcId | string | 否 | 说明
此参数不开放使用。
| vpc-uf6w8u60n8xbkg5el**** |
Amount | integer | 否 | 创建的云电脑数量。取值范围为 1~300,默认值为 1。 | 1 |
DirectoryId | string | 否 | 说明
此参数不开放使用。
| cn-hangzhou+dir-300943**** |
OfficeSiteId | string | 是 | 办公网络 ID。 | cn-hangzhou+dir-387822**** |
PolicyGroupId | string | 是 | 策略 ID。 | system-all-enabled-policy |
ChargeType | string | 否 | 云电脑的计费方式。 枚举值:
| PrePaid |
Period | integer | 否 | 购买资源的时长。单位由
| 1 |
PeriodUnit | string | 否 | 包年包月计费方式的时长单位。 枚举值:
| Month |
AutoPay | boolean | 否 | 是否自动支付。 枚举值:
| false |
AutoRenew | boolean | 否 | 是否自动续费。当参数 枚举值:
| false |
PromotionId | string | 否 | 优惠活动 ID。 | 23141 |
UserAssignMode | string | 否 | 云电脑分配模式。 说明
如果未设置 EndUserId ,创建的云电脑不会分配给用户。
枚举值:
| ALL |
Hostname | string | 否 | 自定义设置云电脑的主机名称。仅支持设置 AD 办公网络下,操作系统类型是 Windows 的云电脑。 主机名称的命名规则如下:
创建多台云电脑时,可以使用
| testhost |
EndUserId | array | 否 | 为云电脑添加的授权用户 ID 列表。可设置 1~100 个。 | |
string | 否 | 为云电脑添加的授权用户 ID。
| alice | |
Tag | array<object> | 否 | 标签。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 标签键。可设置 1~20 个。 | TestKey |
Value | string | 否 | 标签值。可设置 1~20 个。 | TestValue |
DesktopNameSuffix | boolean | 否 | 批量创建云电脑时,云电脑名称是否自动增加后缀。 枚举值:
| false |
VolumeEncryptionEnabled | boolean | 否 | 是否开启磁盘加密。 枚举值:
| false |
VolumeEncryptionKey | string | 否 | 开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。 | 08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4**** |
DesktopMemberIp | string | 否 | 指定云电脑私网 IP。 | 10.0.0.1 |
UserCommands | array<object> | 否 | 用户自定义命令脚本数据。 | |
object | 否 | 用户自定义命令脚本数据。 | ||
ContentEncoding | string | 否 | 命令内容(CommandContent)的编码方式。 枚举值:
| Base64 |
Content | string | 否 | 命令内容。 | bmV3LWl0ZW0gZDpcdGVzdF91c2VyX2NvbW1hbmRzLnR4dCAtdHlwZSBm**** |
ContentType | string | 否 | 命令的语言类型。 枚举值:
| RunPowerShellScript |
BundleModels | array<object> | 否 | 云电脑模板列表。 | |
object | 否 | 云电脑模板。 | ||
BundleId | string | 否 | 云电脑模板 ID。 | b-je9hani001wfn**** |
Amount | integer | 否 | 创建的云电脑数量。取值范围为 1~300,默认值为 0。 | 1 |
EndUserIds | array | 否 | 云电脑分配用户列表。 | |
string | 否 | 用户名称。 | alice | |
DesktopName | string | 否 | 云电脑名称。命名规则如下:
| DemoComputer02 |
Hostname | string | 否 | 自定义设置云电脑的主机名称。仅支持设置 AD 办公网络下,操作系统类型是 Windows 的云电脑。 主机名称的命名规则如下:
创建多台云电脑时,可以使用
| testhost |
VolumeEncryptionEnabled | boolean | 否 | 是否开启磁盘加密。 | false |
VolumeEncryptionKey | string | 否 | 开启磁盘加密的情况下使用的 KMS 的密钥 ID。可通过 ListKeys 接口获取。 | 08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4**** |
DesktopTimers | array<object> | 否 | 云电脑定时任务详情。 | |
object | 否 | 云电脑定时任务详情。 | ||
TimerType | string | 否 | 定时任务类型。 | NoOperationReboot |
CronExpression | string | 否 | 定时任务 Cron 表达式。 注意 需要传入 UTC 标准时间,即北京时间每天 0 点应该传入 0 0 16 ? * 1,2,3,4,5,6,7 | 0 40 7 ? * 1,2,3,4,5,6,7 |
Interval | integer | 否 | 时间间隔,单位为分钟。 | 10 |
Enforce | boolean | 否 | 是否强制执行。 枚举值:
| true |
ResetType | string | 否 | 云电脑重置类型。 枚举值:
| RESET_TYPE_SYSTEM |
OperationType | string | 否 | 定时任务操作类型,目前仅断连定时任务支持。 枚举值:
| Shutdown |
AllowClientSetting | boolean | 否 | 是否允许终端用户自行配置定时任务。 | true |
MonthDesktopSetting | object | 否 | 说明
此字段暂不对外开放使用。
| |
UseDuration | integer | 否 | 说明
此字段暂不对外开放使用。
| null |
BuyerId | long | 否 | 说明
此字段暂不对外开放使用。
| null |
DesktopId | string | 否 | 说明
此字段暂不对外开放使用。
| null |
SnapshotPolicyId | string | 否 | 无影自动快照策略 ID。 | sp-28mp6my0l6zow**** |
ResourceGroupId | string | 否 | 无影资源组 ID。 | rg-3mtuc28rx95lx**** |
返回参数
示例
正常返回示例
JSON
格式
{
"OrderId": "123456789",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"DesktopId": [
"[\"ecd-gx2x1dhsmucyy****\"]"
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidEncryptionKey.Missing | Parameter VolumeEncryptionKey is missing. | 开启磁盘加密功能时,加密密钥不可为空 |
400 | InvalidEncryptionKey.NotAuthorized | Eds service cannot access the given VolumeEncryptionKey. | 无法访问未经授权的加密密钥 |
400 | InvalidEncryptionKey.NotFound | The specified VolumeEncryptionKey is not found. | 找不到指定的磁盘加密密钥 |
400 | InvalidImageStatus.NotValid | The specified image status is not valid. | 指定镜像的状态不可用,不支持创建桌面 |
400 | InvalidImageVersion.NotSupported | The specified image version is no longer supported. | 指定的镜像版本已不再支持,请选择其他镜像 |
400 | InvalidMemberIp.DesktopAmount | The desktop amount need to be 1. | 指定IP创建桌面时,桌面数量仅可为1 |
400 | InvalidPolicyGroup.Status | The target policy group is being created. Please try again later. | 目标策略组正在创建中,请稍后再试。 |
400 | Protocol.NotAllowed | Procotol of the image is not allowed. | 不支持该镜像的协议类型,请检查镜像ID |
400 | ExistedHostname | The specified hostname is existed on the domain. | 指定的主机名在当前工作区已存在 |
400 | HostnameCannotCustomizeForLinux | Customizing hostname is not supported for Linux desktop. | 自定义主机名功能不支持Linux桌面 |
400 | IncorrectDirectoryStatus | Only registered directory can create desktop. | 工作区状态错误,仅支持使用已注册的工作区创建桌面 |
400 | IncorrectDirectoryType | The protocol type of directory and desktop do not match. | 指定工作区和目标桌面的协议类型不匹配,请检查 |
400 | InvalidAmount | The specified Amount is not a valid value. | 指定的数量不合法 |
400 | InvalidAmount.NotTimesOfUsers | The specified Amount is notmatch EndUserId size. | 指定的桌面数量不等于待分配用户的数量,请重新指定 |
400 | InvalidDesktopBundle.NotFound | The specified param BundleId is not found. | 指定的BundleId找不到 |
400 | InvalidDirectoryId.NotFound | The specified param DirectoryId is not found. | 无法找到工作区ID,请检查工作区ID是否正确 |
400 | InvalidDirectoryType.NotSupported | The specified DirectoryType is not supported. | 指定的工作区类型不支持创建该桌面 |
400 | InvalidEncryptionEnabled.Invalid | The parameter VolumeEncryptionEnabled is invalid. | 指定加密密钥时,需开启磁盘加密功能 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-31 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-07-22 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-04-29 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-11-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-11-15 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-11-15 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-05-24 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-24 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-24 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-14 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-08-08 | OpenAPI 入参发生变更 | 查看变更详情 |