创建交付组。
接口说明
调试
您可以在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 |
AppInstanceGroupName | string | 是 | 交付组名称。 | 办公应用 |
Users | array | 否 | 需添加到交付组分配用户的用户名称列表。 | |
string | 否 | 需添加到交付组分配用户的用户名称。格式为 Users.N= | Users.1=username1 Users.2=username2 | |
UserInfo | object | 否 | 需添加到交付组分配用户的用户信息。如果填写了 | |
Type | string | 否 | 用户账号类型。 枚举值:
| Simple |
ChargeType | string | 是 | 付费方式。 枚举值:
| PrePaid |
PromotionId | string | 否 | 优惠 ID。可通过 GetResourcePrice 接口获取。 | 17440009**** |
AutoPay | boolean | 否 | 是否自动付费。 枚举值:
| false |
AutoRenew | boolean | 否 | 是否自动续费。 枚举值:
| false |
Period | integer | 是 | 当参数
说明
当参数 ChargeType 取值为PostPaid 时,该参数请填写固定值 1。
| 1 |
PeriodUnit | string | 是 | 当参数 说明
该参数区分大小写。例如, Week 是有效的,week 是无效的。
另外,如果请求参数不符合上述搭配,例如2 Week ,虽然调用本接口会成功,但最终在下单阶段会出错。
说明
当参数 ChargeType 取值为PostPaid 时,该参数请填写固定值Month 。
枚举值:
| Week |
SessionTimeout | integer | 是 | 应用回收时间,单位为分钟。终端用户将云应用断开连接一段时间后,云上应用进程即退出,这段时间就是应用回收时间。如果永不回收,则填写 | 15 |
BizRegionId | string | 是 | 交付组所属的地域 ID。关于支持的地域详情,请参见使用限制。 枚举值:
| cn-hangzhou |
ChargeResourceMode | string | 是 | 售卖模式。 枚举值:
| Node |
NodePool | object | 否 | 节点池对象。 | |
NodeInstanceType | string | 否 | 购买资源的规格类型 ID,可通过 ListNodeInstanceType 接口获取。 枚举值:
| appstreaming.general.4c8g |
NodeAmount | integer | 否 | 购买资源的数量。取值范围:1~100。 说明
StrategyType )为固定数量(NODE_FIXED )或自动扩缩容(NODE_SCALING_BY_USAGE )时该参数必填。 | 1 |
NodeCapacity | integer | 否 | 并发会话数,即单个资源可同时连接的会话数。如果同时连接的会话数过多,可能导致应用的使用体验下降。取值范围因资源规格不同而不同。各资源规格对应的取值范围分别是:
| 2 |
StrategyType | string | 否 | 弹性模式。 说明
NODE_FIXED (固定数量):适用于包年包月资源和按量付费资源。NODE_SCALING_BY_USAGE (自动扩缩容):适用于包年包月资源和按量付费资源。NODE_SCALING_BY_SCHEDULE (定时扩缩容):仅适用于按量付费资源。枚举值:
| NODE_FIXED |
MaxScalingAmount | integer | 否 | 扩容时最多创建资源的数量。 | 10 |
MaxIdleAppInstanceAmount | integer | 否 | 空闲会话数上限。指定该值时,当会话使用率超过 | 3 |
ScalingStep | integer | 否 | 扩容时每次创建资源的数量。取值范围:1~10。 | 2 |
ScalingUsageThreshold | string | 否 | 会话使用率上限阈值(%)。当会话使用率超过该阈值时,将触发自动扩容。会话使用率的计算公式为 | 85 |
ScalingDownAfterIdleMinutes | integer | 否 | 无会话连接的资源最多保留的时长(分钟)。当资源内无会话连接时,将按照此处设置的时长开始倒计时,倒计时结束时将完成缩容。取值范围:5~120。默认值:5。但有以下例外情况:
| 5 |
StrategyEnableDate | string | 否 | 策略生效日期。格式为:yyyy-MM-dd。该日期必须大于或等于当前日期。 | 2022-08-01 |
StrategyDisableDate | string | 否 | 策略失效日期。格式为:yyyy-MM-dd。失效日期与生效日期的间隔必须介于 7 天到 1 年之间(含 7 天和 1 年)。 | 2022-09-08 |
WarmUp | boolean | 否 | 是否开启资源预热策略。 | false |
RecurrenceSchedules | array<object> | 否 | 策略执行周期列表。 | |
object | 否 | 策略执行周期。 | ||
RecurrenceType | string | 否 | 策略执行周期的类型。必须同时指定 枚举值:
| weekly |
RecurrenceValues | array | 否 | 策略执行周期的数值列表。 | |
integer | 否 | 策略执行周期的数值。 枚举值:
| 1 | |
TimerPeriods | array<object> | 否 | 策略执行周期的时间段列表。时间段设置要求:
| |
object | 否 | 策略执行周期的时间段。 | ||
StartTime | string | 否 | 开始时间。格式为 HH:mm。 | 12:00 |
EndTime | string | 否 | 结束时间。格式为 HH:mm。 | 15:00 |
Amount | integer | 否 | 资源数量。 | 2 |
Network | object | 否 | 网络配置。 说明
如需使用该参数,请提交工单。
| |
StrategyType | string | 否 | 网络策略类型。 枚举值:
| Shared |
Routes | array<object> | 否 | 路由配置。仅当网络策略类型( | |
object | 否 | 路由配置。 | ||
Destination | string | 否 | 访问目标。CIDR 格式。 | 139.196.XX.XX/32 |
Mode | string | 否 | 网络出口模式。 枚举值:
| Shared |
IpExpireMinutes | integer | 否 | 公网 IP 地址使用时长超过这个值时,在下次登录时就会触发 IP 地址更新。最小值为 60。单位为分钟。 | 60 |
DomainRules | array<object> | 否 | 域名规则配置。 | |
object | 否 | 域名规则。 | ||
Domain | string | 否 | 域名。 | www.example.com |
Policy | string | 否 | 策略值。 枚举值:
| block |
StoragePolicy | object | 否 | 存储策略。 | |
StorageTypeList | array | 否 | 存储类型列表。 | |
string | 否 | 存储类型。 枚举值:
| PDS | |
PreOpenAppId | string | 否 | 预开的 AppId。 | cag-b2ronxxd**** |
VideoPolicy | object | 否 | 显示策略。 | |
FrameRate | integer | 否 | 帧率(FPS)。 枚举值:
| 60 |
TerminalResolutionAdaptive | boolean | 否 | 是否使用自适应分辨率。
| false |
SessionResolutionWidth | integer | 否 | 分辨率的宽度,单位为像素。 | 1920 |
SessionResolutionHeight | integer | 否 | 分辨率的高度,单位为像素。 | 1080 |
StreamingMode | string | 否 | 流模式。与
| video |
Webrtc | boolean | 否 | 是否开启 WebRTC。与
| true |
RuntimePolicy | object | 否 | 运行时策略。 | |
SessionType | string | 否 | 会话类型。 枚举值:
| NORMAL |
DebugMode | string | 否 | 是否开启调试模式。如需调用 枚举值:
| OFF |
SecurityPolicy | object | 否 | 安全策略。 | |
ResetAfterUnbind | boolean | 否 | 解绑后是否重置。 枚举值:
| true |
SkipUserAuthCheck | boolean | 否 | 是否跳过用户授权校验。 枚举值:
| false |
UserDefinePolicy | object | 否 | 用户自定义策略 | |
CustomConfig | string | 否 | 自定义策略内容,需要满足镜像版本规范,如需使用该参数,请提交工单申请开启白名单。 | [{"target":"agent","config":{"abc":"xxx"}}] |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"AppInstanceGroupModel": {
"AppInstanceGroupId": "aig-9ciijz60n4xsv****",
"OrderId": "12345****",
"NodePoolId": "rg-ew7va2g1wl3vm****"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
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 内部配置变更,不影响调用 | 查看变更详情 |