創建一臺或多臺云電腦。創建時若傳入用戶信息,可直接完成云電腦的分配。
接口說明
創建云電腦前,請先完成以下準備工作:
- 已創建辦公網絡(原工作區)和用戶。相關接口或文檔請參見:
- 便捷辦公網絡: CreateSimpleOfficeSite 、 CreateUsers 。
- AD 辦公網絡: CreateADConnectorOfficeSite 、創建 AD 用戶。
- 已調用 CreateBundle 創建云電腦模板,或確認使用已有云電腦模板。
- 已調用 CreatePolicyGroup 創建策略,或確認使用已有策略。
如需讓云電腦自動執行自定義命令腳本,可使用UserCommands
字段配置自定義命令。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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-09-27 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
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 入參發生變更 | 查看變更詳情 |