すべてのプロダクト
Search

このプロダクト

    App Streaming:CreateAppInstanceGroup

    ドキュメントセンター

    App Streaming:CreateAppInstanceGroup

    最終更新日:Jul 05, 2026

    配信グループを作成します。

    操作説明

    この操作を呼び出す前に、Wuying App Service の 課金方法と料金 を理解していることを確認してください。

    配信グループは、エンドユーザーにクラウドアプリケーションを配信するために使用される論理的なグループです。これには、クラウドアプリケーションリソース、クラウドアプリケーションを含むイメージ、リソース管理ポリシー、およびユーザー割り当て設定が含まれます。詳細については、「配信グループの公開」をご参照ください。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    appstreaming:CreateAppInstanceGroup

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AppCenterImageId

    string

    必須

    アプリイメージの ID。ID は Wuying App Service コンソール の [運用] 配下にある [カスタムイメージ] または [システムイメージ] ページから取得できます。

    img-8z4nztpaqvay4****
    ProductType

    string

    必須

    プロダクトタイプ。

    列挙値:

    • CloudApp :

      Wuying App Service

    CloudApp
    AppInstanceGroupName

    string

    任意

    アプリインスタンスグループの名前。

    办公应用
    Users

    array

    任意

    アプリインスタンスグループに追加するユーザー名。

    string

    任意

    アプリインスタンスグループに追加するユーザー名。フォーマットは `Users.N=<username>` です。N は 0 より大きい整数です。

    Users.1=username1 Users.2=username2
    UserInfo

    object

    任意

    アプリインスタンスグループに追加されるユーザーに関する詳細。`Users` パラメーターを指定する場合、このパラメーターは必須です。

    Type

    string

    任意

    ユーザーアカウントのタイプ。

    列挙値:

    • Simple :

      簡便アカウント

    Simple
    ChargeType

    string

    必須

    課金方法。

    列挙値:

    • PostPaid :

      従量課金

    • PrePaid :

      サブスクリプション

    PrePaid
    PromotionId

    string

    任意

    プロモーション ID。GetResourcePrice 操作を呼び出すことでプロモーション ID を取得できます。

    17440009****
    AutoPay

    boolean

    任意

    自動支払いを有効にするかどうかを指定します。

    列挙値:

    • true :

      自動支払いが有効になります。

    • false :

      自動支払いが無効になります。[デフォルト]

    false
    AutoRenew

    boolean

    任意

    自動更新を有効にするかどうかを指定します。

    列挙値:

    • true :

      自動更新が有効になります。

    • false :

      自動更新が無効になります。[デフォルト]

    false
    Period

    integer

    必須

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

    • `PeriodUnit` が `Week` に設定されている場合、有効な値は次のとおりです。

      • 1

    • `PeriodUnit` が `Month` に設定されている場合、有効な値は次のとおりです。

      • 1

      • 2

      • 3

      • 6

    • `PeriodUnit` が `Year` に設定されている場合、有効な値は次のとおりです。

      • 1

      • 2

      • 3

    説明

    `ChargeType` が `PostPaid` に設定されている場合は、このパラメーターを 1 に設定します。

    1
    PeriodUnit

    string

    必須

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

    説明

    このパラメーターは大文字と小文字を区別します。たとえば、`Week` は有効な値ですが、`week` は無効です。`Period` と `PeriodUnit` の無効な組み合わせ (たとえば、`Period` が 2 で `PeriodUnit` が `Week`) を指定した場合、API 呼び出しは成功する可能性がありますが、注文は失敗します。

    説明

    `ChargeType` が `PostPaid` に設定されている場合は、このパラメーターを `Month` に設定します。

    列挙値:

    • Month :

      月

    • Year :

      年

    • Week :

      週

    Week
    SessionTimeout

    integer

    必須

    セッションがタイムアウトするまでのアイドル時間 (分)。ユーザーが切断した後、この期間が経過するとアプリプロセスは終了します。タイムアウトを無効にするには、この値を `-1` に設定します。有効な値は -1 および 3 から 300 までの任意の整数です。デフォルトは `15` です。

    15
    BizRegionId

    string

    必須

    アプリインスタンスグループのリージョン ID。サポートされているリージョンの詳細については、「注意事項」をご参照ください。

    列挙値:

    • cn-shanghai :

      中国 (上海)

    • cn-hangzhou :

      中国 (杭州)

    cn-hangzhou
    ChargeResourceMode

    string

    必須

    課金対象のリソースユニット。

    列挙値:

    • Node :

      ノード単位で課金

    Node
    NodePool

    object

    任意

    ノードプールの設定。

    NodeInstanceType

    string

    任意

    購入するリソースのインスタンスタイプ。ListNodeInstanceType 操作を呼び出して有効な値を取得できます。

    列挙値:

    • appstreaming.vgpu.8c16g.4g :

      Wuying - グラフィックス：8 vCPU、16 GiB メモリ、4 GiB GPU メモリ

    • appstreaming.general.8c16g :

      Wuying - 汎用：8 vCPU、16 GiB メモリ

    • appstreaming.general.4c8g :

      Wuying - 汎用：4 vCPU、8 GiB メモリ

    • appstreaming.vgpu.14c93g.12g :

      Wuying - グラフィックス：14 vCPU、93 GiB メモリ、12 GiB GPU メモリ

    • appstreaming.vgpu.8c31g.16g :

      Wuying - グラフィックス：8 vCPU、31 GiB メモリ、16 GiB GPU メモリ

    appstreaming.general.4c8g
    NodeAmount

    integer

    任意

    購入するリソースの数。有効な値：1～100。

    説明

    • このパラメーターは `サブスクリプション` リソースに必須です。

    • このパラメーターは、スケーリングモード (`StrategyType`) がノード固定数 (`NODE_FIXED`) または使用量ベースの自動スケーリング (`NODE_SCALING_BY_USAGE`) に設定されている場合、従量課金リソースに必須です。

    1
    NodeCapacity

    integer

    任意

    リソースあたりの最大同時セッション数。この制限を超えると、ユーザーエクスペリエンスが低下する可能性があります。有効な値はリソース仕様によって異なります。ListNodeInstanceType 操作を呼び出すことで有効な値を照会できます。

    2
    StrategyType

    string

    任意

    スケーリングモード。

    説明

    • `NODE_FIXED` (ノード固定数)：サブスクリプションリソースと従量課金リソースの両方に適用されます。

    • `NODE_SCALING_BY_USAGE` (使用量ベースの自動スケーリング)：サブスクリプションリソースと従量課金リソースの両方に適用されます。

    • `NODE_SCALING_BY_SCHEDULE` (スケジュールベースのスケーリング)：従量課金リソースにのみ適用されます。

    列挙値:

    • NODE_FIXED :

      ノード固定数 (自動スケーリングは使用されません)

    • NODE_SCALING_BY_SCHEDULE :

      スケジュールベースのスケーリング

    • NODE_SCALING_BY_USAGE :

      自動スケーリング

    NODE_FIXED
    MaxScalingAmount

    integer

    任意

    スケールアウト中に作成するリソースの最大数。このパラメーターは、`StrategyType` が `NODE_SCALING_BY_USAGE` (自動スケーリング) に設定されている場合に必須です。

    10
    MaxIdleAppInstanceAmount

    integer

    任意

    アイドルセッションの最大数。このパラメーターを指定した場合、セッション使用率が `ScalingUsageThreshold` を超え、かつアプリインスタンスグループ内のアイドルセッション数が `MaxIdleAppInstanceAmount` 未満の場合にのみ自動スケーリングイベントがトリガーされます。それ以外の場合、新しいリソースは作成されません。このパラメーターを使用すると、自動スケーリングの動作を制御し、コストを削減できます。

    3
    ScalingStep

    integer

    任意

    各スケールアウトで追加するリソースの数。有効な値：1～10。このパラメーターは、`StrategyType` が `NODE_SCALING_BY_USAGE` (自動スケーリング) に設定されている場合に必須です。

    2
    ScalingUsageThreshold

    string

    任意

    スケールアウトをトリガーするセッション使用率。セッション使用率がこのしきい値を超えると、自動スケーリングイベントがトリガーされます。セッション使用率は、次の数式を使用して計算されます：`セッション使用率 = (アクティブセッション数) / (リソース総数 × リソースあたりの同時セッション数) × 100%`。このパラメーターは、`StrategyType` が `NODE_SCALING_BY_USAGE` (自動スケーリング) に設定されている場合に必須です。有効な値：0～100。デフォルト値：85。

    85
    ScalingDownAfterIdleMinutes

    integer

    任意

    アイドル状態のリソースが解放されるまでの待機時間 (分)。リソースは、アクティブなセッションがない場合にアイドル状態と見なされます。この期間が終了すると、リソースは解放されます。次の例外が適用される場合があります：

    • スケールインが即座にスケールアウトをトリガーする場合、スケーリングループを避けるためにスケールインが防止されます。

    • この期間中にセッションの増加によってスケールアウトがトリガーされた場合、元のスケールインのカウントダウンはキャンセルされ、リセットされます。

    5
    StrategyEnableDate

    string

    任意

    ポリシーが有効になる日付。日付は yyyy-MM-dd 形式で、現在の日付以降である必要があります。このパラメーターは、`StrategyType` が `NODE_SCALING_BY_SCHEDULE` (スケジュールベースのスケーリング) に設定されている場合に必須です。

    2022-08-01
    StrategyDisableDate

    string

    任意

    ポリシーが失効する日付。日付は yyyy-MM-dd 形式である必要があります。有効日と失効日の間の間隔は、7 日から 365 日 (両端を含む) である必要があります。このパラメーターは、`StrategyType` が `NODE_SCALING_BY_SCHEDULE` (スケジュールベースのスケーリング) に設定されている場合に必須です。

    2022-09-08
    WarmUp

    boolean

    任意

    リソースウォーミングを有効にするかどうかを指定します。このパラメーターは、`StrategyType` が `NODE_SCALING_BY_SCHEDULE` (スケジュールベースのスケーリング) に設定されている場合に必須です。

    false
    RecurrenceSchedules

    array<object>

    任意

    ポリシーの定期スケジュール。このパラメーターは、`StrategyType` が `NODE_SCALING_BY_SCHEDULE` (スケジュールベースのスケーリング) に設定されている場合に必須です。

    array<object>

    任意

    定期スケジュール。

    RecurrenceType

    string

    任意

    定期タスクの繰り返しタイプ。`RecurrenceType` と `RecurrenceValues` の両方を指定する必要があります。

    列挙値:

    • weekly :

      定期タスクは週の特定の曜日に繰り返されます。

    weekly
    RecurrenceValues

    array

    任意

    繰り返し値のリスト。

    integer

    任意

    繰り返しの値。

    列挙値:

    • 1 :

      月曜日

    • 2 :

      火曜日

    • 3 :

      水曜日

    • 4 :

      木曜日

    • 5 :

      金曜日

    • 6 :

      土曜日

    • 7 :

      日曜日

    1
    TimerPeriods

    array<object>

    任意

    繰り返し内の期間。期間は次の要件を満たす必要があります：

    • 最大 3 つの期間が許可されます。

    • 期間は重複できません。

    • 2 つの連続する期間の間隔は、少なくとも 5 分である必要があります。

    • 単一の期間の持続時間は、少なくとも 15 分である必要があります。

    • すべての期間は同じ日内である必要があります。

    object

    任意

    繰り返し内の期間。

    StartTime

    string

    任意

    開始時刻。時刻は HH:mm 形式です。

    12:00
    EndTime

    string

    任意

    終了時刻。時刻は HH:mm 形式です。

    15:00
    Amount

    integer

    任意

    リソースの数。

    2
    Network

    object

    任意

    ネットワーク設定。

    説明

    このパラメーターは、ホワイトリストに登録されたユーザーのみが利用できます。使用するには、チケットを送信してください。

    StrategyType

    string

    任意

    ネットワークポリシータイプ。

    列挙値:

    • Mixed :

      混合モード：デュアル NIC と専用パブリック IP アドレスを持つ単一の VPC

    • Shared :

      共有モード：NAT ゲートウェイを介してインターネットにアクセスする単一の NIC

    Shared
    Routes

    array<object>

    任意

    ルート設定。このパラメーターは、`StrategyType` が `Mixed` に設定されている場合にのみ設定できます。

    object

    任意

    ルート設定。

    Destination

    string

    任意

    宛先 CIDR ブロック。

    139.196.XX.XX/32
    Mode

    string

    任意

    ネットワーク出口モード。

    列挙値:

    • Shared :

      NAT ゲートウェイ経由のアクセス

    Shared
    IpExpireMinutes

    integer

    任意

    パブリック IP アドレスが次のサインイン時にローテーションされるまでの期間 (分)。最小値は 60 です。

    60
    OfficeSiteId

    string

    任意

    ワークスペースの ID。

    cn-hongkong+dir-842567****
    VSwitchIds

    array

    任意

    vSwitch ID のリスト。

    • このパラメーターはカスタムワークスペースに対してのみ有効です。

    string

    任意

    vSwitch の ID。

    vsw-m5ef1sjhf7bbvqvvy****
    DomainRules

    array<object>

    任意

    ドメイン名ベースのアクセス制御ルール。

    object

    任意

    ドメイン名ベースのアクセス制御ルール。

    Domain

    string

    任意

    ドメイン名。

    www.example.com
    Policy

    string

    任意

    ポリシーアクション。

    列挙値:

    • allow :

      アクセスを許可

    • block :

      アクセスをブロック

    block
    StoragePolicy

    object

    任意

    ストレージポリシー。

    StorageTypeList

    array

    任意

    ストレージタイプのリスト。

    string

    任意

    ストレージタイプ。

    列挙値:

    • OFF :

      無効

    • PDS :

      ドライブと写真サービス

    PDS
    UserProfile

    object

    任意

    ユーザーデータローミングの設定。

    UserProfileSwitch

    boolean

    任意

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

    列挙値:

    • false :

      無効

    • true :

      有効

    false
    RemoteStorageType

    string

    任意

    ユーザーデータローミングに使用されるリモートストレージタイプ。

    列挙値:

    • NAS :

      Apsara File Storage NAS

    NAS
    RemoteStoragePath

    string

    任意

    ユーザーデータローミングのリモートストレージパス。

    • このパラメーターを空のままにすると、デフォルトでアプリインスタンスグループ ID が使用されます。

    • 同じ VPC 内の複数のアプリインスタンスグループ間でローミングデータを共有するには、すべてのグループに同じパスを使用します。

    ID20250101
    PreOpenAppId

    string

    任意

    事前起動するアプリの ID。

    cag-b2ronxxd****
    VideoPolicy

    object

    任意

    表示ポリシー。

    FrameRate

    integer

    任意

    フレームレート (フレーム/秒、FPS)。

    列挙値:

    • 30 :

      30 FPS

    • 60 :

      60 FPS

    60
    TerminalResolutionAdaptive

    boolean

    任意

    解像度適応を有効にするかどうかを指定します。

    • `true`：セッションの解像度はクライアントの表示サイズに適応します。この場合、`SessionResolutionWidth` と `SessionResolutionHeight` は最大解像度を指定します。

    • `false`：セッションの解像度は固定されます。この場合、解像度は `SessionResolutionWidth` と `SessionResolutionHeight` の値に固定されます。

    列挙値:

    • true :

      true

    • false :

      false

    false
    SessionResolutionWidth

    integer

    任意

    解像度の幅 (ピクセル)。

    1920
    SessionResolutionHeight

    integer

    任意

    解像度の高さ (ピクセル)。

    1080
    StreamingMode

    string

    任意

    ストリーミングモード。このパラメーターは、`Webrtc` パラメーターと組み合わせてストリーミングプロトコルを決定します。

    • `Webrtc` が `true` で `StreamingMode` が `video` の場合、プロトコルは WebRTC ストリーミングです。

    • `Webrtc` が `false` で `StreamingMode` が `video` の場合、プロトコルはビデオストリーミングです。

    • `Webrtc` が `false` で `StreamingMode` が `mix` の場合、プロトコルは混合ストリーミングです。

    列挙値:

    • video :

      ビデオストリーム

    • mix :

      混合ストリーム

    video
    Webrtc

    boolean

    任意

    WebRTC を有効にするかどうかを指定します。このパラメーターは、`StreamingMode` パラメーターと組み合わせてストリーミングプロトコルを決定します。

    • `Webrtc` が `true` で `StreamingMode` が `video` の場合、プロトコルは WebRTC ストリーミングです。

    • `Webrtc` が `false` で `StreamingMode` が `video` の場合、プロトコルはビデオストリーミングです。

    • `Webrtc` が `false` で `StreamingMode` が `mix` の場合、プロトコルは混合ストリーミングです。

    列挙値:

    • true :

      true

    • false :

      false

    true
    RuntimePolicy

    object

    任意

    ランタイムポリシー。

    SessionType

    string

    任意

    セッションタイプ。

    列挙値:

    • CONSOLE :

      コンソールセッション

    • NORMAL :

      RDP セッション

    NORMAL
    DebugMode

    string

    任意

    デバッグモードを有効にするかどうかを指定します。`GetDebugAppInstance` および `CreateImageFromAppInstanceGroup` 操作を呼び出すには、このパラメーターを `ON` に設定する必要があります。

    列挙値:

    • OFF :

      無効

    • ON :

      有効

    OFF
    SessionUserGenerationMode

    string

    任意

    セッションユーザーの生成モード。

    • この値を `wyid` に設定する場合は、`SessionPreOpen` を `false` に設定する必要があります。

    列挙値:

    • wyid :

      wyid

    wyid
    SessionPreOpen

    string

    任意

    セッションの事前起動を有効にするかどうかを指定します。

    • このパラメーターを指定しない場合、この機能はデフォルトで有効になります。

    列挙値:

    • true :

      有効

    • false :

      無効

    false
    PerSessionPerApp

    boolean

    任意

    アプリケーションごとに新しいセッションを作成するかどうかを指定します。

    • この機能を有効にすると、アプリインスタンスグループで複数のアプリケーションを開くと、アプリケーションごとに個別のセッションが作成され、より多くのセッションリソースが消費されます。

    列挙値:

    • true :

      有効

    • false :

      無効

    false
    PersistentAppInstanceScheduleMode

    string

    任意

    永続セッションのスケジューリングモード。

    列挙値:

    • DYNAMIC :

      動的スケジューリング - 永続セッションは異なるノードにスケジュールできます。

    • FIX_NODE :

      固定ノードスケジューリング - 永続セッションは特定のノードにのみスケジュールできます。

    DYNAMIC
    SecurityPolicy

    object

    任意

    セキュリティポリシー。

    ResetAfterUnbind

    boolean

    任意

    バインド解除後にインスタンスをリセットするかどうかを指定します。

    列挙値:

    • true :

      リセット

    • false :

      リセットしない

    true
    SkipUserAuthCheck

    boolean

    任意

    ユーザー権限チェックをスキップするかどうかを指定します。

    列挙値:

    • true :

      チェックしない

    • false :

      チェックする [デフォルト]

    false
    UserDefinePolicy

    object

    任意

    カスタムポリシー

    CustomConfig

    string

    任意

    カスタムポリシーのコンテンツ。コンテンツはイメージバージョンの仕様に準拠する必要があります。このパラメーターを使用するには、チケットを送信してホワイトリストに追加される必要があります。

    [{"target":"agent","config":{"abc":"xxx"}}]
    AppPolicyId

    string

    任意

    ポリシー ID。

    pg-0clfzcy0adpcf****
    ClusterId

    string

    任意

    クラスター ID

    cls-d39iq73l5c0a8****
    SubPayType

    string

    任意

    課金方法のサブタイプ。

    列挙値:

    • postPaid :

      従量課金

    • monthPackage :

      パッケージ (クラウドブラウザでのみサポート)

    • prePaid :

      サブスクリプション

    postPaid
    AppPackageType

    string

    任意

    パッケージタイプ。

    browser.package.5.250.appstreaming.general.basic
    AuthMode

    string

    任意

    配信グループの権限モード。

    列挙値:

    • App :

      アプリケーション権限

    • AppInstanceGroup :

      配信グループ権限

    • Session :

      永続セッション権限

    App
    UserGroupIds

    array

    任意

    権限のあるユーザーグループ ID のリスト。

    string

    任意

    権限のあるユーザーグループ ID。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスデータ。

    RequestId

    string

    リクエストの ID。

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

    object

    アプリインスタンスグループの詳細。

    AppInstanceGroupId

    string

    アプリインスタンスグループの ID。

    aig-9ciijz60n4xsv****
    OrderId

    string

    注文の ID。

    12345****
    NodePoolId

    string

    ノードプールの ID。このパラメーターは、ノードプールも作成された場合にのみ返されます。

    rg-ew7va2g1wl3vm****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "AppInstanceGroupModel": {
    "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
    "OrderId": "12345****",
    "NodePoolId": "rg-ew7va2g1wl3vm****"
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 StockError.NoStock The selected specification is out of stock. Please try again later or select other specifications.
    500 StockError.InvalidResourceRequest Your request cannot be processed currently due to an error. Please try again later.

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

    変更履歴

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