指定されたデリバリーグループの詳細を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
appstreaming:GetAppInstanceGroup |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| 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 |
アプリケーション名。 |
办公应用 |
| AppVersion |
string |
アプリケーションバージョン。 |
1.0.0 |
| AppVersionName |
string |
アプリケーションバージョン名。 |
初始版本 |
| AppIcon |
string |
アプリケーションアイコン。 |
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 |
インスタンスの最大数。最小値: 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 |
リソース仕様名。 |
无影-通用型_4核8G |
| SpecId |
string |
デリバリーグループ ID に一意に対応する ID。 |
spec-8o18t8uc31qib0**** |
| SessionTimeout |
string |
セッション切断後の保持持続時間 (分単位)。エンドユーザーとのセッションが切断された後、指定された期間セッションが保持され、その後ログオフされます。このパラメーターを |
15 |
| AppInstanceGroupName |
string |
デリバリーグループ名。 |
OfficeApp. |
| 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 |
オペレーティングシステムタイプ。 |
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"
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。