调用ModifyNodePoolAttribute修改交付组自动扩缩容策略_无影云应用(App Streaming)-阿里云帮助中心

修改交付组的弹性模式，包括固定数量（不使用弹性扩缩容）、定时扩缩容和自动扩缩容。

接口说明

您可以设置无影云应用资源的弹性模式：

固定数量：不使用弹性扩缩容。
自动扩缩容：根据连接会话的数量和无会话连接时长实现资源的自动扩缩容。
定时扩缩容：在指定日期的指定时间段执行资源的定时扩缩容。

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

调试

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

调试

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
ProductType	string	否	产品类型。枚举值： CloudApp：无影云应用。	CloudApp
PoolId	string	否	资源组 ID。	rg-ew7va2g1wl3vm****
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
NodePoolStrategy	object	否	交付组的自动扩缩容策略。
StrategyType	string	否	弹性模式。说明 `NODE_FIXED`（固定数量）：适用于包年包月资源和按量付费资源。 `NODE_SCALING_BY_USAGE`（自动扩缩容）：适用于包年包月资源和按量付费资源。 `NODE_SCALING_BY_SCHEDULE`（定时扩缩容）：仅适用于按量付费资源。枚举值： NODE_FIXED：固定数量（不使用弹性扩缩容）。 NODE_SCALING_BY_SCHEDULE：定时扩缩容。 NODE_SCALING_BY_USAGE：自动扩缩容。	NODE_FIXED
NodeAmount	integer	否	购买资源的数量。取值范围：1~100。说明若为包年包月资源，则该参数不可修改。若为按量付费资源，则当弹性模式（`StrategyType`）为固定数量（`NODE_FIXED`）或自动扩缩容（`NODE_SCALING_BY_USAGE`）时该参数可修改。	1
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`（定时扩缩容）时，该字段必填。	2023-01-05
StrategyDisableDate	string	否	策略失效日期。格式为：yyyy-MM-dd。失效日期与生效日期的间隔必须介于 7 天到 1 年之间（含 7 天和 1 年）。`StrategyType`（弹性模式）设为`NODE_SCALING_BY_SCHEDULE`（定时扩缩容）时，该字段必填。	2023-01-19
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
BizRegionId	string	否	交付组所属的地域 ID。关于支持的地域详情，请参见使用限制。枚举值： cn-shanghai：华东2（上海）。 cn-hangzhou：华东1（杭州）。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Code	string	出错时的错误码。	InvalidParameter.PoolId
Message	string	出错时的错误消息。	The parameter PoolId is invalid.

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Code": "InvalidParameter.PoolId",
  "Message": "The parameter PoolId is invalid."
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-09-12	API 内部配置变更，不影响调用	查看变更详情
2023-03-31	API 内部配置变更，不影响调用	查看变更详情