指定された配信グループの詳細を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
appstreaming:GetAppInstanceGroup |
get |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppInstanceGroupId |
string |
必須 |
配信グループの ID。 ListAppInstanceGroup 操作を呼び出して ID を取得できます。 |
aig-9ciijz60n4xsv**** |
| ProductType |
string |
必須 |
プロダクトタイプ。 列挙値:
|
CloudApp |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返される情報のコレクション。 |
||
| RequestId |
string |
リクエスト ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| AppInstanceGroupModels |
object |
AppInstanceGroupModels。 |
|
| Apps |
array<object> |
アプリケーション情報のリスト。 |
|
|
object |
アプリケーション情報。 |
||
| AppId |
string |
アプリケーションの ID。 |
ca-i87mycyn419nu**** |
| AppName |
string |
アプリケーション名。 |
OfficeApp |
| AppVersion |
string |
アプリケーションのバージョン。 |
1.0.0 |
| AppVersionName |
string |
アプリケーションバージョン名。 |
InitialVersion |
| AppIcon |
string |
アプリケーションのアイコン。 |
https://app-center-アイコン-****.png |
| AppCenterImageId |
string |
アプリケーションイメージの ID。 |
img-8z4nztpaqvay4**** |
| RegionId |
string |
配信グループのリージョン ID。サポートされているリージョンの詳細については、「使用制限」を参照してください。 |
cn-hangzhou |
| ProductType |
string |
プロダクトタイプ。 |
CloudApp |
| AppInstanceType |
string |
配信グループのスペックタイプ。 |
__dynamic__ |
| AppInstanceTypeName |
string |
配信グループのスペックタイプ名。 |
test001 |
| AppInstanceGroupId |
string |
配信グループの ID。 |
aig-9ciijz60n4xsv**** |
| Amount |
integer |
ユーザーが設定したサブスクリプションリソースの数。最小値: 1。 |
1 |
| MinAmount |
integer |
インスタンスの最小数。最小値: 1。 |
1 |
| MaxAmount |
integer |
インスタンスの最大数。最小値: 1。 |
10 |
| ReserveAmountRatio |
string |
予約済みインスタンスの割合。配信グループ内の未使用の会話の比率です。有効な値: 0～99。 |
20 |
| ReserveMinAmount |
integer |
予約済みインスタンスの最小数。これは、配信グループ内の未使用セッションの最小数です。最小値: 1。 |
1 |
| ReserveMaxAmount |
integer |
予約済みインスタンスの最大数。配信グループ内の未使用の会話の最大数です。最小値: 1。 |
5 |
| ScalingStep |
integer |
スケールアウト操作ごとに作成される会話数。最小値: 1。 |
10 |
| ScalingUsageThreshold |
string |
会話使用量 (%) の上限しきい値。会話使用量がこのしきい値を超えると、自動スケールアウトがトリガーされます。会話使用量は次のように計算されます。会話使用量 = 使用中の会話数 ÷ 会話の総数 × 100%。有効な値: 0～99。 |
85 |
| ScalingDownAfterIdleMinutes |
integer |
会話接続がないアイドル持続時間 (分単位)。リソースが指定された持続時間会話接続なしの状態が続くと、自動スケールインがトリガーされます。最小値: 0。 |
5 |
| ChargeType |
string |
課金方法。 列挙値:
|
PrePaid |
| ChargeResourceMode |
string |
販売モード。 列挙値:
|
Node |
| GmtCreate |
string |
作成時間。 |
2022-04-26T15:06:16.000+00:00 |
| Status |
string |
配信グループのステータス。 列挙値:
|
PUBLISHED |
| NodePool |
array<object> |
リソースグループ情報。 |
|
|
array<object> |
リソースグループ情報。 |
||
| NodePoolId |
string |
リソースグループの ID。 |
rg-g6922kced36hx**** |
| NodeInstanceType |
string |
購入したリソースのスペックタイプ ID。 |
appstreaming.vgpu.4c8g.2g |
| NodeAmount |
integer |
現在のサブスクリプションリソースの総数。 |
1 |
| NodeUsed |
integer |
使用中のサブスクリプションリソースのリソース数。 |
1 |
| NodeCapacity |
integer |
同時会話数。単一のリソースが同時にハンドルできる会話数です。同時に接続される会話が多すぎると、アプリケーションのエクスペリエンスが低下する可能性があります。有効な値はリソース仕様によって異なります。各リソース仕様の有効な値は次のとおりです。
|
2 |
| ScalingNodeAmount |
integer |
弾力リソースの総数。 |
8 |
| ScalingNodeUsed |
integer |
使用中の弾力リソースのリソース数。 |
4 |
| StrategyType |
string |
弾力的スケーリングポリシーのタイプ。 説明
列挙値:
|
NODE_FIXED |
| Amount |
integer |
配信グループの作成時に購入されたリソース数。 |
2 |
| MaxScalingAmount |
integer |
スケールアウト中に作成できるリソースの最大数。 |
8 |
| MaxIdleAppInstanceAmount |
integer |
アイドル会話の上限。この値を指定すると、会話使用量が |
3 |
| ScalingStep |
integer |
スケールアウト操作ごとに作成されるリソース数。有効な値: 1～10。 |
2 |
| ScalingUsageThreshold |
string |
会話使用量 (%) の上限しきい値。会話使用量がこのしきい値を超えると、自動スケールアウトがトリガーされます。会話使用量は次のように計算されます。 |
85 |
| ScalingDownAfterIdleMinutes |
integer |
会話接続がないアイドル持続時間 (分単位)。リソースが指定された持続時間会話接続なしの状態が続くと、自動スケールインがトリガーされます。デフォルト値: 5。 |
5 |
| RecurrenceSchedules |
array<object> |
ポリシー実行サイクルのリスト。 |
|
|
array<object> |
ポリシー実行サイクル。 |
||
| RecurrenceType |
string |
ポリシー実行サイクルのタイプ。 |
Weekly |
| RecurrenceValues |
array |
ポリシー実行サイクルの値のリスト。 |
|
|
integer |
ポリシー実行サイクルの値。 |
1 |
|
| TimerPeriods |
array<object> |
ポリシー実行サイクルの時間のリスト。 |
|
|
object |
ポリシー実行サイクルの時間。 |
||
| Amount |
integer |
ターゲットリソース数。 |
5 |
| EndTime |
string |
終了時刻。フォーマット: HH:mm。 |
11:00 |
| StartTime |
string |
開始時刻。フォーマット: HH:mm。 |
09:30 |
| StrategyDisableDate |
string |
ポリシーの有効期限が切れる日付。フォーマット: yyyy-MM-dd。 |
2022-09-08 |
| StrategyEnableDate |
string |
ポリシーが有効になる日付。フォーマット: yyyy-MM-dd。 |
2022-08-01 |
| WarmUp |
boolean |
リソースプリフェッチポリシーが有効かどうかを示します。 |
false |
| NodeTypeName |
string |
リソース仕様名。 |
WUYING-General_4vCPU8GiB |
| SpecId |
string |
配信グループ ID に一意に対応する ID。 |
spec-8o18t8uc31qib0**** |
| SessionTimeout |
string |
会話切断後の保持持続時間 (分単位)。エンドユーザーの会話が切断された後、ログオフされるまで指定された持続時間会話が保持されます。会話を無期限に保持するには、このパラメーターを |
15 |
| AppInstanceGroupName |
string |
配信グループ名。 |
OfficeApp |
| ExpiredTime |
string |
配信グループの有効期限。時間はミリ秒およびタイムゾーンオフセットを含む ISO 8601 フォーマットです。フォーマット: yyyy-MM-dd'T'HH:mm:ss.SSSXXX。 |
2026-09-24T16:00:00.000+00:00 |
| OtaInfo |
object |
OTA スペックアップタスク情報。 |
|
| OtaVersion |
string |
現在の OTA バージョン。 |
0.0.1-D-20220615.11**** |
| NewOtaVersion |
string |
新しい OTA バージョン。空の値は、新しいバージョンが利用できないことを示します。 |
0.0.1-D-20220630.11**** |
| TaskId |
string |
OTA スペックアップタスクの ID。 |
ota-e49929gv8acz5**** |
| OsType |
string |
オペレーティングシステムタイプ。 列挙値:
|
Windows |
| AppCenterImageName |
string |
アプリケーションイメージ名。 |
OfficeApps |
| ResourceStatus |
string |
リソースのステータス。 |
AVAILABLE |
| OfficeSiteId |
string |
オフィスネットワークの ID。 |
cn-beijing+dir-172301**** |
| AppPolicyId |
string |
アプリケーションポリシーの ID。 |
pg-g3k5wa2ms2**** |
| SkipUserAuthCheck |
boolean |
ユーザー権限付与の検証をスキップするかどうかを示します。 列挙値:
|
false |
| SessionType |
string |
会話タイプ。 列挙値:
|
NORMAL |
| Tags |
array<object> |
リソースタグのリスト。 |
|
|
object |
リソースタグ。 |
||
| Key |
string |
タグキー。 |
department |
| Value |
string |
タグ値。 |
design |
| Scope |
string |
タグタイプ。 列挙値:
|
Custom |
| AuthMode |
string |
権限付与モード。 列挙値:
|
App |
| AccessType |
string |
アクセスタイプ。 列挙値:
|
INTERNET |
| SupportUserGroupMixedAuth |
boolean |
ユーザーとユーザーグループの混合権限付与がサポートされているかどうかを示します。 |
|
| UserGroupAuthMode |
string |
ユーザーおよびユーザーグループの権限付与モード。 列挙値:
|
Mixed |
例
成功レスポンス
JSONJSON
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"AppInstanceGroupModels": {
"Apps": [
{
"AppId": "ca-i87mycyn419nu****",
"AppName": "OfficeApp",
"AppVersion": "1.0.0",
"AppVersionName": "InitialVersion",
"AppIcon": "https://app-center-アイコン-****.png"
}
],
"AppCenterImageId": "img-8z4nztpaqvay4****",
"RegionId": "cn-hangzhou",
"ProductType": "CloudApp",
"AppInstanceType": "__dynamic__",
"AppInstanceTypeName": "test001",
"AppInstanceGroupId": "aig-9ciijz60n4xsv****",
"Amount": 1,
"MinAmount": 1,
"MaxAmount": 10,
"ReserveAmountRatio": "20",
"ReserveMinAmount": 1,
"ReserveMaxAmount": 5,
"ScalingStep": 10,
"ScalingUsageThreshold": "85",
"ScalingDownAfterIdleMinutes": 5,
"ChargeType": "PrePaid",
"ChargeResourceMode": "Node",
"GmtCreate": "2022-04-26T15:06:16.000+00:00",
"Status": "PUBLISHED",
"NodePool": [
{
"NodePoolId": "rg-g6922kced36hx****",
"NodeInstanceType": "appstreaming.vgpu.4c8g.2g",
"NodeAmount": 1,
"NodeUsed": 1,
"NodeCapacity": 2,
"ScalingNodeAmount": 8,
"ScalingNodeUsed": 4,
"StrategyType": "NODE_FIXED",
"Amount": 2,
"MaxScalingAmount": 8,
"MaxIdleAppInstanceAmount": 3,
"ScalingStep": 2,
"ScalingUsageThreshold": "85",
"ScalingDownAfterIdleMinutes": 5,
"RecurrenceSchedules": [
{
"RecurrenceType": "Weekly",
"RecurrenceValues": [
1
],
"TimerPeriods": [
{
"Amount": 5,
"EndTime": "11:00",
"StartTime": "09:30"
}
]
}
],
"StrategyDisableDate": "2022-09-08",
"StrategyEnableDate": "2022-08-01",
"WarmUp": false,
"NodeTypeName": "WUYING-General_4vCPU8GiB"
}
],
"SpecId": "spec-8o18t8uc31qib0****",
"SessionTimeout": "15",
"AppInstanceGroupName": "OfficeApp",
"ExpiredTime": "2022-04-27T16:00:00.000+00:00",
"OtaInfo": {
"OtaVersion": "0.0.1-D-20220615.11****",
"NewOtaVersion": "0.0.1-D-20220630.11****",
"TaskId": "ota-e49929gv8acz5****"
},
"OsType": "Windows",
"AppCenterImageName": "OfficeApps",
"ResourceStatus": "AVAILABLE",
"OfficeSiteId": "cn-beijing+dir-172301****",
"AppPolicyId": "pg-g3k5wa2ms2****",
"SkipUserAuthCheck": false,
"SessionType": "NORMAL",
"Tags": [
{
"Key": "department",
"Value": "design",
"Scope": "Custom"
}
],
"AuthMode": "App",
"AccessType": "INTERNET",
"SupportUserGroupMixedAuth": false,
"UserGroupAuthMode": "Mixed"
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。