すべてのプロダクト
Search

このプロダクト

    Elastic Desktop Service:CreateDesktops

    ドキュメントセンター

    Elastic Desktop Service:CreateDesktops

    最終更新日:Jul 06, 2026

    1 つ以上のクラウドデスクトップを作成します。作成時にユーザー情報を指定した場合、クラウドデスクトップは直接ユーザーに割り当てられます。

    操作説明

    クラウドデスクトップを作成する前に、以下の準備を完了してください。

    • オフィスネットワーク（旧ワークスペース）およびユーザーを作成します。詳細については、以下の API 操作またはドキュメントを参照してください。

    • CreatePolicyGroup を呼び出してポリシーを作成するか、既存のポリシーが利用可能であることを確認します。

    呼び出し例:

    テンプレートを使用した作成例

    {
  "RegionId": "ap-southeast-1",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "ap-southeast-1+dir-xxx",// 事前にオフィスネットワークを作成してください
  "PolicyGroupId": "system-all-enabled-policy",
  "ChargeType": "PostPaid",
  "BundleId": "b-enterprise_office_8c16g_windows2022"
}

    テンプレートを使用しない作成例

    {
  "RegionId": "ap-southeast-1",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "ap-southeast-1+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": "ap-southeast-1",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "ap-southeast-1+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"
}

    エージェントリソースの作成例

    {
  "RegionId": "ap-southeast-1",
  "BundleId": "b-openclaw-linux",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "ap-southeast-1+dir-xxx",// 事前にオフィスネットワークを作成してください
  "ChargeType": "PostPaid",
  "DesktopAttachment": {
    "DesktopType": "cloud.space.4c.8g"
  },
  "PurchaseOptions": {
    "MonthlyCredits": "120"
  },
  "Period": "1",
  "PeriodUnit": "Month"
}

    クラウドデスクトップでカスタムコマンドスクリプトを自動的に実行するには、UserCommands フィールドを使用してカスタムコマンドを設定します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecd:CreateDesktops

    create

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions を呼び出して、WUYING Workspace でサポートされているリージョンをクエリできます。

    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 :

      注文は生成されますが支払いは行われません。コンソールにログインし、ユーザーセンターの [注文] ページに移動して、返された注文 ID に基づいて支払いを完了できます。

    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、2 番目のクラウドデスクトップのホスト名は 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 個のユーザー ID を指定できます。

    123456789

    string

    任意

    クラウドデスクトップに追加する許可されるユーザー ID。

    • 一度にクラウドデスクトップを使用できるユーザーは 1 人のみです。

    • 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

    任意

    クラウドディスク暗号化に使用される Key Management Service (KMS) キーの ID。 ListKeys を呼び出してキー ID を取得できます。

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

    string

    任意

    クラウドデスクトップの非公開 IP アドレス。

    10.0.0.1
    UserCommands

    array<object>

    任意

    カスタムコマンドスクリプトデータ。

    object

    任意

    カスタムコマンドスクリプトデータ。

    ContentEncoding

    string

    任意

    コマンド内容 (CommandContent) のエンコーディング方式。デフォルト値: base64

    列挙値:

    • 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、2 番目のクラウドデスクトップのホスト名は 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

    任意

    クラウドディスク暗号化に使用される Key Management Service (KMS) キーの ID。 ListKeys を呼び出してキー ID を取得できます。

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

    array<object>

    任意

    クラウドデスクトップの定期タスク詳細。このパラメーターは非推奨です。代わりに TimerGroupId パラメーターを使用してください。

    object

    任意

    クラウドデスクトップの定期タスク詳細。

    TimerType

    string

    任意

    定期タスクのタイプ。

    NoOperationReboot
    CronExpression

    string

    任意

    定期タスクの cron 式。

    重要 時間は UTC で指定してください。たとえば、毎日 00:00 (UTC+8) にタスクをスケジュールするには、値を 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

    任意

    WUYING 自動スナップショットポリシー ID。

    sp-28mp6my0l6zow****
    ResourceGroupId

    string

    任意

    WUYING リソースグループ ID。

    rg-3mtuc28rx95lx****
    DesktopAttachment

    object

    任意

    テンプレートを使用せずにクラウドデスクトップを作成するためのパラメーター。このパラメーターは、BundleId パラメーターが指定されている場合は無効です。

    ImageId

    string

    任意

    イメージ ID。

    m-39ddhdb0ggzjx*****
    SystemDiskCategory

    string

    任意

    システムクラウドディスクタイプ。システムクラウドディスクタイプはデータクラウドディスクタイプと同じである必要があります。有効な値:

    • cloud_auto: 標準 SSD ultra クラウドディスク

    • cloud_essd: ESSD クラウドディスク

    cloud_auto
    SystemDiskSize

    integer

    任意

    システムクラウドディスク容量。有効な値: 60～500 GiB、10 GiB 刻み。

    40
    SystemDiskPerLevel

    string

    任意

    ESSD クラウドディスクのパフォーマンスレベル (PL)。このパラメーターは、ESSD クラウドディスクを選択した場合に必須です。有効な値:

    • PL0

    • PL1

    PL0
    DataDiskSize

    integer

    任意

    ユーザークラウドディスク容量。有効な値: 40～2040 GiB、10 GiB 刻み。

    40
    DataDiskCategory

    string

    任意

    データクラウドディスクタイプ。システムクラウドディスクタイプはデータクラウドディスクタイプと同じである必要があります。有効な値:

    • cloud_auto: 標準 SSD ultra クラウドディスク

    • cloud_essd: ESSD クラウドディスク

    cloud_auto
    DataDiskPerLevel

    string

    任意

    ESSD クラウドディスクのパフォーマンスレベル (PL)。このパラメーターは、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

    任意

    エージェントリソースを購入するための月額クレジットパッケージ。有効な値: 200、1600、4000。

    200
    OuPath

    string

    任意

    OU パス。指定した場合、クラウドデスクトップは Active Directory (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 のリスト。1 回の呼び出しで複数のクラウドデスクトップが作成された場合、複数のクラウドデスクトップ ID が返されます。

    string

    クラウドデスクトップ ID。

    ["ecd-gx2x1dhsmucyy****"]

    例

    成功レスポンス

    JSONJSON

    {
  "OrderId": "123456789",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "DesktopId": [
    "[\"ecd-gx2x1dhsmucyy****\"]"
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。