查询指定交付组详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
appstreaming:GetAppInstanceGroup |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppInstanceGroupId |
string |
是 |
交付组 ID。可调用接口 ListAppInstanceGroup 获取。 |
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 |
交付组名称。 |
办公应用 |
| 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 |
示例
正常返回示例
JSON格式
{
"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": true,
"UserGroupAuthMode": "Mixed"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。