すべてのプロダクト
Search

このプロダクト

    Elastic Desktop Service:CreateDesktopGroup

    ドキュメントセンター

    Elastic Desktop Service:CreateDesktopGroup

    最終更新日:May 12, 2026

    共有 EDS を作成します。

    操作説明

    • 共有デスクトップの機能、ユースケース、制限事項、スケーリングポリシーなどの詳細については、「共有デスクトップ (旧デスクトッププール) の概要」をご参照ください。

    • この API を呼び出す前に、オフィスネットワーク、デスクトップテンプレート、ポリシーなどの必要なリソースが作成済みであることを確認してください。

    今すぐお試しください

    この 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:CreateDesktopGroup

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID です。Elastic Desktop Service (EDS) がサポートするリージョンを確認するには、DescribeRegions API を呼び出します。

    cn-hangzhou
    BundleId

    string

    任意

    バンドル ID です。

    b-je9hani001wfn****
    OfficeSiteId

    string

    必須

    デスクトップ用のオフィスネットワークの ID です。

    cn-hangzhou+os-c5cy7q578s8jc****
    PolicyGroupId

    string

    必須

    デスクトップに適用するポリシーの ID です。

    pg-9c2d6t2dwflqr****
    DesktopGroupName

    string

    任意

    デスクトップグループの名前です。長さは 1～30 文字で、英字または漢字で始まる必要があります。http:// または https:// で始めることはできません。名前に使用できる文字は、漢字、英字、数字、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) です。

    SharedComputers01
    DirectoryId

    string

    任意

    ディレクトリ ID です。

    説明

    このパラメーターはまだ利用できません。

    dri-uf62w3qzt4aigvlcb****
    ScaleStrategyId

    string

    任意

    スケーリングポリシー ID です。

    説明

    このパラメーターはまだ利用できません。

    ss-f9dkjz6vw3aaw****
    VpcId

    string

    任意

    デスクトップのオフィスネットワークが含まれる Virtual Private Cloud (VPC) の ID です。

    説明

    このパラメーターはまだ利用できません。

    vpc-uf6w8u60n8xbkg5el****
    DefaultInitDesktopCount

    integer

    任意

    デスクトップグループに作成するデスクトップのデフォルト数です。デフォルト値は 1 です。

    1
    KeepDuration

    integer

    任意

    ユーザーが切断した後、セッションがアクティブなまま維持される期間です。単位はミリ秒です。有効な値の範囲は 180000 (3 分) から 345600000 (4 日) です。値が 0 の場合、セッションは無期限に保持されます。

    ユーザーがこの期間内に再接続すると、セッションを再開できます。期間内に再接続されなかった場合、セッションは終了し、保存されていないデータはすべて失われます。

    180000
    ChargeType

    string

    必須

    デスクトップの課金方法です。

    列挙値:

    • PostPaid :

      従量課金

    • PrePaid :

      サブスクリプション

    PrePaid
    Period

    integer

    任意

    デスクトップのサブスクリプション期間です。このパラメーターは、ChargeType が PrePaid に設定されている場合にのみ必須です。期間の単位は PeriodUnit パラメーターで指定します。

    • PeriodUnit が Month の場合、有効な値は次のとおりです：

      • 1

      • 2

      • 3

      • 6

    • PeriodUnit が Year の場合、有効な値は次のとおりです：

      • 1

      • 2

      • 3

      • 4

      • 5

    1
    PeriodUnit

    string

    任意

    サブスクリプション期間の単位です。

    列挙値:

    • Month :

      月

    • Year :

      年

    Month
    OwnType

    integer

    任意

    デスクトップのタイプです。

    説明

    このパラメーターはまだ利用できません。

    列挙値:

    • 0 :

      個人 (シングルセッション)

    • 1 :

      共有 (マルチセッション)

    0
    AutoPay

    boolean

    任意

    サブスクリプション注文の支払いを自動的に行うかどうかを指定します。

    true
    Comments

    string

    任意

    デスクトップグループの説明またはコメントです。

    comment
    MinDesktopsCount

    integer

    任意

    サブスクリプション方式のデスクトップグループにおけるデスクトップの最小数です。このパラメーターは、ChargeType が PrePaid の場合にのみ必須です。有効な値の範囲は 0～MaxDesktopsCount です。デフォルト値は 1 です。

    1
    MaxDesktopsCount

    integer

    任意

    従量課金方式のデスクトップグループにおけるデスクトップの最大数です。有効な値の範囲は 0～500 です。

    50
    AllowAutoSetup

    integer

    任意

    サブスクリプション方式のデスクトップグループでデスクトップの自動作成を許可するかどうかを指定します。このパラメーターは、ChargeType が PrePaid に設定されている場合に必須です。

    列挙値:

    • 0 :

      許可しない

    • 1 :

      許可する

    1
    AllowBufferCount

    integer

    任意

    従量課金方式のデスクトップグループで予約するデスクトップの数です。このパラメーターは、ChargeType が PostPaid に設定されている場合に必須です。有効な値は次の通りです：

    • 0：デスクトップを予約しません。

    • N：N 台のデスクトップを予約します。N には 1～100 の整数を指定します。

    説明

    デスクトップが予約されていない場合、ユーザーは新しいデスクトップが作成されて起動するのを待つ必要があり、接続が遅れる可能性があります。接続時間を短縮するために、適切な数のデスクトップを予約することを推奨します。

    1
    ClientToken

    string

    任意

    リクエストのべき等性を保証するためのクライアントトークンです。クライアント側でトークンを生成しますが、リクエストごとに一意にする必要があります。トークンは ASCII 文字のみ使用でき、長さが 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。

    123e4567-e89b-12d3-a456-426655440000
    EndUserIds

    array

    任意

    デスクトップグループに割り当てるユーザー ID の配列です。

    string

    任意

    ユーザー ID です。

    alice
    ResetType

    integer

    任意

    デスクトップのリセットタイプです。

    列挙値:

    • 0 :

      リセットしない。

    • 1 :

      システムディスクのみをリセットする。

    • 2 :

      ユーザーディスクのみをリセットする。

    • 3 :

      システムディスクとユーザーディスクの両方をリセットする。

    0
    LoadPolicy

    integer

    任意

    マルチセッションのデスクトップグループの負荷分散ポリシーです。

    説明

    このパラメーターはまだ利用できません。

    列挙値:

    • 0 :

      深さ優先

    • 1 :

      幅優先

    0
    BindAmount

    integer

    任意

    マルチセッションのデスクトップグループのデスクトップあたりで許可される同時セッションの数です。

    説明

    このパラメーターはまだ利用できません。

    2
    Classify

    string

    任意

    デスクトップグループのタイプです。

    説明

    このパラメーターはまだ利用できません。

    列挙値:

    • teacher :

      教師用デスクトップ

    • student :

      学生用デスクトップ

    teacher
    AllClassifyUsers

    boolean

    任意

    デスクトップグループのカテゴリ内のすべてのユーザーに権限を付与するかどうかを指定します。

    説明

    このパラメーターはまだ利用できません。

    Alice
    VolumeEncryptionEnabled

    boolean

    任意

    ディスク暗号化を有効にするかどうかを指定します。

    false
    VolumeEncryptionKey

    string

    任意

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

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

    number

    任意

    マルチセッションのデスクトップグループでオートスケーリングをトリガーするセッション使用率のしきい値です。セッション使用率は、次の式で計算されます：

    セッション使用率 = (接続セッション数 / (デスクトップ総数 × デスクトップあたりの最大セッション数)) × 100%

    セッション使用率がこのしきい値に達すると、新しいデスクトップが作成されます。セッション使用率がこのしきい値を下回ると、グループは余剰なデスクトップを削除してスケールインします。

    説明

    このパラメーターはまだ利用できません。

    0.5
    ConnectDuration

    integer

    任意

    接続セッションの最大期間です。セッション期間がこの値に達すると、セッションは自動的に切断されます。単位はミリ秒です。有効な値の範囲は 900000 (15 分) から 345600000 (4 日) です。

    900000
    IdleDisconnectDuration

    integer

    任意

    セッションが自動的に切断されるまでの最大アイドル期間です。キーボードまたはマウスの入力がない場合、セッションはアイドル状態と見なされます。単位はミリ秒です。有効な値の範囲は 360000 (6 分) から 3600000 (60 分) です。

    切断の 30 秒前に、データの損失を防ぐために作業を保存するよう促すメッセージが表示されます。

    説明

    このパラメーターは、バージョン 1.0.2 以降のイメージから作成されたデスクトップにのみ適用されます。

    360000
    StopDuration

    integer

    任意

    デスクトップが自動的に停止されるまでのアイドル時間です。停止したデスクトップに接続すると、自動的に起動します。単位はミリ秒です。

    300000
    ProfileFollowSwitch

    boolean

    任意

    ユーザーデータローミングを有効にするかどうかを指定します。

    説明

    このパラメーターはまだ利用できません。

    false
    FileSystemId

    string

    任意

    ユーザーデータローミングに使用される Apsara File Storage NAS ファイルシステムの ID です。

    説明

    このパラメーターはまだ利用できません。

    kegd-nas-****
    BuyDesktopsCount

    integer

    任意

    • サブスクリプションのデスクトップグループの場合：購入するデスクトップの数を指定します。有効な値の範囲は 0～200 です。

    • 従量課金のデスクトップグループの場合：グループ内のデスクトップの最小数を指定します。有効な値の範囲は 0～MaxDesktopsCount です。デフォルト値は 1 です。

    3
    GroupVersion

    integer

    任意

    デスクトップグループのバージョンです。

    2
    AutoRenew

    boolean

    任意

    サブスクリプションのデスクトップグループの自動更新を有効にするかどうかを指定します。

    列挙値:

    • true :

      自動更新を有効にします。

    • false :

      自動更新を無効にします。

    false
    Tag

    array<object>

    任意

    タグのリストです。最大 20 個のタグを指定できます。

    object

    任意

    タグです。

    Key

    string

    必須

    タグキーです。キーは空文字列にできず、長さは 128 文字までです。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。

    TestKey
    Value

    string

    必須

    タグの値です。値は空文字列にできます。長さは 128 文字までで、acs: で始めることはできず、http:// または https:// を含めることはできません。

    TestValue
    PromotionId

    string

    任意

    プロモーション ID です。

    youhuiquan_promotion_option_id_*****
    ImageId

    string

    任意

    イメージ ID です。

    m-gx2x1dhsmusr2****
    SystemDiskCategory

    string

    任意

    システムディスクのタイプです。

    列挙値:

    • cloud_auto :

      ESSD AutoPL クラウドディスク

    • cloud_essd :

      拡張 SSD (ESSD)

    cloud_auto
    SystemDiskSize

    integer

    任意

    システムディスクのサイズです。単位は GiB です。

    説明

    システムディスクのサイズは、イメージのサイズ以上である必要があります。

    80
    SystemDiskPerLevel

    string

    任意

    ESSD のパフォーマンスレベル (PL) です。デフォルト値は PL0 です。

    列挙値:

    • PL1 :

      PL1

    • PL0 :

      PL0

    PL0
    DataDiskCategory

    string

    任意

    データディスクのタイプです。

    列挙値:

    • cloud_auto :

      ESSD AutoPL クラウドディスク

    • cloud_essd :

      拡張 SSD (ESSD)

    cloud_auto
    DataDiskSize

    integer

    任意

    データディスクのサイズです。単位は GiB です。値は 20 の倍数で、0～16,380 の範囲である必要があります。

    • 値が 0 の場合、データディスクがアタッチされないことを意味します。

    • 選択したバンドルが SSD を使用する場合、最小データディスクサイズは 20 GiB です。

    デフォルト値： 0

    80
    DataDiskPerLevel

    string

    任意

    ESSD のパフォーマンスレベル (PL) です。デフォルト値は PL0 です。

    列挙値:

    • PL1 :

      PL1

    • PL0 :

      PL0

    PL0
    DefaultLanguage

    string

    任意

    システム言語です。

    列挙値:

    • en-US :

      英語

    • zh-HK :

      繁体字中国語

    • zh-CN :

      簡体字中国語

    • ja-JP :

      日本語

    zh-CN
    DesktopType

    string

    任意

    デスクトップタイプです。DescribeDesktopTypes API を呼び出して、サポートされているデスクトップタイプを照会できます。

    eds.enterprise_office.16c64g
    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
    MultiResource

    boolean

    任意

    デスクトップグループを作成するかどうかを指定します。

    列挙値:

    • true :

      デスクトップグループを作成します。

    • false :

      1つ以上の個別のデスクトップを作成します。

    false
    ExclusiveType

    string

    任意

    プールタイプを指定します。静的プールを作成するには、このパラメーターを Exclusive に設定します。SessionType が MultipleSession の場合は必須です。

    Exclusive
    GroupAmount

    integer

    任意

    作成する個別のデスクトップの数です。このパラメーターは、MultiResource が false に設定されている場合にのみ必須です。有効な値の範囲は 1～5 です。デフォルト値は 1 です。

    1
    SessionType

    string

    任意

    セッションタイプです。

    列挙値:

    • SingleSession :

      シングルセッション

    • MultipleSession :

      マルチセッション

    SingleSession
    TimerGroupId

    string

    任意

    スケジュールされたタスクグループの ID です。

    ccg-0caoeogrk9m5****
    SnapshotPolicyId

    string

    任意

    自動スナップショットポリシーの ID です。

    sp-28mp6my0l6zow****
    ResellerOwnerUid

    integer

    任意

    UserOuPath

    string

    任意

    UserGroupName

    string

    任意

    SimpleUserGroupId

    string

    任意

    DeleteDuration

    integer

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスデータ。

    DesktopGroupId

    string

    デスクトップグループの ID。

    dg-2i8qxpv6t1a03****
    RequestId

    string

    リクエスト ID。

    3EB7FCEE-D731-4948-85A3-4B2C341CA983
    OrderIds

    array

    注文 ID のリスト。

    string

    ChargeType が PrePaid に設定されている場合にのみ返される注文 ID。

    123456789
    DesktopGroupIds

    array

    デスクトップグループ ID のリスト。

    string

    デスクトップグループ ID。

    ['dg-1np2yupx0uim****']

    例

    成功レスポンス

    JSONJSON

    {
  "DesktopGroupId": "dg-2i8qxpv6t1a03****",
  "RequestId": "3EB7FCEE-D731-4948-85A3-4B2C341CA983",
  "OrderIds": [
    "123456789"
  ],
  "DesktopGroupIds": [
    "['dg-1np2yupx0uim****']"
  ]
}

    エラーコード

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

    変更履歴

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