配信グループを作成します。
操作説明
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
appstreaming:CreateAppInstanceGroup |
create |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppCenterImageId |
string |
必須 |
アプリケーションイメージの ID。この ID は、WUYING CloudApp コンソール の [O&M] > [カスタムイメージ] または [システムイメージ] ページから取得できます。 |
img-8z4nztpaqvay4**** |
| ProductType |
string |
必須 |
プロダクトタイプ。 列挙値:
|
CloudApp |
| AppInstanceGroupName |
string |
任意 |
配信グループの名前。 |
OfficeApp |
| Users |
array |
任意 |
配信グループの割り当てユーザーとして追加するユーザー名のリスト。 |
|
|
string |
任意 |
配信グループの割り当てユーザーとして追加するユーザー名。フォーマット: Users.N= |
Users.1=ユーザー名1 Users.2=ユーザー名2 |
|
| UserInfo |
object |
任意 |
配信グループの割り当てユーザーとして追加するユーザーの情報。Users パラメーターが指定されている場合、このパラメーターは必須です。 |
|
| Type |
string |
任意 |
ユーザーアカウントのタイプ。 列挙値:
|
Simple |
| ChargeType |
string |
必須 |
課金方法。 列挙値:
|
PrePaid |
| PromotionId |
string |
任意 |
プロモーション ID。この ID は、 GetResourcePrice 操作の呼び出しにより取得できます。 |
17440009**** |
| AutoPay |
boolean |
任意 |
自動支払いを有効にするかどうかを指定します。 列挙値:
|
false |
| AutoRenew |
boolean |
任意 |
自動更新を有効にするかどうかを指定します。 列挙値:
|
false |
| Period |
integer |
必須 |
ChargeType が PrePaid にセットされている場合のリソースを購入する持続時間。この場合、このパラメーターは必須です。単位は PeriodUnit で指定します。
説明
ChargeType が PostPaid にセットされている場合は、このパラメーターを固定値 1 にセットします。 |
1 |
| PeriodUnit |
string |
必須 |
ChargeType が PrePaid にセットされている場合のサブスクリプション期間の単位。 説明
このパラメーターでは大文字と小文字が区別されます。たとえば、Week は有効ですが、week は無効です。 また、2 Week のようにリクエストパラメーターが有効な組み合わせと一致しない場合、API 呼び出しは成功しますが、注文の位相でエラーが発生します。 説明
ChargeType が PostPaid にセットされている場合は、このパラメーターを固定値 Month にセットします。 列挙値:
|
Week |
| SessionTimeout |
integer |
必須 |
アプリケーションの回収時間 (分単位)。エンドユーザーがクラウドアプリケーションから切断されてから一定時間経過すると、クラウドアプリケーションのプロセスが終了します。この期間がアプリケーションの回収時間です。アプリケーションを回収しない場合は、このパラメーターを |
15 |
| BizRegionId |
string |
必須 |
配信グループのリージョン ID。サポートされているリージョンのフォーマットと詳細については、「使用制限」を参照してください。 列挙値:
|
cn-hangzhou |
| ChargeResourceMode |
string |
必須 |
販売モード。 列挙値:
|
Node |
| NodePool |
object |
任意 |
ノードプールオブジェクト。 |
|
| NodeInstanceType |
string |
任意 |
購入するリソースのインスタンスタイプ ID。この ID は、 ListNodeInstanceType 操作の呼び出しにより取得できます。 列挙値:
|
appstreaming.general.4c8g |
| NodeAmount |
integer |
任意 |
購入するリソース数。有効な値: 1~100。
|
1 |
| NodeCapacity |
integer |
任意 |
同時会話数。これは、1 つのリソースが同時にハンドルできる会話数です。同時会話数が多すぎると、アプリケーションの操作性が低下する可能性があります。有効な値はリソース仕様によって異なります。各リソース仕様の有効な値は、ListNodeInstanceType 操作の呼び出しにより取得できます。 |
2 |
| StrategyType |
string |
任意 |
スケーリングモード。 説明
列挙値:
|
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~120。デフォルト値: 5。以下の例外が適用されます。
|
5 |
| StrategyEnableDate |
string |
任意 |
ポリシーが有効になる日付。フォーマット: yyyy-MM-dd。日付は現在の日付と同じかそれ以降である必要があります。StrategyType (スケーリングモードレート) が NODE_SCALING_BY_SCHEDULE (スケジュールされたスケーリング) に設定されている場合、このパラメーターは必須です。 |
2022-08-01 |
| StrategyDisableDate |
string |
任意 |
ポリシーが失効する日付。フォーマット: yyyy-MM-dd。失効日と有効になる日の間隔は、7 日以上 1 年以下である必要があります。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 |
任意 |
ポリシー実行スケジュールのタイプ。 列挙値:
|
weekly |
| RecurrenceValues |
array |
任意 |
ポリシー実行スケジュールの値のリスト。 |
|
|
integer |
任意 |
ポリシー実行スケジュールの値。 列挙値:
|
1 |
|
| TimerPeriods |
array<object> |
任意 |
ポリシー実行スケジュールの時間のリスト。時間設定の要件は以下のとおりです。
|
|
|
object |
任意 |
ポリシー実行スケジュールの時間帯。 |
||
| StartTime |
string |
任意 |
開始時刻。フォーマット: HH:mm。 |
12:00 |
| EndTime |
string |
任意 |
終了時刻。フォーマット: HH:mm。 |
15:00 |
| Amount |
integer |
任意 |
リソース数。 |
2 |
| Network |
object |
任意 |
ネットワーク構成。 説明
このパラメーターを使用するには、チケットを起票してください。 |
|
| StrategyType |
string |
任意 |
ネットワークポリシーのタイプ。 列挙値:
|
Shared |
| Routes |
array<object> |
任意 |
ルート構成。このパラメーターは、ネットワークポリシーレート (StrategyType) が混在モード (Mixed) に設定されている場合にのみ構成できます。 |
|
|
object |
任意 |
ルート構成。 |
||
| Destination |
string |
任意 |
CIDR フォーマットのアクセス送信先。 |
139.196.XX.XX/32 |
| Mode |
string |
任意 |
ネットワークエグレスモード。 列挙値:
|
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 |
任意 |
ポリシー値。 列挙値:
|
block |
| StoragePolicy |
object |
任意 |
ストレージポリシー。 |
|
| StorageTypeList |
array |
任意 |
ストレージタイプのリスト。 |
|
|
string |
任意 |
ストレージタイプ。 列挙値:
|
PDS |
|
| UserProfile |
object |
任意 |
ユーザーデータローミング構成。 |
|
| UserProfileSwitch |
boolean |
任意 |
ユーザーデータローミングを有効にするかどうかを指定します。 列挙値:
|
false |
| RemoteStorageType |
string |
任意 |
ユーザーデータローミングに使用されるリモートストレージタイプ。 列挙値:
|
NAS |
| RemoteStoragePath |
string |
任意 |
ユーザーデータローミング用のリモートストレージパス。
|
ID20250101 |
| PreOpenAppId |
string |
任意 |
事前起動アプリケーション ID。 |
cag-b2ronxxd**** |
| VideoPolicy |
object |
任意 |
表示ポリシー。 |
|
| FrameRate |
integer |
任意 |
フレームレート (FPS)。 列挙値:
|
60 |
| TerminalResolutionAdaptive |
boolean |
任意 |
適応型解像度を使用するかどうかを指定します。
列挙値:
|
false |
| SessionResolutionWidth |
integer |
任意 |
解像度の幅。単位: ピクセル。 |
1920 |
| SessionResolutionHeight |
integer |
任意 |
解像度の高さ。単位: ピクセル。 |
1080 |
| StreamingMode |
string |
任意 |
ストリーミングモード。このパラメーターは、Webrtc パラメーターと組み合わせてプロトコルの種類を指定するために使用されます。
列挙値:
|
video |
| Webrtc |
boolean |
任意 |
WebRTC を有効にするかどうかを指定します。このパラメーターは、StreamingMode パラメーターと組み合わせてプロトコルの種類を指定するために使用されます。
列挙値:
|
true |
| RuntimePolicy |
object |
任意 |
ランタイムポリシー。 |
|
| SessionType |
string |
任意 |
会話タイプ。 列挙値:
|
NORMAL |
| DebugMode |
string |
任意 |
デバッグモードを有効にするかどうかを指定します。GetDebugAppInstance および CreateImageFromAppInstanceGroup 操作を呼び出すには、このパラメーターを ON に設定します。 列挙値:
|
OFF |
| SessionUserGenerationMode |
string |
任意 |
会話ユーザーの生成モード。
列挙値:
|
wyid |
| SessionPreOpen |
string |
任意 |
会話の事前オープンを有効にするかどうかを指定します。
列挙値:
|
false |
| PerSessionPerApp |
boolean |
任意 |
会話ごとに 1 つのアプリケーションのみを許可するかどうかを指定します。
列挙値:
|
false |
| PersistentAppInstanceScheduleMode |
string |
任意 |
永続会話スケジューリングモード。 列挙値:
|
DYNAMIC |
| SecurityPolicy |
object |
任意 |
セキュリティポリシー。 |
|
| ResetAfterUnbind |
boolean |
任意 |
バインド解除後にリセットするかどうかを指定します。 列挙値:
|
true |
| SkipUserAuthCheck |
boolean |
任意 |
ユーザー権限付与の検証をスキップするかどうかを指定します。 列挙値:
|
false |
| UserDefinePolicy |
object |
任意 |
ユーザー定義ポリシー。 |
|
| CustomConfig |
string |
任意 |
カスタムポリシーの内容。内容はイメージバージョンの仕様に準拠している必要があります。このパラメーターを使用するには、チケットを提出してホワイトリストアクセスをリクエストしてください。 |
[{"target":"agent","config":{"abc":"xxx"}}] |
| AppPolicyId |
string |
任意 |
ポリシー ID。 |
pg-0clfzcy0adpcf**** |
| ClusterId |
string |
任意 |
クラスター ID。 |
cls-d39iq73l5c0a8**** |
| SubPayType |
string |
任意 |
課金方法のサブタイプ。 列挙値:
|
postPaid |
| AppPackageType |
string |
任意 |
パッケージタイプ。 |
browser.パッケージ.5.250.appstreaming.general.basic |
| AuthMode |
string |
任意 |
配信グループの権限付与モード。 列挙値:
|
App |
| UserGroupIds |
array |
任意 |
許可されるユーザーグループの ID のリスト。 |
|
|
string |
任意 |
許可されるユーザーグループの ID。 |
user-グループ-001 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。