全部產品
Search

搜尋本產品

    Elastic Desktop Service：CreateDesktops

    文件中心

    Elastic Desktop Service：CreateDesktops

    更新時間：Jul 06, 2026

    建立一或多台雲端電腦。建立時若傳入使用者資訊，可直接完成雲端電腦的分配。

    介面說明

    建立雲端電腦前，請先完成以下準備工作：

    呼叫範例：

    使用範本建立輸入參數範例

    {
  "RegionId": "cn-hangzhou",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "cn-hangzhou+dir-xxx",// 需要提前建立辦公網路
  "PolicyGroupId": "system-all-enabled-policy",
  "ChargeType": "PostPaid",
  "BundleId": "b-enterprise_office_8c16g_windows2022"
}

    無範本方式建立範例

    {
  "RegionId": "cn-hangzhou",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "cn-hangzhou+dir-xxx",// 需要提前建立辦公網路
  "PolicyGroupId": "system-all-enabled-policy",
  "ChargeType": "PostPaid",
  "DesktopAttachment": {
    "ImageId": "desktopimage-windows-server-2022-64-asp",
    "SystemDiskSize": "40",
    "DataDiskSize": "0",
    "DefaultLanguage": "zh-CN",
    "DesktopType": "eds.enterprise_office.4c8g"
  }
}

    建立按月小時包輸入參數範例

    {
  "RegionId": "cn-hangzhou",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "cn-hangzhou+dir-xxx",// 需要提前建立辦公網路
  "PolicyGroupId": "system-all-enabled-policy",
  "ChargeType": "PostPaid",
  "DesktopAttachment": {
    "ImageId": "desktopimage-windows-server-2022-64-asp",
    "SystemDiskSize": "40",
    "DataDiskSize": "0",
    "DefaultLanguage": "zh-CN",
    "DesktopType": "eds.enterprise_office.4c8g"
  },
  "MonthDesktopSetting": {
    "UseDuration": "120"
  },
  "Period": "1",
  "PeriodUnit": "Month"
}

    建立 Agent 資源輸入參數範例

    {
  "RegionId": "cn-hangzhou",
  "BundleId": "b-openclaw-linux",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "cn-hangzhou+dir-xxx",// 需要提前建立辦公網路
  "ChargeType": "PostPaid",
  "DesktopAttachment": {
    "DesktopType": "cloud.space.4c.8g"
  },
  "PurchaseOptions": {
    "MonthlyCredits": "120"
  },
  "Period": "1",
  "PeriodUnit": "Month"
}

    如需讓雲端電腦自動執行自訂命令指令碼，可使用 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。未選擇範本 ID 時，可以透過填寫必備欄位完成建立。

    b-je9hani001wfn****
    DesktopName

    string

    否

    雲端電腦名稱。命名規則如下：

    • 不超過 64 個字元。

    • 必須以大小寫字母或中文開頭，不能以 http:// 和 https:// 開頭。

    • 可以包含中文、英文、數字、半形冒號（:）、底線（_）、點號（.）或者連字號（-）。

    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

    否

    雲端電腦的計費方式。

    枚舉值：

    • PostPaid :

      按量付費 [預設值]

    • PrePaid :

      包年包月。

    PrePaid
    Period

    integer

    否

    購買資源的時長。單位由 PeriodUnit 指定。當參數 ChargeType 取值為 PrePaid 時才生效，且為必選值。

    • 如果 PeriodUnit 為 Month，該參數的取值範圍：

      • 1

      • 2

      • 3

      • 6

    • 如果 PeriodUnit 為 Year，該參數的取值範圍：

      • 1

      • 2

      • 3

      • 4

      • 5

    1
    PeriodUnit

    string

    否

    包年包月計費方式的時長單位。

    枚舉值：

    • Month :

      月 [預設值]

    • Year :

      年。

    Month
    AutoPay

    boolean

    否

    是否自動支付。

    枚舉值：

    • true :

      自動支付。請確保帳戶餘額充足，否則會產生異常訂單 [預設值]

    • false :

      只產生訂單，不支付。您可以登入控制台，在使用者中心的我的訂單頁面，根據返回的訂單號進行支付。

    false
    AutoRenew

    boolean

    否

    是否自動續約。當參數 ChargeType 取值為 PrePaid 時才生效。

    枚舉值：

    • true :

      自動續約。續約時長與購買設定的時長保持一致。

    • false :

      不自動續約 [預設值]

    false
    PromotionId

    string

    否

    優惠活動 ID。

    23141
    UserAssignMode

    string

    否

    雲端電腦分配模式。

    說明

    如果未設定 EndUserId，建立的雲端電腦不會分配給使用者。

    枚舉值：

    • ALL :

      如果設定了 EndUserId，則將建立的雲端電腦分配給每個指定的使用者 [預設值]

    • PER_USER :

      如果設定了 EndUserId，則將建立的雲端電腦平均分配給指定的使用者。此時需確保 Amount 的值可以被 EndUserId 的個數（即 N）整除。

    ALL
    Hostname

    string

    否

    自訂設定雲端電腦的主機名稱。僅支援設定 AD 辦公網路下，作業系統類型是 Windows 的雲端電腦。

    主機名稱的命名規則如下：

    • 長度為 2~15 個字元。

    • 支援大小寫字母、數字或者連字號（-）。不能以連字號開頭或者結尾，不能連續使用連字號，不能只使用數字。

    建立多台雲端電腦時，可以使用 name_prefix[begin_number,bits]name_suffix 的命名格式為多台雲端電腦統一命名。例如，設定 Hostname 的取值為 ecd-[1,4]-test，則第一台雲端電腦主機名稱為 ecd-0001-test，第二台雲端電腦主機名稱為 ecd-0002-test，依此類推。

    • name_prefix：主機名稱的前綴。

    • [begin_number,bits]：主機名稱中的有序數字。begin_number 為起始數字，取值支援 0~999999，預設值為 0；bits 為數字位數，取值支援 1~6，預設值為 6。

    • name_suffix：主機名稱的後綴。

    testhost
    EndUserId

    array

    否

    為雲端電腦新增的授權使用者 ID 清單。可設定 1~100 個。

    123456789

    string

    否

    為雲端電腦新增的授權使用者 ID。

    • 在同一時段內，只有一個使用者可以使用該雲端電腦。

    • 如果未設定 EndUserId，建立的雲端電腦不會分配給任何使用者。

    alice
    Tag

    array<object>

    否

    標籤。

    object

    否

    標籤。

    Key

    string

    否

    標籤鍵。可設定 1~20 個。

    TestKey
    Value

    string

    否

    標籤值。可設定 1~20 個。

    TestValue
    DesktopNameSuffix

    boolean

    否

    批次建立雲端電腦時，雲端電腦名稱是否自動增加後綴。

    枚舉值：

    • true :

      自動增加後綴 [預設值]

    • false :

      不增加後綴。

    false
    VolumeEncryptionEnabled

    boolean

    否

    是否開啟磁碟加密。

    枚舉值：

    • true :

      開啟磁碟加密。

    • false :

      不開啟磁碟加密 [預設值]

    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 :

      Base64 編碼。

    • PlainText :

      不編碼，採用明文傳輸。

    Base64
    Content

    string

    否

    命令內容。

    bmV3LWl0ZW0gZDpcdGVzdF91c2VyX2NvbW1hbmRzLnR4dCAtdHlwZSBm****
    ContentType

    string

    否

    命令的語言類型。

    枚舉值：

    • RunPowerShellScript :

      適用於 Windows 執行個體的 PowerShell 命令。

    • RunShellScript :

      適用於 Linux 執行個體 Shell 命令。

    • RunBatScript :

      適用於 Windows 執行個體的 Bat 命令。

    RunPowerShellScript
    BundleModels

    array<object>

    否

    雲端電腦範本清單。

    object

    否

    雲端電腦範本。

    BundleId

    string

    否

    雲端電腦範本 ID。

    b-je9hani001wfn****
    Amount

    integer

    否

    建立的雲端電腦數量。取值範圍為 1~300，預設值為 0。

    1
    EndUserIds

    array

    否

    雲端電腦分配使用者清單。

    string

    否

    使用者名稱。

    alice
    DesktopName

    string

    否

    雲端電腦名稱。命名規則如下：

    • 不超過 64 個字元。

    • 必須以大小寫字母或中文開頭，不能以 http:// 和 https:// 開頭。

    • 可以包含中文、英文、數字、半形冒號（:）、底線（_）、點號（.）或者連字號（-）。

    DemoComputer02
    Hostname

    string

    否

    自訂設定雲端電腦的主機名稱。僅支援設定 AD 辦公網路下，作業系統類型是 Windows 的雲端電腦。

    主機名稱的命名規則如下：

    • 長度為 2~15 個字元。

    • 支援大小寫字母、數字或者連字號（-）。不能以連字號開頭或者結尾，不能連續使用連字號，不能只使用數字。

    建立多台雲端電腦時，可以使用 name_prefix[begin_number,bits]name_suffix 的命名格式為多台雲端電腦統一命名。例如，設定 Hostname 的取值為 ecd-[1,4]-test，則第一台雲端電腦主機名稱為 ecd-0001-test，第二台雲端電腦主機名稱為 ecd-0002-test，依此類推。

    • name_prefix：主機名稱的前綴。

    • [begin_number,bits]：主機名稱中的有序數字。begin_number 為起始數字，取值支援 0~999999，預設值為 0；bits 為數字位數，取值支援 1~6，預設值為 6。

    • name_suffix：主機名稱的後綴。

    testhost
    VolumeEncryptionEnabled

    boolean

    否

    是否開啟磁碟加密。

    false
    VolumeEncryptionKey

    string

    否

    開啟磁碟加密的情況下使用的 KMS 金鑰 ID。可透過 ListKeys 介面獲取。

    08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
    DesktopTimers

    array<object>

    否

    雲端電腦排程任務詳情。該參數在逐步廢棄中，請優先使用 TimerGroupId 參數進行設定。

    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 :

      忽略雲端電腦及連線狀態檢測，強制執行排程任務。

    • false :

      不強制執行。

    true
    ResetType

    string

    否

    雲端電腦重設類型。

    枚舉值：

    • RESET_TYPE_SYSTEM :

      重設系統磁碟。

    • RESET_TYPE_BOTH :

      重設系統磁碟和使用者磁碟。

    RESET_TYPE_SYSTEM
    OperationType

    string

    否

    排程任務操作類型，目前僅斷連排程任務支援。

    枚舉值：

    • Hibernate :

      休眠。

    • Shutdown :

      關機。

    Shutdown
    AllowClientSetting

    boolean

    否

    是否允許終端使用者自行設定排程任務。

    true
    SubnetId

    string

    否

    子網路 ID。

    vsw-bp1m*****
    MonthDesktopSetting

    object

    否

    按月小時包購買參數。

    UseDuration

    integer

    否

    購買按月小時包時的套餐選擇，當前可選值為 120/250/360。

    null
    BuyerId

    integer

    否

    說明

    此欄位暫不對外開放使用。

    null
    DesktopId

    string

    否

    說明

    此欄位暫不對外開放使用。

    null
    SnapshotPolicyId

    string

    否

    無影自動快照原則 ID。

    sp-28mp6my0l6zow****
    ResourceGroupId

    string

    否

    無影資源群組 ID。

    rg-3mtuc28rx95lx****
    DesktopAttachment

    object

    否

    無範本方式輸入參數，在傳入 BundleID 參數時該參數無效。

    ImageId

    string

    否

    映像 ID。

    m-39ddhdb0ggzjx*****
    SystemDiskCategory

    string

    否

    系統磁碟類型。系統磁碟與資料磁碟類型需一致，取值範圍：

    • cloud_auto：SSD 極速雲端硬碟

    • cloud_essd：ESSD 雲端硬碟

    cloud_auto
    SystemDiskSize

    integer

    否

    系統磁碟容量。60~500GiB，每 10GiB 為一個步長，單位為 GiB。

    40
    SystemDiskPerLevel

    string

    否

    ESSD 磁碟效能等級。如果選用了 ESSD 類型磁碟，則需要填入該參數，可選值：

    • PL0

    • PL1

    PL0
    DataDiskSize

    integer

    否

    使用者磁碟容量。40~2040GiB，每 10GiB 為一個步長，單位為 GiB。

    40
    DataDiskCategory

    string

    否

    資料磁碟類型。系統磁碟與資料磁碟類型需一致，取值範圍：

    • cloud_auto：SSD 極速雲端硬碟

    • cloud_essd：ESSD 雲端硬碟

    cloud_auto
    DataDiskPerLevel

    string

    否

    ESSD 磁碟效能等級。如果選用了 ESSD 類型磁碟，則需要填入該參數，可選值：

    • PL0

    • PL1

    PL0
    DefaultLanguage

    string

    否

    語言選擇，可選值：

    • zh-CN

    • zh-HK

    • en-US

    • ja-JP

    zh-CN
    DesktopType

    string

    否

    雲端電腦規格。您可以呼叫 DescribeDesktopTypes 查詢雲端電腦支援的規格 ID。

    eds.enterprise_office.8c16g
    TimerGroupId

    string

    否

    排程任務群組 ID。

    ccg-0caoeogrk9m5****
    SavingPlanId

    string

    否

    說明

    此欄位暫不對外開放使用。

    spn-26c1b7bcrjcI****
    ResellerOwnerUid

    integer

    否

    轉售模式的資源歸屬使用者 ID，非轉售模式無需填寫該參數。

    1828644634819902
    ExtendInfo

    string

    否

    JSON 字串擴充資訊。僅內部客戶可用。

    {}
    AppRuleId

    string

    否

    應用程式管控原則 ID。

    bwr-245d4e0e6b7d42f5afa97eb3fbc7e488
    QosRuleId

    string

    否

    公網限速規則 ID。

    qos-52fqmg6kvyro7zu4l
    ChannelCookie

    string

    否

    說明

    此欄位暫不對外開放使用。

    PBKB1QbqEl2tslEuU6gRrLxvCFBU2M%2FVD0Eru6Oo%2FI9LTU3XQhvq3PGMWarE%2BPJdkNvCqT3blqlRSthNy4A%2BJQ%3D%3D
    PurchaseOptions

    object

    否

    特定購買類型的額外參數。

    MonthlyCredits

    integer

    否

    月積分包，用於購買 Agent 資源時的積分套餐選擇，當前可選值為 200/1600/4000。

    200
    OuPath

    string

    否

    OU 路徑，指定後，雲端電腦將加入 AD 對應的 OU 下。

    test.com/wuyingtest/computers
    SubPayType

    string

    否

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資訊集合。

    OrderId

    string

    訂單 ID。

    說明

    當請求參數 ChargeType 取值為 PrePaid 時，返回該參數。

    123456789
    RequestId

    string

    請求 ID。

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

    array

    雲端電腦 ID 返回集合資訊，如果一次呼叫建立了多個雲端電腦，將返回多個雲端電腦 ID。

    string

    雲端電腦 ID。

    ["ecd-gx2x1dhsmucyy****"]

    樣本

    正常返回樣本

    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.
    400 InvalidPolicyGroup.Status The target policy group is being created. Please try again later.
    400 Protocol.NotAllowed Procotol of the image is not allowed.
    400 ExistedHostname The specified hostname is existed on the domain.
    400 HostnameCannotCustomizeForLinux Customizing hostname is not supported for Linux desktop.
    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.
    400 InvalidDirectoryId.NotFound The specified param DirectoryId is not found.
    400 InvalidDirectoryType.NotSupported The specified DirectoryType is not supported.
    400 InvalidEncryptionEnabled.Invalid The parameter VolumeEncryptionEnabled is invalid.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。