调用ListAppInstanceGroup查询多个交付组详细信息-无影云应用-阿里云-无影云应用(App Streaming)-阿里云帮助中心

查询多个交付组详细信息，即不指定特定的交付组，而是查询所有满足条件的交付组的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

appstreaming:ListAppInstanceGroup

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	每页的查询结果数量，不可超过`100`。	10
PageNumber	integer	否	需展示的查询结果页码。	1
Status	array	否	交付组状态列表。
	string	否	交付组状态。枚举值： PUBLISHED : 发布成功 FAILED : 发布失败 MAINTAIN_FAILED : 更新失败 EXPIRED : 已到期 MAINTAINING : 更新中 CEASED : 已欠费 EXPIRED_RECYCLING : 过期回收中 DEPLOYING : 发布中	"Status.1":"PUBLISHED","Status.2":"FAILED"
AppInstanceGroupId	string	否	交付组 ID。	aig-9ciijz60n4xsv****
ProductType	string	是	产品类型。枚举值： CloudApp : 无影云应用	CloudApp
AppInstanceGroupName	string	否	交付组名称，查询时采用模糊匹配规则。例如，假设填写的交付组名称为`办公应用`，则名称中包含`办公应用`的交付组都会被查询到，例如名为`我的办公应用`、`办公应用 A`的交付组。	办公应用
AppCenterImageId	string	否	应用镜像 ID，可从无影云应用控制台的镜像管理页面获取。	img-8z4nztpaqvay4****
RegionId `deprecated`	string	否	地域 ID。	cn-hangzhou
BizRegionId	string	否	交付组所属的地域 ID。关于支持的地域详情，请参见使用限制。枚举值： cn-shanghai : 华东 2（上海） cn-hangzhou : 华东 1（杭州）	cn-hangzhou
NodeInstanceType	string	否	购买资源的规格类型 ID。可通过 ListNodeInstanceType 接口获取。	appstreaming.vgpu.4c8g.2g
OfficeSiteId	string	否	办公网络 ID。	cn-hongkong+dir-643067****
Tag	array<object>	否	标签列表。
	object	否	标签。
Key	string	否	标签键。	department
Value	string	否	标签值。	design
UserGroupIds	array	否
	string	否
ExcludedUserGroupIds	array	否
	string	否

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	查询结果的总数。	15
PageSize	integer	每页的查询结果数量。	10
PageNumber	integer	当前展示的查询结果页码。	1
AppInstanceGroupModels	array<object>	交付组信息。
	array<object>	交付组信息。
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 : 无影云应用	CloudApp
AppInstanceType	string	交付组规格类型。	__dynamic__
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	付费方式。枚举值： PostPaid : 按量付费 PrePaid : 包年包月	PrePaid
GmtCreate	string	创建时间。	2022-04-26T15:06:16.000+00:00
Status	string	交付组状态。枚举值： PUBLISHED : 发布成功 FAILED : 发布失败 MAINTAIN_FAILED : 更新失败 EXPIRED : 已到期 MAINTAINING : 更新中 CEASED : 已欠费 EXPIRED_RECYCLING : 过期回收中 DEPLOYING : 发布中	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_SCALING_BY_USAGE`（按用量伸缩策略）仅适用于`PrePaid`（包年包月）资源；`NODE_SCALING_BY_SCHEDULE`（定时伸缩策略）仅适用于`PostPaid`（按量付费）资源。枚举值： NODE_FIXED : 不使用弹性资源 NODE_SCALING_BY_SCHEDULE : 定时伸缩 NODE_SCALING_BY_USAGE : 按用量伸缩策略	NODE_FIXED
Amount	integer	创建交付组时购买资源的数量。	2
MaxScalingAmount	integer	扩容时最多创建资源的数量。	8
MaxIdleAppInstanceAmount	integer	空闲会话数上限。指定该值时，当会话使用率超过`ScalingUsageThreshold`且当前交付组空闲会话数小于`MaxIdleAppInstanceAmount`时，才会触发自动扩容，否则认为交付组空闲会话已足够使用，不自动扩容。该参数可用于灵活控制弹性扩容行为和降低使用成本。	3
ScalingStep	integer	扩容时每次创建资源的数量。取值范围：1~10。	2
ScalingUsageThreshold	string	会话使用率上限阈值（%）。当会话使用率超过该阈值时，将触发自动扩容。会话使用率的计算公式为`会话使用率=当前会话数÷(资源总数×资源并发会话数)×100%`。	85
ScalingDownAfterIdleMinutes	integer	无会话连接时长，单位为分钟。当资源内处于无会话连接状态达到此处设置的时长后，将触发自动缩容。默认值：5。	5
RecurrenceSchedules	array<object>	策略执行周期列表。
	array<object>	策略执行周期。
RecurrenceType	string	策略执行周期的类型。必须同时指定`RecurrenceType`和`RecurrenceValues`。枚举值： weekly : 周（每周指定几天重复执行一次定时任务）	Weekly
RecurrenceValues	array	策略执行周期的数值列表。
	integer	策略执行周期的数值。枚举值： 1 : 周一 2 : 周二 3 : 周三 4 : 周四 5 : 周五 6 : 周六 7 : 周日	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	会话断连保留时长，单位为分钟。终端用户会话断开连接后，会话将保留此处设置的时长，然后再注销。如果始终保留，则填写`-1`。取值范围：-1 和 3~300。默认值为`15`。	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 : Windows	Windows
ResourceStatus	string	资源状态。枚举值： AVAILABLE : 可用 RELEASED : 已释放 EXPIRED_IN_7_DAYS : 7 天内过期 UNAVAILABLE : 不可用 UPGRADING : 更新中 CREATING : 创建中	AVAILABLE
AppPolicyId	string	策略 ID。	pg-g3k5wa2ms2****
ChargeResourceMode	string	售卖模式。枚举值： AppInstance : 按会话售卖 Node : 按资源售卖	Node
SkipUserAuthCheck	boolean	是否跳过用户授权校验。枚举值： true : 不校验 false : 校验 [默认值]	false
OfficeSiteId	string	办公网络 ID。	cn-beijing+dir-172301****
AppPolicyVersion	string	策略版本。枚举值： CENTER : 统一策略[新策略] DEFAULT : 默认策略[旧策略]	CENTER
AppPolicyImageCheck	boolean	当前镜像是否支持统一策略。枚举值： true : 支持 false : 不支持	false
ResourceTags	array<object>	资源标签列表。
	object	资源标签。
Key	string	标签键。	department
Value	string	标签值。	design
Scope	string	标签类型。枚举值： Custom : 自定义标签 System : 系统标签	Custom
Tags	array<object>	资源标签列表。
	object	资源标签。
Key	string	标签键。	department
Value	string	标签值。	design
Scope	string	标签类型。枚举值： Custom : 自定义标签 System : 系统标签	Custom
AuthMode	string	授权模式。枚举值： App : 应用授权 AppInstanceGroup : 交付组授权 Session : 会话授权	App
AccessType	string	接入类型。枚举值： INTERNET : 互联网 VPC : 企业专网（VPC） ANY : 互联网和企业专网（VPC）	INTERNET
SupportUserGroupMixedAuth	boolean
UserGroupAuthMode	string		Mixed

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 15,
  "PageSize": 10,
  "PageNumber": 1,
  "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__",
      "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
      "Amount": 1,
      "MinAmount": 1,
      "MaxAmount": 10,
      "ReserveAmountRatio": "20",
      "ReserveMinAmount": 1,
      "ReserveMaxAmount": 5,
      "ScalingStep": 10,
      "ScalingUsageThreshold": "85",
      "ScalingDownAfterIdleMinutes": 5,
      "ChargeType": "PrePaid",
      "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",
      "ResourceStatus": "AVAILABLE",
      "AppPolicyId": "pg-g3k5wa2ms2****",
      "ChargeResourceMode": "Node",
      "SkipUserAuthCheck": false,
      "OfficeSiteId": "cn-beijing+dir-172301****\n",
      "AppPolicyVersion": "CENTER",
      "AppPolicyImageCheck": false,
      "ResourceTags": [
        {
          "Key": "department",
          "Value": "design",
          "Scope": "Custom"
        }
      ],
      "Tags": [
        {
          "Key": "department",
          "Value": "design",
          "Scope": "Custom"
        }
      ],
      "AuthMode": "App",
      "AccessType": "INTERNET",
      "SupportUserGroupMixedAuth": true,
      "UserGroupAuthMode": "Mixed"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。