特定のデリバリーグループの詳細を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
appstreaming:GetAppInstanceGroup |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppInstanceGroupId |
string |
必須 |
デリバリーグループの ID。ListAppInstanceGroup API を呼び出して取得します。 |
aig-9ciijz60n4xsv**** |
| ProductType |
string |
必須 |
製品タイプです。 列挙値:
|
CloudApp |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返されるデータです。 |
||
| RequestId |
string |
リクエスト IDです。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| AppInstanceGroupModels |
object |
アプリインスタンスグループの詳細です。 |
|
| Apps |
array<object> |
アプリケーションのリストです。 |
|
|
object |
アプリケーションの詳細です。 |
||
| AppId |
string |
アプリケーション IDです。 |
ca-i87mycyn419nu**** |
| AppName |
string |
アプリケーション名です。 |
办公应用 |
| AppVersion |
string |
アプリケーションバージョンです。 |
1.0.0 |
| AppVersionName |
string |
アプリケーションバージョンの名前です。 |
初始版本 |
| AppIcon |
string |
アプリアイコンの URLです。 |
https://app-center-icon-****.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 |
最大インスタンス数です。 |
10 |
| ReserveAmountRatio |
string |
アプリインスタンスグループで予約するアイドルセッションの割合です。有効な値：0～99。 |
20 |
| ReserveMinAmount |
integer |
アプリインスタンスグループで予約するアイドルセッションの最小数です。値は 1 以上である必要があります。 |
1 |
| ReserveMaxAmount |
integer |
アプリインスタンスグループで予約するアイドルセッションの最大数です。値は 1 以上である必要があります。 |
5 |
| ScalingStep |
integer |
各スケールアウトイベントで追加するセッション数です。最小値は 1 です。 |
10 |
| ScalingUsageThreshold |
string |
スケールアウトをトリガーするセッション使用率のしきい値 (パーセンテージ) です。セッション使用率が
|
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 |
購入したリソースのインスタンスタイプです。 |
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 |
リソース仕様の名前です。 |
无影-通用型_4核8G |
| SpecId |
string |
アプリインスタンスグループの仕様 IDです。 |
spec-8o18t8uc31qib0**** |
| SessionTimeout |
string |
切断されたセッションが閉じられるまでアクティブに保たれる期間 (分) です。セッションを無期限にアクティブに保つには、このパラメータを
|
15 |
| AppInstanceGroupName |
string |
アプリインスタンスグループの名前です。 |
办公应用 |
| ExpiredTime |
string |
アプリインスタンスグループの有効期限が切れる時刻です。 |
2022-04-27T16: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 |
OS タイプです。 |
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": "办公应用",
"AppVersion": "1.0.0",
"AppVersionName": "初始版本",
"AppIcon": "https://app-center-icon-****.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": "无影-通用型_4核8G"
}
],
"SpecId": "spec-8o18t8uc31qib0****",
"SessionTimeout": "15",
"AppInstanceGroupName": "办公应用",
"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****\n",
"AppPolicyId": "pg-g3k5wa2ms2****",
"SkipUserAuthCheck": false,
"SessionType": "NORMAL",
"Tags": [
{
"Key": "department",
"Value": "design",
"Scope": "Custom"
}
],
"AuthMode": "App",
"AccessType": "INTERNET",
"SupportUserGroupMixedAuth": false,
"UserGroupAuthMode": "Mixed"
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。