调用CreateAppInstanceGroup创建交付组_无影云应用(App Streaming)-阿里云帮助中心

创建交付组。

接口说明

请确保在使用该接口前，已充分了解无影云应用的计费方式和价格。

交付组是向终端用户交付云应用的逻辑分组，包括底层依赖的云应用资源、包含云应用的镜像、资源管理策略以及用户分配设置等。详情参见发布交付组。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
appstreaming:CreateAppInstanceGroup	create	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
AppCenterImageId	string	是	应用镜像 ID。可从无影云应用控制台的运维>自定义镜像或系统镜像页面获取。	img-8z4nztpaqvay4****
ProductType	string	是	产品类型。枚举值： CloudApp：无影云应用。	CloudApp
AppInstanceGroupName	string	否	交付组名称。	办公应用
Users	array	否	需添加到交付组分配用户的用户名称列表。
	string	否	需添加到交付组分配用户的用户名称。格式为 Users.N=`<用户名>`，其中 N 取值为大于 0 的整数。	Users.1=username1 Users.2=username2
UserInfo	object	否	需添加到交付组分配用户的用户信息。如果填写了`Users`参数，则该字段为必需。
Type	string	否	用户账号类型。枚举值： Simple：便捷账号。	Simple
ChargeType	string	是	付费方式。枚举值： PostPaid：按量付费。 PrePaid：包年包月。	PrePaid
PromotionId	string	否	优惠 ID。可通过 GetResourcePrice 接口获取。	17440009****
AutoPay	boolean	否	是否自动付费。枚举值： true：自动付费。 false：手动付费 [默认值]。	false
AutoRenew	boolean	否	是否自动续费。枚举值： true：自动续费。 false：手动续费 [默认值]。	false
Period	integer	是	当参数`ChargeType`取值为`PrePaid`时，该参数表示购买资源的时长，且为必填值。单位由`PeriodUnit`指定。如果`PeriodUnit`为`Week`，该参数的取值范围为： 1 如果`PeriodUnit`为`Month`，该参数的取值范围为： 1 2 3 6 如果`PeriodUnit`为`Year`，该参数的取值范围为： 1 2 3 说明当参数`ChargeType`取值为`PostPaid`时，该参数请填写固定值 1。	1
PeriodUnit	string	是	当参数`ChargeType`取值为`PrePaid`时，该参数表示购买资源的时长单位。说明该参数区分大小写。例如，`Week`是有效的，`week`是无效的。另外，如果请求参数不符合上述搭配，例如`2 Week`，虽然调用本接口会成功，但最终在下单阶段会出错。说明当参数`ChargeType`取值为`PostPaid`时，该参数请填写固定值`Month`。枚举值： Month：月。 Year：年。 Week：周。	Week
SessionTimeout	integer	是	应用回收时间，单位为分钟。终端用户将云应用断开连接一段时间后，云上应用进程即退出，这段时间就是应用回收时间。如果永不回收，则填写`-1`。取值范围：-1 和 3~300，且值为整数。默认值为`15`。	15
BizRegionId	string	是	交付组所属的地域 ID。关于支持的地域详情，请参见使用限制。枚举值： cn-shanghai：华东2（上海）。 cn-hangzhou：华东1（杭州）。	cn-hangzhou
ChargeResourceMode	string	是	售卖模式。枚举值： Node：按资源售卖。	Node
NodePool	object	否	节点池对象。
NodeInstanceType	string	否	购买资源的规格类型 ID，可通过 ListNodeInstanceType 接口获取。枚举值： appstreaming.vgpu.8c16g.4g：无影-图形型_8核16G 4G显存。 appstreaming.general.8c16g：无影-通用型_8核16G。 appstreaming.general.4c8g：无影-通用型_4核8G。 appstreaming.vgpu.14c93g.12g：无影-图形型_14核93G 12G显存。 appstreaming.vgpu.8c31g.16g：无影-图形型_8核31G 16G显存。	appstreaming.general.4c8g
NodeAmount	integer	否	购买资源的数量。取值范围：1~100。说明若为包年包月资源，则该参数必填。若为按量付费资源，则当弹性模式（`StrategyType`）为固定数量（`NODE_FIXED`）或自动扩缩容（`NODE_SCALING_BY_USAGE`）时该参数必填。	1
NodeCapacity	integer	否	并发会话数，即单个资源可同时连接的会话数。如果同时连接的会话数过多，可能导致应用的使用体验下降。取值范围因资源规格不同而不同。各资源规格对应的取值范围分别是： appstreaming.general.4c8g：1~2； appstreaming.general.8c16g：1~4； appstreaming.vgpu.8c16g.4g：1~4； appstreaming.vgpu.8c31g.16g：1~4； appstreaming.vgpu.14c93g.12g：1~6；	2
StrategyType	string	否	弹性模式。说明 `NODE_FIXED`（固定数量）：适用于包年包月资源和按量付费资源。 `NODE_SCALING_BY_USAGE`（自动扩缩容）：适用于包年包月资源和按量付费资源。 `NODE_SCALING_BY_SCHEDULE`（定时扩缩容）：仅适用于按量付费资源。枚举值： NODE_FIXED：固定数量（不使用弹性扩缩容）。 NODE_SCALING_BY_SCHEDULE：定时扩缩容。 NODE_SCALING_BY_USAGE：自动扩缩容。	NODE_FIXED
MaxScalingAmount	integer	否	扩容时最多创建资源的数量。`StrategyType`设为`NODE_SCALING_BY_USAGE`（使用弹性资源）时，该字段必填。	10
MaxIdleAppInstanceAmount	integer	否	空闲会话数上限。指定该值时，当会话使用率超过`ScalingUsageThreshold`且当前交付组空闲会话数小于`MaxIdleAppInstanceAmount`时，才会触发自动扩容，否则认为交付组空闲会话已足够使用，不自动扩容。该参数可用于灵活控制弹性扩容行为和降低使用成本。	3
ScalingStep	integer	否	扩容时每次创建资源的数量。取值范围：1~10。`StrategyType`设为`NODE_SCALING_BY_USAGE`（使用弹性资源）时，该字段必填。	2
ScalingUsageThreshold	string	否	会话使用率上限阈值（%）。当会话使用率超过该阈值时，将触发自动扩容。会话使用率的计算公式为`会话使用率=当前会话数÷(资源总数×资源并发会话数)×100%`。`StrategyType`设为`NODE_SCALING_BY_USAGE`（使用弹性资源）时，该字段必填。取值范围：0~100。默认值：85。	85
ScalingDownAfterIdleMinutes	integer	否	无会话连接的资源最多保留的时长（分钟）。当资源内无会话连接时，将按照此处设置的时长开始倒计时，倒计时结束时将完成缩容。取值范围：5~120。默认值：5。但有以下例外情况：若缩容后将导致重新触发自动扩容，则不会执行缩容，以免导致反复产生缩容、扩容。若此时间段内，因会话数增加而触发自动扩容，则该资源不会按原计划缩容，倒计时也将重新开始。	5
StrategyEnableDate	string	否	策略生效日期。格式为：yyyy-MM-dd。该日期必须大于或等于当前日期。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。	2022-08-01
StrategyDisableDate	string	否	策略失效日期。格式为：yyyy-MM-dd。失效日期与生效日期的间隔必须介于 7 天到 1 年之间（含 7 天和 1 年）。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。	2022-09-08
WarmUp	boolean	否	是否开启资源预热策略。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。	false
RecurrenceSchedules	array<object>	否	策略执行周期列表。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。
	object	否	策略执行周期。
RecurrenceType	string	否	策略执行周期的类型。必须同时指定`RecurrenceType`和`RecurrenceValues`。枚举值： weekly：周（每周指定几天重复执行一次定时任务）。	weekly
RecurrenceValues	array	否	策略执行周期的数值列表。
	integer	否	策略执行周期的数值。枚举值： 1：周一。 2：周二。 3：周三。 4：周四。 5：周五。 6：周六。 7：周日。	1
TimerPeriods	array<object>	否	策略执行周期的时间段列表。时间段设置要求：最多可添加 3 个时间段。时间段之间不重叠。时间段之间的间隔大于或等于 5 分钟。单个时间段的时长大于或等于 15 分钟。所有时间段累计不跨天。
	object	否	策略执行周期的时间段。
StartTime	string	否	开始时间。格式为 HH:mm。	12:00
EndTime	string	否	结束时间。格式为 HH:mm。	15:00
Amount	integer	否	资源数量。	2
Network	object	否	网络配置。说明如需使用该参数，请提交工单。
StrategyType	string	否	网络策略类型。枚举值： Mixed：混合模式，单VPC、双网卡+独立公网IP。 Shared：共享模式，单网卡、NAT网管访问公网。	Shared
Routes	array<object>	否	路由配置。仅当网络策略类型（`StrategyType`）的值为混合模式（`Mixed`）时可配置。
	object	否	路由配置。
Destination	string	否	访问目标。CIDR 格式。	139.196.XX.XX/32
Mode	string	否	网络出口模式。枚举值： Shared：通过NAT网管访问。	Shared
IpExpireMinutes	integer	否	公网 IP 地址使用时长超过这个值时，在下次登录时就会触发 IP 地址更新。最小值为 60。单位为分钟。	60
DomainRules	array<object>	否	域名规则配置。
	object	否	域名规则。
Domain	string	否	域名。	www.example.com
Policy	string	否	策略值。枚举值： allow：允许访问。 block：禁止访问。	block
StoragePolicy	object	否	存储策略。
StorageTypeList	array	否	存储类型列表。
	string	否	存储类型。枚举值： OFF：关闭。 PDS：网盘与相册服务（Drive and Photo Service）。	PDS
PreOpenAppId	string	否	预开的 AppId。	cag-b2ronxxd****
VideoPolicy	object	否	显示策略。
FrameRate	integer	否	帧率（FPS）。枚举值： 30：30 FPS。 60：60 FPS。	60
TerminalResolutionAdaptive	boolean	否	是否使用自适应分辨率。 `true`：会话分辨率跟随终端显示区域变化。此时`SessionResolutionWidth`和`SessionResolutionHeight`为分辨率变化的最大值。 `false`：会话分辨率不跟随终端显示区域变化。此时分辨率固定为`SessionResolutionWidth`和`SessionResolutionHeight`的值。	false
SessionResolutionWidth	integer	否	分辨率的宽度，单位为像素。	1920
SessionResolutionHeight	integer	否	分辨率的高度，单位为像素。	1080
StreamingMode	string	否	流模式。与`Webrtc`参数搭配表示协议类型。 `Webrtc`=`true`且`StreamingMode`=`video`，表示 WebRTC 流。 `Webrtc`=`false`且`StreamingMode`=`video`，表示视频流。 `Webrtc`=`false`且`StreamingMode`=`mix`，表示混合流。	video
Webrtc	boolean	否	是否开启 WebRTC。与`StreamingMode`参数搭配表示协议类型。 `Webrtc`=`true`且`StreamingMode`=`video`，表示 WebRTC 流。 `Webrtc`=`false`且`StreamingMode`=`video`，表示视频流。 `Webrtc`=`false`且`StreamingMode`=`mix`，表示混合流。	true
RuntimePolicy	object	否	运行时策略。
SessionType	string	否	会话类型。枚举值： CONSOLE：Console会话。 NORMAL：RDP会话。	NORMAL
DebugMode	string	否	是否开启调试模式。如需调用`GetDebugAppInstance`和`CreateImageFromAppInstanceGroup`，则必须将此字段设为`ON`。枚举值： OFF：关闭。 ON：开启。	OFF
SecurityPolicy	object	否	安全策略。
ResetAfterUnbind	boolean	否	解绑后是否重置。枚举值： true：重置。 false：不重置。	true
SkipUserAuthCheck	boolean	否	是否跳过用户授权校验。枚举值： true：不校验。 false：校验 [默认值]。	false
UserDefinePolicy	object	否	用户自定义策略
CustomConfig	string	否	自定义策略内容，需要满足镜像版本规范，如需使用该参数，请提交工单申请开启白名单。	[{"target":"agent","config":{"abc":"xxx"}}]

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
AppInstanceGroupModel	object	交付组。
AppInstanceGroupId	string	交付组 ID。	aig-9ciijz60n4xsv****
OrderId	string	订单 ID。	12345****
NodePoolId	string	资源组 ID。如果同时创建了资源组，则返回该参数。	rg-ew7va2g1wl3vm****

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "AppInstanceGroupModel": {
    "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
    "OrderId": "12345****",
    "NodePoolId": "rg-ew7va2g1wl3vm****"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-22	API 内部配置变更，不影响调用	查看变更详情
2024-09-12	API 内部配置变更，不影响调用	查看变更详情
2024-07-19	OpenAPI 入参发生变更	查看变更详情
2024-05-11	OpenAPI 入参发生变更	查看变更详情
2023-08-21	API 内部配置变更，不影响调用	查看变更详情
2023-04-28	OpenAPI 入参发生变更	查看变更详情
2023-04-14	OpenAPI 入参发生变更	查看变更详情
2023-03-14	OpenAPI 入参发生变更	查看变更详情
2022-08-01	API 内部配置变更，不影响调用	查看变更详情