@alicloud/ess20220222 1.11.1 → 1.11.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. package/dist/client.d.ts +220 -658
  2. package/dist/client.js +247 -654
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/ApplyEciScalingConfigurationRequest.d.ts +7 -0
  5. package/dist/models/ApplyEciScalingConfigurationRequest.js.map +1 -1
  6. package/dist/models/ApplyScalingGroupRequest.d.ts +17 -17
  7. package/dist/models/CreateAlarmRequest.d.ts +14 -17
  8. package/dist/models/CreateAlarmRequest.js.map +1 -1
  9. package/dist/models/CreateEciScalingConfigurationRequest.d.ts +3 -3
  10. package/dist/models/CreateNotificationConfigurationRequest.d.ts +9 -0
  11. package/dist/models/CreateNotificationConfigurationRequest.js.map +1 -1
  12. package/dist/models/CreateScalingConfigurationRequest.d.ts +543 -293
  13. package/dist/models/CreateScalingConfigurationRequest.js +27 -1
  14. package/dist/models/CreateScalingConfigurationRequest.js.map +1 -1
  15. package/dist/models/CreateScalingConfigurationResponseBody.d.ts +1 -1
  16. package/dist/models/CreateScalingConfigurationShrinkRequest.d.ts +543 -293
  17. package/dist/models/CreateScalingConfigurationShrinkRequest.js +27 -1
  18. package/dist/models/CreateScalingConfigurationShrinkRequest.js.map +1 -1
  19. package/dist/models/CreateScalingGroupRequest.d.ts +272 -205
  20. package/dist/models/CreateScalingGroupRequest.js.map +1 -1
  21. package/dist/models/CreateScalingRuleRequest.d.ts +15 -0
  22. package/dist/models/CreateScalingRuleRequest.js.map +1 -1
  23. package/dist/models/DeactivateScalingConfigurationRequest.d.ts +0 -5
  24. package/dist/models/DeactivateScalingConfigurationRequest.js.map +1 -1
  25. package/dist/models/DeactivateScalingConfigurationResponseBody.d.ts +0 -7
  26. package/dist/models/DeactivateScalingConfigurationResponseBody.js.map +1 -1
  27. package/dist/models/DescribeCandidateInstanceTypeRequest.d.ts +62 -0
  28. package/dist/models/DescribeCandidateInstanceTypeRequest.js.map +1 -1
  29. package/dist/models/DescribeCandidateInstanceTypeResponseBody.d.ts +9 -1
  30. package/dist/models/DescribeCandidateInstanceTypeResponseBody.js.map +1 -1
  31. package/dist/models/DescribeElasticStrengthRequest.d.ts +38 -34
  32. package/dist/models/DescribeElasticStrengthRequest.js.map +1 -1
  33. package/dist/models/DescribeElasticStrengthResponseBody.d.ts +78 -54
  34. package/dist/models/DescribeElasticStrengthResponseBody.js.map +1 -1
  35. package/dist/models/DescribeInstanceRefreshesRequest.d.ts +7 -6
  36. package/dist/models/DescribeInstanceRefreshesRequest.js.map +1 -1
  37. package/dist/models/DescribeInstanceRefreshesResponseBody.d.ts +85 -26
  38. package/dist/models/DescribeInstanceRefreshesResponseBody.js +2 -0
  39. package/dist/models/DescribeInstanceRefreshesResponseBody.js.map +1 -1
  40. package/dist/models/DescribeNotificationConfigurationsResponseBody.d.ts +3 -0
  41. package/dist/models/DescribeNotificationConfigurationsResponseBody.js.map +1 -1
  42. package/dist/models/DescribeRegionsResponseBody.d.ts +1 -1
  43. package/dist/models/DescribeScalingConfigurationsRequest.d.ts +8 -8
  44. package/dist/models/DescribeScalingConfigurationsResponseBody.d.ts +431 -240
  45. package/dist/models/DescribeScalingConfigurationsResponseBody.js +27 -1
  46. package/dist/models/DescribeScalingConfigurationsResponseBody.js.map +1 -1
  47. package/dist/models/DescribeScalingGroupDetailRequest.d.ts +1 -1
  48. package/dist/models/DescribeScalingInstancesRequest.d.ts +25 -25
  49. package/dist/models/DescribeScalingInstancesResponseBody.d.ts +46 -47
  50. package/dist/models/DescribeScalingInstancesResponseBody.js +2 -0
  51. package/dist/models/DescribeScalingInstancesResponseBody.js.map +1 -1
  52. package/dist/models/ModifyEciScalingConfigurationRequest.d.ts +1 -1
  53. package/dist/models/ModifyNotificationConfigurationRequest.d.ts +9 -0
  54. package/dist/models/ModifyNotificationConfigurationRequest.js.map +1 -1
  55. package/dist/models/ModifyScalingConfigurationRequest.d.ts +490 -296
  56. package/dist/models/ModifyScalingConfigurationRequest.js +27 -1
  57. package/dist/models/ModifyScalingConfigurationRequest.js.map +1 -1
  58. package/dist/models/ModifyScalingConfigurationResponseBody.d.ts +1 -1
  59. package/dist/models/ModifyScalingConfigurationShrinkRequest.d.ts +490 -296
  60. package/dist/models/ModifyScalingConfigurationShrinkRequest.js +27 -1
  61. package/dist/models/ModifyScalingConfigurationShrinkRequest.js.map +1 -1
  62. package/dist/models/ModifyScalingGroupRequest.d.ts +8 -0
  63. package/dist/models/ModifyScalingGroupRequest.js.map +1 -1
  64. package/dist/models/RemoveInstancesRequest.d.ts +33 -31
  65. package/dist/models/RemoveInstancesRequest.js.map +1 -1
  66. package/dist/models/RemoveInstancesResponseBody.d.ts +18 -2
  67. package/dist/models/RemoveInstancesResponseBody.js.map +1 -1
  68. package/dist/models/RemoveInstancesShrinkRequest.d.ts +28 -27
  69. package/dist/models/RemoveInstancesShrinkRequest.js.map +1 -1
  70. package/dist/models/ScaleWithAdjustmentRequest.d.ts +43 -36
  71. package/dist/models/ScaleWithAdjustmentRequest.js.map +1 -1
  72. package/dist/models/ScaleWithAdjustmentResponseBody.d.ts +15 -12
  73. package/dist/models/ScaleWithAdjustmentResponseBody.js.map +1 -1
  74. package/dist/models/ScaleWithAdjustmentShrinkRequest.d.ts +26 -20
  75. package/dist/models/ScaleWithAdjustmentShrinkRequest.js.map +1 -1
  76. package/dist/models/StartInstanceRefreshRequest.d.ts +43 -48
  77. package/dist/models/StartInstanceRefreshRequest.js +2 -0
  78. package/dist/models/StartInstanceRefreshRequest.js.map +1 -1
  79. package/dist/models/model.d.ts +5 -0
  80. package/dist/models/model.js +51 -40
  81. package/dist/models/model.js.map +1 -1
  82. package/package.json +1 -1
  83. package/src/client.ts +248 -654
  84. package/src/models/ApplyEciScalingConfigurationRequest.ts +7 -0
  85. package/src/models/ApplyScalingGroupRequest.ts +17 -17
  86. package/src/models/CreateAlarmRequest.ts +14 -17
  87. package/src/models/CreateEciScalingConfigurationRequest.ts +3 -3
  88. package/src/models/CreateNotificationConfigurationRequest.ts +9 -0
  89. package/src/models/CreateScalingConfigurationRequest.ts +560 -293
  90. package/src/models/CreateScalingConfigurationResponseBody.ts +1 -1
  91. package/src/models/CreateScalingConfigurationShrinkRequest.ts +560 -293
  92. package/src/models/CreateScalingGroupRequest.ts +273 -206
  93. package/src/models/CreateScalingRuleRequest.ts +15 -0
  94. package/src/models/DeactivateScalingConfigurationRequest.ts +0 -5
  95. package/src/models/DeactivateScalingConfigurationResponseBody.ts +0 -7
  96. package/src/models/DescribeCandidateInstanceTypeRequest.ts +62 -0
  97. package/src/models/DescribeCandidateInstanceTypeResponseBody.ts +9 -1
  98. package/src/models/DescribeElasticStrengthRequest.ts +38 -34
  99. package/src/models/DescribeElasticStrengthResponseBody.ts +78 -54
  100. package/src/models/DescribeInstanceRefreshesRequest.ts +7 -6
  101. package/src/models/DescribeInstanceRefreshesResponseBody.ts +87 -26
  102. package/src/models/DescribeNotificationConfigurationsResponseBody.ts +3 -0
  103. package/src/models/DescribeRegionsResponseBody.ts +1 -1
  104. package/src/models/DescribeScalingConfigurationsRequest.ts +8 -8
  105. package/src/models/DescribeScalingConfigurationsResponseBody.ts +448 -240
  106. package/src/models/DescribeScalingGroupDetailRequest.ts +1 -1
  107. package/src/models/DescribeScalingInstancesRequest.ts +26 -26
  108. package/src/models/DescribeScalingInstancesResponseBody.ts +50 -49
  109. package/src/models/ModifyEciScalingConfigurationRequest.ts +1 -1
  110. package/src/models/ModifyNotificationConfigurationRequest.ts +9 -0
  111. package/src/models/ModifyScalingConfigurationRequest.ts +507 -296
  112. package/src/models/ModifyScalingConfigurationResponseBody.ts +1 -1
  113. package/src/models/ModifyScalingConfigurationShrinkRequest.ts +507 -296
  114. package/src/models/ModifyScalingGroupRequest.ts +8 -0
  115. package/src/models/RemoveInstancesRequest.ts +35 -33
  116. package/src/models/RemoveInstancesResponseBody.ts +18 -2
  117. package/src/models/RemoveInstancesShrinkRequest.ts +30 -29
  118. package/src/models/ScaleWithAdjustmentRequest.ts +43 -36
  119. package/src/models/ScaleWithAdjustmentResponseBody.ts +15 -12
  120. package/src/models/ScaleWithAdjustmentShrinkRequest.ts +26 -20
  121. package/src/models/StartInstanceRefreshRequest.ts +45 -48
  122. package/src/models/model.ts +5 -0
package/dist/client.d.ts CHANGED
@@ -12,9 +12,9 @@ export default class Client extends OpenApi {
12
12
  * Applies a scaling configuration of the Elastic Container Instance type. If you want to create and manage scaling configurations of the Elastic Container Instance type by using a configuration file, you can call the ApplyEciScalingConfiguration operation.
13
13
  *
14
14
  * @remarks
15
- * Before you use a YAML configuration file to manage scaling configurations of the Elastic Container Instance type, you must take note of the following items:
16
- * * If you include a scaling configuration ID within your request, the system updates the scaling configuration based on the YAML configuration file.
17
- * * If you do not include a scaling configuration ID within your request, the system creates a scaling configuration of the Elastic Container Instance type based on the YAML configuration file.
15
+ * 基于YAML配置文件管理ECI类型的伸缩配置时,您需要注意以下事项:
16
+ * - 如果指定ECI类型的伸缩配置ID时,系统会基于YAML配置文件更新ECI类型的伸缩配置。
17
+ * - 如果未指定ECI类型的伸缩配置ID时,系统会基于YAML配置文件创建对应ECI类型的伸缩配置。
18
18
  *
19
19
  * @param request - ApplyEciScalingConfigurationRequest
20
20
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25,9 +25,9 @@ export default class Client extends OpenApi {
25
25
  * Applies a scaling configuration of the Elastic Container Instance type. If you want to create and manage scaling configurations of the Elastic Container Instance type by using a configuration file, you can call the ApplyEciScalingConfiguration operation.
26
26
  *
27
27
  * @remarks
28
- * Before you use a YAML configuration file to manage scaling configurations of the Elastic Container Instance type, you must take note of the following items:
29
- * * If you include a scaling configuration ID within your request, the system updates the scaling configuration based on the YAML configuration file.
30
- * * If you do not include a scaling configuration ID within your request, the system creates a scaling configuration of the Elastic Container Instance type based on the YAML configuration file.
28
+ * 基于YAML配置文件管理ECI类型的伸缩配置时,您需要注意以下事项:
29
+ * - 如果指定ECI类型的伸缩配置ID时,系统会基于YAML配置文件更新ECI类型的伸缩配置。
30
+ * - 如果未指定ECI类型的伸缩配置ID时,系统会基于YAML配置文件创建对应ECI类型的伸缩配置。
31
31
  *
32
32
  * @param request - ApplyEciScalingConfigurationRequest
33
33
  * @returns ApplyEciScalingConfigurationResponse
@@ -119,11 +119,6 @@ export default class Client extends OpenApi {
119
119
  /**
120
120
  * Attaches Application Load Balancer (ALB) server groups to a scaling group. To seamlessly adjust the number of instances in response to changes in your business workload or to maintain the uninterrupted accessibility of your application, you can call the AttachAlbServerGroups operation. By attaching ALB server groups to your scaling group, this operation enables Auto Scaling to automatically tailor your computing capacity to your business needs. Furthermore, it optimizes traffic routing by dynamically allocating incoming requests based on current workload patterns, which significantly improves the stability and performance of your application.
121
121
  *
122
- * @remarks
123
- * Before you call the operation to attach an ALB server group to your scaling group, make sure that the following requirements are met:
124
- * * The scaling group and the ALB server group share the same virtual private cloud (VPC).
125
- * * The ALB server group is in the Available state.
126
- *
127
122
  * @param request - AttachAlbServerGroupsRequest
128
123
  * @param runtime - runtime options for this request RuntimeOptions
129
124
  * @returns AttachAlbServerGroupsResponse
@@ -132,11 +127,6 @@ export default class Client extends OpenApi {
132
127
  /**
133
128
  * Attaches Application Load Balancer (ALB) server groups to a scaling group. To seamlessly adjust the number of instances in response to changes in your business workload or to maintain the uninterrupted accessibility of your application, you can call the AttachAlbServerGroups operation. By attaching ALB server groups to your scaling group, this operation enables Auto Scaling to automatically tailor your computing capacity to your business needs. Furthermore, it optimizes traffic routing by dynamically allocating incoming requests based on current workload patterns, which significantly improves the stability and performance of your application.
134
129
  *
135
- * @remarks
136
- * Before you call the operation to attach an ALB server group to your scaling group, make sure that the following requirements are met:
137
- * * The scaling group and the ALB server group share the same virtual private cloud (VPC).
138
- * * The ALB server group is in the Available state.
139
- *
140
130
  * @param request - AttachAlbServerGroupsRequest
141
131
  * @returns AttachAlbServerGroupsResponse
142
132
  */
@@ -144,15 +134,6 @@ export default class Client extends OpenApi {
144
134
  /**
145
135
  * Associates one or more ApsaraDB RDS instances with a scaling group.
146
136
  *
147
- * @remarks
148
- * Before you attach an ApsaraDB RDS instance to a scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
149
- * * The ApsaraDB RDS instance and the scaling group belong to the same Alibaba Cloud account.
150
- * * The ApsaraDB RDS instance is unlocked. For information about the lock policy, see [ApsaraDB RDS usage notes](https://help.aliyun.com/document_detail/41872.html).
151
- * * The ApsaraDB RDS instance is in the Running state.
152
- * * The ApsaraDB RDS instance exists in the Alibaba Cloud account.
153
- * * If you reattach an ApsaraDB RDS instance to a scaling group, the total number of attached ApsaraDB RDS instances of the scaling group remains unchanged. But Auto Scaling adds the private IP addresses of all Elastic Compute Service (ECS) instances in the scaling group to the IP address whitelist of the ApsaraDB RDS instance.
154
- * > After you attach an ApsaraDB RDS instance to a scaling group, make sure that the number of IP addresses in the default whitelist of the ApsaraDB RDS instance is limited to 1,000. For information about IP address whitelists, see [Configure an IP address whitelist](https://help.aliyun.com/document_detail/96118.html).
155
- *
156
137
  * @param request - AttachDBInstancesRequest
157
138
  * @param runtime - runtime options for this request RuntimeOptions
158
139
  * @returns AttachDBInstancesResponse
@@ -161,15 +142,6 @@ export default class Client extends OpenApi {
161
142
  /**
162
143
  * Associates one or more ApsaraDB RDS instances with a scaling group.
163
144
  *
164
- * @remarks
165
- * Before you attach an ApsaraDB RDS instance to a scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
166
- * * The ApsaraDB RDS instance and the scaling group belong to the same Alibaba Cloud account.
167
- * * The ApsaraDB RDS instance is unlocked. For information about the lock policy, see [ApsaraDB RDS usage notes](https://help.aliyun.com/document_detail/41872.html).
168
- * * The ApsaraDB RDS instance is in the Running state.
169
- * * The ApsaraDB RDS instance exists in the Alibaba Cloud account.
170
- * * If you reattach an ApsaraDB RDS instance to a scaling group, the total number of attached ApsaraDB RDS instances of the scaling group remains unchanged. But Auto Scaling adds the private IP addresses of all Elastic Compute Service (ECS) instances in the scaling group to the IP address whitelist of the ApsaraDB RDS instance.
171
- * > After you attach an ApsaraDB RDS instance to a scaling group, make sure that the number of IP addresses in the default whitelist of the ApsaraDB RDS instance is limited to 1,000. For information about IP address whitelists, see [Configure an IP address whitelist](https://help.aliyun.com/document_detail/96118.html).
172
- *
173
145
  * @param request - AttachDBInstancesRequest
174
146
  * @returns AttachDBInstancesResponse
175
147
  */
@@ -177,22 +149,6 @@ export default class Client extends OpenApi {
177
149
  /**
178
150
  * Adds instances to a scaling group to provide services or restarts Elastic Compute Service (ECS) instances stopped in Economical Mode to provide services. You can call the AttachInstances operation to add ECS instances, elastic container instances, or third-party instances managed by Alibaba Cloud to your scaling group to provide services. You can also call this operation to restart ECS instances stopped in Economical Mode in your scaling group to provide services.
179
151
  *
180
- * @remarks
181
- * Before you call this operation, take note of the following items:
182
- * * The scaling group is in the Active state.
183
- * * No scaling activities in the scaling group are in progress.
184
- * The ECS instances or the elastic container instances that you want to add to a scaling group must meet the following requirements:
185
- * * The instances reside in the same region as the scaling group.
186
- * * The instances must be in the Running state.
187
- * * The instances are not added to other scaling groups.
188
- * * The instances use the subscription or pay-as-you-go billing method, or are preemptible instances.
189
- * * If the VswitchID parameter is specified for a scaling group, the instances that are in the classic network or those that are not in the same virtual private cloud (VPC) as the specified vSwitch cannot be added to the scaling group.
190
- * * If the VswitchID parameter is not specified for a scaling group, the instances that are in VPCs cannot be added to the scaling group.
191
- * If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
192
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
193
- * If the sum of the number of instances that you want to add and the number of existing instances in the scaling group is greater than the value of the MaxSize parameter, the call fails.
194
- * Instances that are manually added by calling the AttachInstances operation are not associated with the active scaling configuration of the scaling group.
195
- *
196
152
  * @param request - AttachInstancesRequest
197
153
  * @param runtime - runtime options for this request RuntimeOptions
198
154
  * @returns AttachInstancesResponse
@@ -201,22 +157,6 @@ export default class Client extends OpenApi {
201
157
  /**
202
158
  * Adds instances to a scaling group to provide services or restarts Elastic Compute Service (ECS) instances stopped in Economical Mode to provide services. You can call the AttachInstances operation to add ECS instances, elastic container instances, or third-party instances managed by Alibaba Cloud to your scaling group to provide services. You can also call this operation to restart ECS instances stopped in Economical Mode in your scaling group to provide services.
203
159
  *
204
- * @remarks
205
- * Before you call this operation, take note of the following items:
206
- * * The scaling group is in the Active state.
207
- * * No scaling activities in the scaling group are in progress.
208
- * The ECS instances or the elastic container instances that you want to add to a scaling group must meet the following requirements:
209
- * * The instances reside in the same region as the scaling group.
210
- * * The instances must be in the Running state.
211
- * * The instances are not added to other scaling groups.
212
- * * The instances use the subscription or pay-as-you-go billing method, or are preemptible instances.
213
- * * If the VswitchID parameter is specified for a scaling group, the instances that are in the classic network or those that are not in the same virtual private cloud (VPC) as the specified vSwitch cannot be added to the scaling group.
214
- * * If the VswitchID parameter is not specified for a scaling group, the instances that are in VPCs cannot be added to the scaling group.
215
- * If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
216
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
217
- * If the sum of the number of instances that you want to add and the number of existing instances in the scaling group is greater than the value of the MaxSize parameter, the call fails.
218
- * Instances that are manually added by calling the AttachInstances operation are not associated with the active scaling configuration of the scaling group.
219
- *
220
160
  * @param request - AttachInstancesRequest
221
161
  * @returns AttachInstancesResponse
222
162
  */
@@ -224,15 +164,6 @@ export default class Client extends OpenApi {
224
164
  /**
225
165
  * Attaches load balancers to a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups. Load balancers help distribute the access traffic to the instances in scaling groups, which effectively improves the service performance of the scaling groups. You can call the AttachLoadBalancers operation to attach one or more load balancers to your scaling group.
226
166
  *
227
- * @remarks
228
- * Before you call this operation, make sure that the following requirements are met:
229
- * * The load balancer and the scaling group belong to the same Alibaba Cloud account and region.
230
- * * The load balancer is in the `Running` state.
231
- * * At least one listener is configured for the load balancer, and the health check feature is enabled for the load balancer.
232
- * * If the network type of the load balancer and the scaling group is virtual private cloud (VPC), they use the same VPC.
233
- * * If the network type of the scaling group is VPC, and that of the load balancer is classic network and a backend server of the load balancer uses a VPC, the scaling group and the backend server use the same VPC.
234
- * * The attachment of load balancers ensures that the cumulative number of load balancers attached to the scaling group stays within the predefined maximum limit. For information about the load balancer quota, see [Limits](https://help.aliyun.com/document_detail/25863.html).
235
- *
236
167
  * @param request - AttachLoadBalancersRequest
237
168
  * @param runtime - runtime options for this request RuntimeOptions
238
169
  * @returns AttachLoadBalancersResponse
@@ -241,15 +172,6 @@ export default class Client extends OpenApi {
241
172
  /**
242
173
  * Attaches load balancers to a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups. Load balancers help distribute the access traffic to the instances in scaling groups, which effectively improves the service performance of the scaling groups. You can call the AttachLoadBalancers operation to attach one or more load balancers to your scaling group.
243
174
  *
244
- * @remarks
245
- * Before you call this operation, make sure that the following requirements are met:
246
- * * The load balancer and the scaling group belong to the same Alibaba Cloud account and region.
247
- * * The load balancer is in the `Running` state.
248
- * * At least one listener is configured for the load balancer, and the health check feature is enabled for the load balancer.
249
- * * If the network type of the load balancer and the scaling group is virtual private cloud (VPC), they use the same VPC.
250
- * * If the network type of the scaling group is VPC, and that of the load balancer is classic network and a backend server of the load balancer uses a VPC, the scaling group and the backend server use the same VPC.
251
- * * The attachment of load balancers ensures that the cumulative number of load balancers attached to the scaling group stays within the predefined maximum limit. For information about the load balancer quota, see [Limits](https://help.aliyun.com/document_detail/25863.html).
252
- *
253
175
  * @param request - AttachLoadBalancersRequest
254
176
  * @returns AttachLoadBalancersResponse
255
177
  */
@@ -272,23 +194,6 @@ export default class Client extends OpenApi {
272
194
  /**
273
195
  * Attaches vServer groups to a scaling group. After a Classic Load Balancer (CLB) instance is attached to your scaling group, the instances in the scaling group are automatically added as backend servers of the CLB instance. These servers then handle requests forwarded by the CLB instance, streamlining the processing of incoming traffic. To direct varying access requests to separate backend servers or to distribute requests based on domain names or URLs, you can call the AttachVServerGroups operation. This operation enables the addition of multiple vServer groups, allowing for efficient management of various backend server configurations tailored to your routing preferences.
274
196
  *
275
- * @remarks
276
- * Before you call this operation, make sure that the following requirements are met:
277
- * * The CLB instance and the scaling group belong to the same Alibaba Cloud account.
278
- * * The CLB instance and the scaling group reside in the same region.
279
- * * The CLB instance is in the Running state.
280
- * * The CLB instance is configured with at least one listener. The health check feature is enabled for the CLB instance.
281
- * * If the network type of both the CLB instance and the scaling group is virtual private cloud (VPC), they use the same VPC.
282
- * * If the network type of the scaling group is VPC and the network type of the CLB instance is classic network, any backend server of the CLB instance within a VPC setup shares the same VPC as the scaling group.
283
- * * The vServer groups that you want to attach to the scaling group belong to the CLB instance.
284
- * * The operation to attach vServer groups does not result in the total number of vServer groups exceeding the predefined quota limit. For information about the vServer group quota, see [Limits](https://help.aliyun.com/document_detail/25863.html).
285
- * * When you call this operation to attach vServer groups, you must specify the following parameters:
286
- * * LoadBalancerId: the ID of the CLB instance
287
- * * VServerGroupId: the ID of the vServer group
288
- * * Port: the port number of the vServer group
289
- * **
290
- * **Note** If you attempt to attach the same vServer group to a scaling group multiple times over the identical port, the system regards each attempt as a separate vServer group attachment to the scaling group. In your request, if you include the same vServer group ID coupled with the same port number multiple times, only the first configuration of the vServer group and port number pairing is considered valid. Subsequent vServer group and port number parings are disregarded.
291
- *
292
197
  * @param request - AttachVServerGroupsRequest
293
198
  * @param runtime - runtime options for this request RuntimeOptions
294
199
  * @returns AttachVServerGroupsResponse
@@ -297,23 +202,6 @@ export default class Client extends OpenApi {
297
202
  /**
298
203
  * Attaches vServer groups to a scaling group. After a Classic Load Balancer (CLB) instance is attached to your scaling group, the instances in the scaling group are automatically added as backend servers of the CLB instance. These servers then handle requests forwarded by the CLB instance, streamlining the processing of incoming traffic. To direct varying access requests to separate backend servers or to distribute requests based on domain names or URLs, you can call the AttachVServerGroups operation. This operation enables the addition of multiple vServer groups, allowing for efficient management of various backend server configurations tailored to your routing preferences.
299
204
  *
300
- * @remarks
301
- * Before you call this operation, make sure that the following requirements are met:
302
- * * The CLB instance and the scaling group belong to the same Alibaba Cloud account.
303
- * * The CLB instance and the scaling group reside in the same region.
304
- * * The CLB instance is in the Running state.
305
- * * The CLB instance is configured with at least one listener. The health check feature is enabled for the CLB instance.
306
- * * If the network type of both the CLB instance and the scaling group is virtual private cloud (VPC), they use the same VPC.
307
- * * If the network type of the scaling group is VPC and the network type of the CLB instance is classic network, any backend server of the CLB instance within a VPC setup shares the same VPC as the scaling group.
308
- * * The vServer groups that you want to attach to the scaling group belong to the CLB instance.
309
- * * The operation to attach vServer groups does not result in the total number of vServer groups exceeding the predefined quota limit. For information about the vServer group quota, see [Limits](https://help.aliyun.com/document_detail/25863.html).
310
- * * When you call this operation to attach vServer groups, you must specify the following parameters:
311
- * * LoadBalancerId: the ID of the CLB instance
312
- * * VServerGroupId: the ID of the vServer group
313
- * * Port: the port number of the vServer group
314
- * **
315
- * **Note** If you attempt to attach the same vServer group to a scaling group multiple times over the identical port, the system regards each attempt as a separate vServer group attachment to the scaling group. In your request, if you include the same vServer group ID coupled with the same port number multiple times, only the first configuration of the vServer group and port number pairing is considered valid. Subsequent vServer group and port number parings are disregarded.
316
- *
317
205
  * @param request - AttachVServerGroupsRequest
318
206
  * @returns AttachVServerGroupsResponse
319
207
  */
@@ -365,9 +253,6 @@ export default class Client extends OpenApi {
365
253
  /**
366
254
  * Ends the timeout period of a lifecycle hook ahead of schedule. If you have created a lifecycle hook for your scaling group, you can call the CompleteLifecycleAction operation to end the timeout period of the lifecycle hook ahead of schedule based on your business requirements.
367
255
  *
368
- * @remarks
369
- * When you manually cut short the timeout period of a lifecycle hook, Auto Scaling proceeds with one of the following actions based on the predefined settings: responding to the scaling request, aborting the scaling request, and initiating a rollback process.
370
- *
371
256
  * @param request - CompleteLifecycleActionRequest
372
257
  * @param runtime - runtime options for this request RuntimeOptions
373
258
  * @returns CompleteLifecycleActionResponse
@@ -376,9 +261,6 @@ export default class Client extends OpenApi {
376
261
  /**
377
262
  * Ends the timeout period of a lifecycle hook ahead of schedule. If you have created a lifecycle hook for your scaling group, you can call the CompleteLifecycleAction operation to end the timeout period of the lifecycle hook ahead of schedule based on your business requirements.
378
263
  *
379
- * @remarks
380
- * When you manually cut short the timeout period of a lifecycle hook, Auto Scaling proceeds with one of the following actions based on the predefined settings: responding to the scaling request, aborting the scaling request, and initiating a rollback process.
381
- *
382
264
  * @param request - CompleteLifecycleActionRequest
383
265
  * @returns CompleteLifecycleActionResponse
384
266
  */
@@ -431,8 +313,8 @@ export default class Client extends OpenApi {
431
313
  * Creates a scaling configuration of the Elastic Container Instance type. Auto Scaling uses the scaling configuration as a template to create elastic container instances to meet your business requirements during scale-out events.
432
314
  *
433
315
  * @remarks
434
- * A scaling configuration is a template that is used to create elastic container instances during scale-out events.
435
- * You can specify CPU and Memory to determine the range of instance types. Then, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Auto Scaling preferentially creates elastic container instances by using the lowest-priced instance type. This method applies only if you set Scaling Policy to Cost Optimization Policy and no instance type is specified in the scaling configuration.
316
+ * 伸缩配置用来指定弹性扩张时使用的ECI实例模板。
317
+ * 参数Cpu和Memory用于指定CPU和内存定义实例规格的范围,弹性伸缩会结合IO优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。该方式仅适用于伸缩组的扩缩容策略为成本优化策略,且伸缩配置未指定实例规格的场景。
436
318
  *
437
319
  * @param request - CreateEciScalingConfigurationRequest
438
320
  * @param runtime - runtime options for this request RuntimeOptions
@@ -443,8 +325,8 @@ export default class Client extends OpenApi {
443
325
  * Creates a scaling configuration of the Elastic Container Instance type. Auto Scaling uses the scaling configuration as a template to create elastic container instances to meet your business requirements during scale-out events.
444
326
  *
445
327
  * @remarks
446
- * A scaling configuration is a template that is used to create elastic container instances during scale-out events.
447
- * You can specify CPU and Memory to determine the range of instance types. Then, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Auto Scaling preferentially creates elastic container instances by using the lowest-priced instance type. This method applies only if you set Scaling Policy to Cost Optimization Policy and no instance type is specified in the scaling configuration.
328
+ * 伸缩配置用来指定弹性扩张时使用的ECI实例模板。
329
+ * 参数Cpu和Memory用于指定CPU和内存定义实例规格的范围,弹性伸缩会结合IO优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。该方式仅适用于伸缩组的扩缩容策略为成本优化策略,且伸缩配置未指定实例规格的场景。
448
330
  *
449
331
  * @param request - CreateEciScalingConfigurationRequest
450
332
  * @returns CreateEciScalingConfigurationResponse
@@ -453,12 +335,6 @@ export default class Client extends OpenApi {
453
335
  /**
454
336
  * Creates one or more lifecycle hooks in a scaling group. A lifecycle hook allows you to execute custom actions like sending notifications or automating script execution at critical stages (such as instance startup and termination) in the lifecycle of an instance. Implementing the lifecycle hook feature allows for finer control and management of instances. For example, you can verify configurations, set up custom tasks, or back up data on your instances when lifecycle hooks take effect, thus enhancing the flexibility and reliability of application deployment.
455
337
  *
456
- * @remarks
457
- * You can create a maximum of 10 lifecycle hooks for each scaling group. When a scaling activity occurs in a scaling group with a lifecycle hook, the hook pauses the activity for a specified period. This waiting period is determined by the HeartbeatTimeout parameter. You can perform custom operations, like initializing ECS instance configurations or querying ECS instance data, before the lifecycle hook expires.
458
- * During a scale-out event, the private IP addresses of ECS instances are added to the IP address whitelists of the associated ApsaraDB RDS instances. The ECS instances are then added to the backend server groups of the associated Server Load Balancer (SLB) instances only after the lifecycle hook times out. During a scale-in event, the private IP addresses of ECS instances are removed from the IP address whitelists of the associated ApsaraDB RDS instances. Additionally, the ECS instances are removed from the backend server groups of the associated SLB instances only after the lifecycle hook times out.
459
- * For each lifecycle hook, you must specify a notification recipient. When lifecycle hooks are triggered, notifications can be delivered through Simple Message Queue (SMQ, formerly MNS) topics, SMQ queues, or CloudOps Orchestration Service (OOS) templates. If you want to configure an OOS template, you must create a Resource Access Management (RAM) role for OOS. For more information, see [Use RAM to grant permissions to OOS](https://help.aliyun.com/document_detail/120810.html).
460
- * > If your scaling group contains existing ECS instances and you\\"ve configured an OOS template to manage their private IP addresses in the whitelists of non-ApsaraDB RDS databases, you must manually add or remove those IPs from the whitelists.
461
- *
462
338
  * @param request - CreateLifecycleHookRequest
463
339
  * @param runtime - runtime options for this request RuntimeOptions
464
340
  * @returns CreateLifecycleHookResponse
@@ -467,12 +343,6 @@ export default class Client extends OpenApi {
467
343
  /**
468
344
  * Creates one or more lifecycle hooks in a scaling group. A lifecycle hook allows you to execute custom actions like sending notifications or automating script execution at critical stages (such as instance startup and termination) in the lifecycle of an instance. Implementing the lifecycle hook feature allows for finer control and management of instances. For example, you can verify configurations, set up custom tasks, or back up data on your instances when lifecycle hooks take effect, thus enhancing the flexibility and reliability of application deployment.
469
345
  *
470
- * @remarks
471
- * You can create a maximum of 10 lifecycle hooks for each scaling group. When a scaling activity occurs in a scaling group with a lifecycle hook, the hook pauses the activity for a specified period. This waiting period is determined by the HeartbeatTimeout parameter. You can perform custom operations, like initializing ECS instance configurations or querying ECS instance data, before the lifecycle hook expires.
472
- * During a scale-out event, the private IP addresses of ECS instances are added to the IP address whitelists of the associated ApsaraDB RDS instances. The ECS instances are then added to the backend server groups of the associated Server Load Balancer (SLB) instances only after the lifecycle hook times out. During a scale-in event, the private IP addresses of ECS instances are removed from the IP address whitelists of the associated ApsaraDB RDS instances. Additionally, the ECS instances are removed from the backend server groups of the associated SLB instances only after the lifecycle hook times out.
473
- * For each lifecycle hook, you must specify a notification recipient. When lifecycle hooks are triggered, notifications can be delivered through Simple Message Queue (SMQ, formerly MNS) topics, SMQ queues, or CloudOps Orchestration Service (OOS) templates. If you want to configure an OOS template, you must create a Resource Access Management (RAM) role for OOS. For more information, see [Use RAM to grant permissions to OOS](https://help.aliyun.com/document_detail/120810.html).
474
- * > If your scaling group contains existing ECS instances and you\\"ve configured an OOS template to manage their private IP addresses in the whitelists of non-ApsaraDB RDS databases, you must manually add or remove those IPs from the whitelists.
475
- *
476
346
  * @param request - CreateLifecycleHookRequest
477
347
  * @returns CreateLifecycleHookResponse
478
348
  */
@@ -481,9 +351,9 @@ export default class Client extends OpenApi {
481
351
  * Creates a notification rule. You can call the CreateNotificationConfiguration operation to create a notification rule to stay informed about scaling events or resource changes. This helps you learn about the dynamic status of your scaling group in real time and further automates the management of scaling events.
482
352
  *
483
353
  * @remarks
484
- * You can specify CloudMonitor system events, Simple Message Queue (SMQ, formerly MNS) topics, or SMQ queues as notification recipients. When a scaling event of the specified type or resource change occurs in your scaling group, Auto Scaling automatically sends notifications to CloudMonitor or SMQ.
485
- * * You cannot specify the same recipient for notifications of different event types in a scaling group.
486
- * For example, you cannot enable the same CloudMonitor system event, SMQ topic, or SMQ queue to receive notifications of different event types in a scaling group.
354
+ * - You can configure message notifications to be received by CloudMonitor system events, Message Service (formerly MNS) queues, or Message Service (formerly MNS) topics. When specified scaling events or resource changes occur in a scaling group, automatic scaling notifies CloudMonitor or Message Service (formerly MNS).
355
+ * - Different event notifications within the same scaling group cannot share the same accepter.
356
+ * For example, different event notifications cannot simultaneously use the same CloudMonitor configuration, the same MNS topic, or the same MNS queue.
487
357
  *
488
358
  * @param request - CreateNotificationConfigurationRequest
489
359
  * @param runtime - runtime options for this request RuntimeOptions
@@ -494,25 +364,28 @@ export default class Client extends OpenApi {
494
364
  * Creates a notification rule. You can call the CreateNotificationConfiguration operation to create a notification rule to stay informed about scaling events or resource changes. This helps you learn about the dynamic status of your scaling group in real time and further automates the management of scaling events.
495
365
  *
496
366
  * @remarks
497
- * You can specify CloudMonitor system events, Simple Message Queue (SMQ, formerly MNS) topics, or SMQ queues as notification recipients. When a scaling event of the specified type or resource change occurs in your scaling group, Auto Scaling automatically sends notifications to CloudMonitor or SMQ.
498
- * * You cannot specify the same recipient for notifications of different event types in a scaling group.
499
- * For example, you cannot enable the same CloudMonitor system event, SMQ topic, or SMQ queue to receive notifications of different event types in a scaling group.
367
+ * - You can configure message notifications to be received by CloudMonitor system events, Message Service (formerly MNS) queues, or Message Service (formerly MNS) topics. When specified scaling events or resource changes occur in a scaling group, automatic scaling notifies CloudMonitor or Message Service (formerly MNS).
368
+ * - Different event notifications within the same scaling group cannot share the same accepter.
369
+ * For example, different event notifications cannot simultaneously use the same CloudMonitor configuration, the same MNS topic, or the same MNS queue.
500
370
  *
501
371
  * @param request - CreateNotificationConfigurationRequest
502
372
  * @returns CreateNotificationConfigurationResponse
503
373
  */
504
374
  createNotificationConfiguration(request: $_model.CreateNotificationConfigurationRequest): Promise<$_model.CreateNotificationConfigurationResponse>;
505
375
  /**
506
- * Creates scaling configurations. When you call the CreateScalingConfiguration operation, you can specify the scaling group ID, instance type, and image to create a scaling configuration of the Elastic Compute Service (ECS) type.
376
+ * Call the CreateScalingConfiguration operation to create an ECS scaling configuration for a scaling group. You must specify the scaling group ID, instance type, and image.
507
377
  *
508
378
  * @remarks
509
- * Auto Scaling automatically creates Elastic Compute Service (ECS) instances based on the specified scaling configuration. ECS instances can be created in the following modes:
510
- * * InstancePatternInfos: intelligent configuration mode. In this mode, you need to only specify the number of vCPUs, memory size, instance family, and maximum price. Auto Scaling selects the instance type that has the lowest price based on the configurations to create ECS instances. This mode is available only for scaling groups that reside in virtual private clouds (VPCs). This mode reduces scale-out failures caused by insufficient inventory of instance types.
511
- * * InstanceType: In this mode, you must specify one instance type.
512
- * * InstanceTypes: In this mode, you can specify more than one instance type.
513
- * * InstanceTypeOverrides: In this mode, you can specify multiple instance types and weights for the instance types.
514
- * * Cpu and Memory: In this mode, you must specify the number of vCPUs and the memory size. Auto Scaling determines the range of available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling creates ECS instances by using the lowest-priced instance type. This mode is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
515
- * > You cannot specify InstanceType, InstanceTypes, InstanceTypeOverrides, and Cpu and Memory at the same time. You can specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfo at the same time. If you specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfos at the same time, Auto Scaling preferentially uses the instance types that are specified by InstanceType or InstanceTypes for scale-outs. If the instance types that are specified by InstanceType or InstanceTypes do not have sufficient inventory, Auto Scaling uses the instance types that are specified by InstancePatternInfos for scale-outs.
379
+ * A scaling configuration is a template that defines the ECS instances to be created during a scale-out event. You can configure instances in the following ways:
380
+ * - InstancePatternInfos: Use the intelligent configuration mode. You do not need to specify an instance type. Instead, you specify the number of vCPUs, memory size, instance family level, and maximum price based on your business needs. The system automatically selects eligible instance types and prioritizes the instance type with the lowest price to create ECS instances. This mode is available only when the network type of the scaling group is VPC. It can effectively reduce the risk of instance creation failures during scale-out events due to an instance type being out of stock.
381
+ * - InstanceType: Specify a single instance type.
382
+ * - InstanceTypes: Specify multiple instance types.
383
+ * - InstanceTypeOverrides: Specify multiple instance types and configure a weight for each instance type.
384
+ * - Cpu and Memory: Specify a range of instance types by setting the number of vCPUs and memory size. Auto Scaling determines the available instance types based on factors such as I/O optimization and zone. It then creates the instance with the lowest price. This method is applicable only if the scaling policy of the scaling group is the cost optimization policy and no instance type is specified in the scaling configuration.
385
+ * - You can attach a primary network interface controller (NIC) in one of the following ways. Note that you can use only one method in a single call. If you use both methods, the call fails and an error message is returned.
386
+ * - Directly configure the primary NIC using parameters such as SecurityGroupId, SecurityGroupIds, and Ipv6AddressCount.
387
+ * - Configure the primary and secondary NICs using the NetworkInterfaces parameter. When you use this parameter, you must configure the primary NIC. Set NetworkInterface.InstanceType to Primary to configure the primary NIC. To configure a secondary NIC, set NetworkInterface.InstanceType to Secondary or leave the parameter empty.
388
+ * > You cannot specify \\`InstanceType\\`, \\`InstanceTypes\\`, \\`InstanceTypeOverrides\\`, and \\`Cpu\\`/\\`Memory\\` at the same time. However, you can specify \\`InstanceType\\` or \\`InstanceTypes\\` together with \\`InstancePatternInfos\\`. If you specify them together, Auto Scaling prioritizes the specified instance types during scale-outs. If the specified instance types are out of stock, Auto Scaling uses instance types that match the \\`InstancePatternInfos\\` configuration.
516
389
  *
517
390
  * @param tmpReq - CreateScalingConfigurationRequest
518
391
  * @param runtime - runtime options for this request RuntimeOptions
@@ -520,47 +393,50 @@ export default class Client extends OpenApi {
520
393
  */
521
394
  createScalingConfigurationWithOptions(tmpReq: $_model.CreateScalingConfigurationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateScalingConfigurationResponse>;
522
395
  /**
523
- * Creates scaling configurations. When you call the CreateScalingConfiguration operation, you can specify the scaling group ID, instance type, and image to create a scaling configuration of the Elastic Compute Service (ECS) type.
396
+ * Call the CreateScalingConfiguration operation to create an ECS scaling configuration for a scaling group. You must specify the scaling group ID, instance type, and image.
524
397
  *
525
398
  * @remarks
526
- * Auto Scaling automatically creates Elastic Compute Service (ECS) instances based on the specified scaling configuration. ECS instances can be created in the following modes:
527
- * * InstancePatternInfos: intelligent configuration mode. In this mode, you need to only specify the number of vCPUs, memory size, instance family, and maximum price. Auto Scaling selects the instance type that has the lowest price based on the configurations to create ECS instances. This mode is available only for scaling groups that reside in virtual private clouds (VPCs). This mode reduces scale-out failures caused by insufficient inventory of instance types.
528
- * * InstanceType: In this mode, you must specify one instance type.
529
- * * InstanceTypes: In this mode, you can specify more than one instance type.
530
- * * InstanceTypeOverrides: In this mode, you can specify multiple instance types and weights for the instance types.
531
- * * Cpu and Memory: In this mode, you must specify the number of vCPUs and the memory size. Auto Scaling determines the range of available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling creates ECS instances by using the lowest-priced instance type. This mode is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
532
- * > You cannot specify InstanceType, InstanceTypes, InstanceTypeOverrides, and Cpu and Memory at the same time. You can specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfo at the same time. If you specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfos at the same time, Auto Scaling preferentially uses the instance types that are specified by InstanceType or InstanceTypes for scale-outs. If the instance types that are specified by InstanceType or InstanceTypes do not have sufficient inventory, Auto Scaling uses the instance types that are specified by InstancePatternInfos for scale-outs.
399
+ * A scaling configuration is a template that defines the ECS instances to be created during a scale-out event. You can configure instances in the following ways:
400
+ * - InstancePatternInfos: Use the intelligent configuration mode. You do not need to specify an instance type. Instead, you specify the number of vCPUs, memory size, instance family level, and maximum price based on your business needs. The system automatically selects eligible instance types and prioritizes the instance type with the lowest price to create ECS instances. This mode is available only when the network type of the scaling group is VPC. It can effectively reduce the risk of instance creation failures during scale-out events due to an instance type being out of stock.
401
+ * - InstanceType: Specify a single instance type.
402
+ * - InstanceTypes: Specify multiple instance types.
403
+ * - InstanceTypeOverrides: Specify multiple instance types and configure a weight for each instance type.
404
+ * - Cpu and Memory: Specify a range of instance types by setting the number of vCPUs and memory size. Auto Scaling determines the available instance types based on factors such as I/O optimization and zone. It then creates the instance with the lowest price. This method is applicable only if the scaling policy of the scaling group is the cost optimization policy and no instance type is specified in the scaling configuration.
405
+ * - You can attach a primary network interface controller (NIC) in one of the following ways. Note that you can use only one method in a single call. If you use both methods, the call fails and an error message is returned.
406
+ * - Directly configure the primary NIC using parameters such as SecurityGroupId, SecurityGroupIds, and Ipv6AddressCount.
407
+ * - Configure the primary and secondary NICs using the NetworkInterfaces parameter. When you use this parameter, you must configure the primary NIC. Set NetworkInterface.InstanceType to Primary to configure the primary NIC. To configure a secondary NIC, set NetworkInterface.InstanceType to Secondary or leave the parameter empty.
408
+ * > You cannot specify \\`InstanceType\\`, \\`InstanceTypes\\`, \\`InstanceTypeOverrides\\`, and \\`Cpu\\`/\\`Memory\\` at the same time. However, you can specify \\`InstanceType\\` or \\`InstanceTypes\\` together with \\`InstancePatternInfos\\`. If you specify them together, Auto Scaling prioritizes the specified instance types during scale-outs. If the specified instance types are out of stock, Auto Scaling uses instance types that match the \\`InstancePatternInfos\\` configuration.
533
409
  *
534
410
  * @param request - CreateScalingConfigurationRequest
535
411
  * @returns CreateScalingConfigurationResponse
536
412
  */
537
413
  createScalingConfiguration(request: $_model.CreateScalingConfigurationRequest): Promise<$_model.CreateScalingConfigurationResponse>;
538
414
  /**
539
- * Creates a scaling group. You can call the CreateScalingGroup operation to automate the adjustment of computing power of a specific type based on your business requirements and scaling polices.
540
- *
541
- * @remarks
542
- * A scaling group is a group of Elastic Compute Service (ECS) instances that can be used for similar purposes.
543
- * You can create only a limited number of scaling groups in a region. To check the quota of the scaling groups, go to Quota Center.
544
- * A scaling group does not immediately take effect after you create it. You can call the [EnableScalingGroup](https://help.aliyun.com/document_detail/25939.html) operation to enable a scaling group. You can trigger scaling events and execute scaling rules only in scaling groups that are in the Enabled state.
545
- * If you want to attach a Classic Load Balancer (CLB, formerly known as SLB) instance and an ApsaraDB RDS instance to the scaling group that you want to create, the scaling group, the CLB instance, and the ApsaraDB RDS instance must reside in the same region. For more information, see [Regions and zones](https://help.aliyun.com/document_detail/40654.html).
546
- * If you attach a CLB instance to the scaling group that you want to create, Auto Scaling automatically adds the ECS instances in the scaling group to the backend server groups of the CLB instance. You can specify the following types of server groups to add ECS instances:
547
- * * Default server group: ECS instances in this group process frontend requests. If no listeners are configured for vServer groups or primary/secondary server groups, the frontend requests are forwarded to the ECS instances in the default server group.
548
- * * vServer group: If you want to forward different requests to different backend servers, or you want to forward requests based on domain names or URLs, you can specify vServer groups.
549
- * > If you specify both the default server group and multiple VServer groups, the ECS instances are added to these server groups.
550
- * The default weight of each ECS instance as a backend server is 50. The CLB instance must meet the following requirements:
551
- * * The CLB instance is in the Active state. You can call the [DescribeLoadBalancers](https://help.aliyun.com/document_detail/2401696.html) operation to query the status of CLB instances.
552
- * * All listening ports configured for the CLB instance must be health check. Otherwise, the scaling group fails to be created.
553
- * If you attach Application Load Balancer (ALB), Network Load Balancer (NLB), or Gateway Load Balancer (GWLB) server groups to the scaling group that you want to create, Auto Scaling adds the ECS instances in your scaling group to the ALB or NLB server groups to process the access requests forwarded by the corresponding ALB or NLB instances. You can specify multiple ALB, NLB, or GWLB server groups, but the server groups must belong to the same VPC as the scaling group. For more information, see [AttachAlbServerGroups](https://help.aliyun.com/document_detail/266800.html) or [AttachServerGroups](https://help.aliyun.com/document_detail/600535.html).
554
- * If you associate an RDS instance with the scaling group, the scaling group will automatically add the internal IP addresses of ECS instances that join the scaling group to the access whitelist of the RDS instance. The RDS instance must meet the following requirements:
555
- * * The RDS instance must be in the Running state. You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/610396.html) operation to view the status of the specified RDS instance.
556
- * * The number of IPs in the RDS instance\\"s access whitelist cannot exceed the upper limit. For more information, see [Configure a whitelist](https://help.aliyun.com/document_detail/43185.html).
557
- * If the MultiAZPolicy for the scaling group is set to COST_OPTIMIZED, the following rules apply:
558
- * * When you specify OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, and SpotInstancePools parameters (i.e., defining the instance allocation method under the cost optimization policy), Auto Scaling will prioritize this allocation method during scaling operations.
559
- * * If you do not specify OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, or SpotInstancePools, Auto Scaling preferentially creates instances of the lowest-priced instance type based on the cost optimization policy.
560
- * If you set `Tags.Propagate` to true, the following rules will apply:
561
- * * Tags added to the scaling group will only propagate to newly created instances and will not affect instances already running within the scaling group.
562
- * * If instance tags are specified in the scaling configuration and the scaling group’s tags are propagated to the instance, all tags will coexist.
563
- * * If the tag key specified in the scaling configuration matches a tag key in the scaling group, the tag value from the scaling configuration will take precedence.
415
+ * Call the `CreateScalingGroup` API to create a scaling group. The group automatically adjusts your computing capacity (the number of instances) by scaling instances of a specified type in or out based on your business requirements and scaling policies.
416
+ *
417
+ * @remarks
418
+ * A scaling group is a collection of ECS instances for the same use case.
419
+ * The number of scaling groups that you can create in a region depends on your Auto Scaling usage. To view your quota for scaling groups, go to Quota Center.
420
+ * A scaling group is not active immediately after creation. You must call the [EnableScalingGroup](https://help.aliyun.com/document_detail/25939.html) operation to enable the group before it can trigger scaling activities or execute scaling rules.
421
+ * The scaling group, as well as its associated Classic Load Balancer (CLB) (formerly SLB) and RDS instances, must be in the same region. For more information, see [Regions and availability zones](https://help.aliyun.com/document_detail/40654.html).
422
+ * If you associate a CLB instance with a scaling group, the scaling group automatically adds new ECS instances to a backend server group of the CLB instance. You can specify which server group to use. The following types of server groups are supported:
423
+ * - Default server group: A group of ECS instances that receive requests from the front end. If no vServer group or primary/standby server group is configured for a listener, it forwards requests to the ECS instances in the default server group.
424
+ * - vServer group: Use a vServer group if you need to forward different requests to different backend servers, or forward requests based on domain names and URLs.
425
+ * > If you specify both a default server group and one or more vServer groups, the scaling group adds new ECS instances to all specified server groups.
426
+ * After an instance is added to a backend server group of a CLB instance, its default weight is 50. The CLB instance must meet the following conditions:
427
+ * - The CLB instance must be in the active state. You can call the [DescribeLoadBalancers](https://help.aliyun.com/document_detail/2401696.html) operation to check the state of a CLB instance.
428
+ * - Health checks must be enabled for all listeners configured on the CLB instance. Otherwise, the scaling group creation fails.
429
+ * If you associate a scaling group with Application Load Balancer (ALB), Network Load Balancer (NLB), or Gateway Load Balancer (GWLB) server groups, it automatically adds new ECS instances as backend servers to those groups to handle distributed requests. You can specify multiple such server groups, but they must all belong to the same VPC as the scaling group. For more information, see [AttachAlbServerGroups](https://help.aliyun.com/document_detail/266800.html) or [AttachServerGroups](https://help.aliyun.com/document_detail/600535.html).
430
+ * If you associate an RDS instance with a scaling group, the scaling group automatically adds the internal IP addresses of new ECS instances to the IP address whitelist of the RDS instance. The RDS instance must meet the following conditions:
431
+ * - The RDS instance must be in the Running state. You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/610396.html) operation to check the state of an RDS instance.
432
+ * - The number of IP addresses in the RDS instance\\"s IP address whitelist cannot exceed the limit. For more information, see the [Configure an IP address whitelist](https://help.aliyun.com/document_detail/43185.html) topic in the RDS documentation.
433
+ * If the `MultiAZPolicy` of a scaling group is set to `COST_OPTIMIZED`:
434
+ * - If you specify the `OnDemandBaseCapacity`, `OnDemandPercentageAboveBaseCapacity`, and `SpotInstancePools` parameters, you define the instance allocation strategy for the cost-optimized policy. Auto Scaling prioritizes this strategy during scaling activities.
435
+ * - If you do not specify the `OnDemandBaseCapacity`, `OnDemandPercentageAboveBaseCapacity`, or `SpotInstancePools` parameters, the cost-optimized policy creates instances by using only the lowest-cost method. In this mode, you cannot create instances by using the Elastic Guarantee service or the Capacity Reservation service.
436
+ * If you enable tag propagation for a scaling group by setting `Tags.Propagate` to `true`:
437
+ * - The scaling group propagates its tags only to new instances, not to existing instances.
438
+ * - If you specify instance tags in the scaling configuration and also choose to propagate tags from the scaling group, Auto Scaling applies both sets of tags to the new instances.
439
+ * - If a tag from the scaling configuration and a propagated tag from the scaling group have the same tag key, the tag value from the scaling configuration takes precedence.
564
440
  *
565
441
  * @param request - CreateScalingGroupRequest
566
442
  * @param runtime - runtime options for this request RuntimeOptions
@@ -568,52 +444,52 @@ export default class Client extends OpenApi {
568
444
  */
569
445
  createScalingGroupWithOptions(request: $_model.CreateScalingGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateScalingGroupResponse>;
570
446
  /**
571
- * Creates a scaling group. You can call the CreateScalingGroup operation to automate the adjustment of computing power of a specific type based on your business requirements and scaling polices.
572
- *
573
- * @remarks
574
- * A scaling group is a group of Elastic Compute Service (ECS) instances that can be used for similar purposes.
575
- * You can create only a limited number of scaling groups in a region. To check the quota of the scaling groups, go to Quota Center.
576
- * A scaling group does not immediately take effect after you create it. You can call the [EnableScalingGroup](https://help.aliyun.com/document_detail/25939.html) operation to enable a scaling group. You can trigger scaling events and execute scaling rules only in scaling groups that are in the Enabled state.
577
- * If you want to attach a Classic Load Balancer (CLB, formerly known as SLB) instance and an ApsaraDB RDS instance to the scaling group that you want to create, the scaling group, the CLB instance, and the ApsaraDB RDS instance must reside in the same region. For more information, see [Regions and zones](https://help.aliyun.com/document_detail/40654.html).
578
- * If you attach a CLB instance to the scaling group that you want to create, Auto Scaling automatically adds the ECS instances in the scaling group to the backend server groups of the CLB instance. You can specify the following types of server groups to add ECS instances:
579
- * * Default server group: ECS instances in this group process frontend requests. If no listeners are configured for vServer groups or primary/secondary server groups, the frontend requests are forwarded to the ECS instances in the default server group.
580
- * * vServer group: If you want to forward different requests to different backend servers, or you want to forward requests based on domain names or URLs, you can specify vServer groups.
581
- * > If you specify both the default server group and multiple VServer groups, the ECS instances are added to these server groups.
582
- * The default weight of each ECS instance as a backend server is 50. The CLB instance must meet the following requirements:
583
- * * The CLB instance is in the Active state. You can call the [DescribeLoadBalancers](https://help.aliyun.com/document_detail/2401696.html) operation to query the status of CLB instances.
584
- * * All listening ports configured for the CLB instance must be health check. Otherwise, the scaling group fails to be created.
585
- * If you attach Application Load Balancer (ALB), Network Load Balancer (NLB), or Gateway Load Balancer (GWLB) server groups to the scaling group that you want to create, Auto Scaling adds the ECS instances in your scaling group to the ALB or NLB server groups to process the access requests forwarded by the corresponding ALB or NLB instances. You can specify multiple ALB, NLB, or GWLB server groups, but the server groups must belong to the same VPC as the scaling group. For more information, see [AttachAlbServerGroups](https://help.aliyun.com/document_detail/266800.html) or [AttachServerGroups](https://help.aliyun.com/document_detail/600535.html).
586
- * If you associate an RDS instance with the scaling group, the scaling group will automatically add the internal IP addresses of ECS instances that join the scaling group to the access whitelist of the RDS instance. The RDS instance must meet the following requirements:
587
- * * The RDS instance must be in the Running state. You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/610396.html) operation to view the status of the specified RDS instance.
588
- * * The number of IPs in the RDS instance\\"s access whitelist cannot exceed the upper limit. For more information, see [Configure a whitelist](https://help.aliyun.com/document_detail/43185.html).
589
- * If the MultiAZPolicy for the scaling group is set to COST_OPTIMIZED, the following rules apply:
590
- * * When you specify OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, and SpotInstancePools parameters (i.e., defining the instance allocation method under the cost optimization policy), Auto Scaling will prioritize this allocation method during scaling operations.
591
- * * If you do not specify OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, or SpotInstancePools, Auto Scaling preferentially creates instances of the lowest-priced instance type based on the cost optimization policy.
592
- * If you set `Tags.Propagate` to true, the following rules will apply:
593
- * * Tags added to the scaling group will only propagate to newly created instances and will not affect instances already running within the scaling group.
594
- * * If instance tags are specified in the scaling configuration and the scaling group’s tags are propagated to the instance, all tags will coexist.
595
- * * If the tag key specified in the scaling configuration matches a tag key in the scaling group, the tag value from the scaling configuration will take precedence.
447
+ * Call the `CreateScalingGroup` API to create a scaling group. The group automatically adjusts your computing capacity (the number of instances) by scaling instances of a specified type in or out based on your business requirements and scaling policies.
448
+ *
449
+ * @remarks
450
+ * A scaling group is a collection of ECS instances for the same use case.
451
+ * The number of scaling groups that you can create in a region depends on your Auto Scaling usage. To view your quota for scaling groups, go to Quota Center.
452
+ * A scaling group is not active immediately after creation. You must call the [EnableScalingGroup](https://help.aliyun.com/document_detail/25939.html) operation to enable the group before it can trigger scaling activities or execute scaling rules.
453
+ * The scaling group, as well as its associated Classic Load Balancer (CLB) (formerly SLB) and RDS instances, must be in the same region. For more information, see [Regions and availability zones](https://help.aliyun.com/document_detail/40654.html).
454
+ * If you associate a CLB instance with a scaling group, the scaling group automatically adds new ECS instances to a backend server group of the CLB instance. You can specify which server group to use. The following types of server groups are supported:
455
+ * - Default server group: A group of ECS instances that receive requests from the front end. If no vServer group or primary/standby server group is configured for a listener, it forwards requests to the ECS instances in the default server group.
456
+ * - vServer group: Use a vServer group if you need to forward different requests to different backend servers, or forward requests based on domain names and URLs.
457
+ * > If you specify both a default server group and one or more vServer groups, the scaling group adds new ECS instances to all specified server groups.
458
+ * After an instance is added to a backend server group of a CLB instance, its default weight is 50. The CLB instance must meet the following conditions:
459
+ * - The CLB instance must be in the active state. You can call the [DescribeLoadBalancers](https://help.aliyun.com/document_detail/2401696.html) operation to check the state of a CLB instance.
460
+ * - Health checks must be enabled for all listeners configured on the CLB instance. Otherwise, the scaling group creation fails.
461
+ * If you associate a scaling group with Application Load Balancer (ALB), Network Load Balancer (NLB), or Gateway Load Balancer (GWLB) server groups, it automatically adds new ECS instances as backend servers to those groups to handle distributed requests. You can specify multiple such server groups, but they must all belong to the same VPC as the scaling group. For more information, see [AttachAlbServerGroups](https://help.aliyun.com/document_detail/266800.html) or [AttachServerGroups](https://help.aliyun.com/document_detail/600535.html).
462
+ * If you associate an RDS instance with a scaling group, the scaling group automatically adds the internal IP addresses of new ECS instances to the IP address whitelist of the RDS instance. The RDS instance must meet the following conditions:
463
+ * - The RDS instance must be in the Running state. You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/610396.html) operation to check the state of an RDS instance.
464
+ * - The number of IP addresses in the RDS instance\\"s IP address whitelist cannot exceed the limit. For more information, see the [Configure an IP address whitelist](https://help.aliyun.com/document_detail/43185.html) topic in the RDS documentation.
465
+ * If the `MultiAZPolicy` of a scaling group is set to `COST_OPTIMIZED`:
466
+ * - If you specify the `OnDemandBaseCapacity`, `OnDemandPercentageAboveBaseCapacity`, and `SpotInstancePools` parameters, you define the instance allocation strategy for the cost-optimized policy. Auto Scaling prioritizes this strategy during scaling activities.
467
+ * - If you do not specify the `OnDemandBaseCapacity`, `OnDemandPercentageAboveBaseCapacity`, or `SpotInstancePools` parameters, the cost-optimized policy creates instances by using only the lowest-cost method. In this mode, you cannot create instances by using the Elastic Guarantee service or the Capacity Reservation service.
468
+ * If you enable tag propagation for a scaling group by setting `Tags.Propagate` to `true`:
469
+ * - The scaling group propagates its tags only to new instances, not to existing instances.
470
+ * - If you specify instance tags in the scaling configuration and also choose to propagate tags from the scaling group, Auto Scaling applies both sets of tags to the new instances.
471
+ * - If a tag from the scaling configuration and a propagated tag from the scaling group have the same tag key, the tag value from the scaling configuration takes precedence.
596
472
  *
597
473
  * @param request - CreateScalingGroupRequest
598
474
  * @returns CreateScalingGroupResponse
599
475
  */
600
476
  createScalingGroup(request: $_model.CreateScalingGroupRequest): Promise<$_model.CreateScalingGroupResponse>;
601
477
  /**
602
- * Creates a scaling rule. The purpose of a scaling rule varies based on its type. You can use a scaling rule to trigger a scaling activity or adjust the boundary values for a scaling group. You can call the CreateScalingRule operation to create different types of scaling rules based on your business requirements. For example, if your business requires only automatic adjustment of the boundary values for your scaling group, you can call this operation to create a predictive scaling rule.
478
+ * The function of a scaling rule is determined by its type, which can be used to trigger a scaling activity or intelligently set the boundary values of a scaling group. Depending on your business requirements, you can invoke the CreateScalingRule API to create different types of scaling rules. For example, if your business only requires setting the boundary values of a scaling group, we recommend that you select the predictive rule type.
603
479
  *
604
480
  * @remarks
605
- * A scaling rule defines the specific scaling action. For example, you can use a scaling rule to define N instances to add or remove. If the execution of a scaling rule causes the total number of Elastic Compute Service (ECS) instances or elastic container instances in the scaling group to drop below the value of MinSize or to exceed the value of MaxSize, Auto Scaling adjusts the number of instances to add or remove, which ensures that the total number of instances stays within the valid range. Take note that Auto Scaling does not adjust the number of instances that you defined in the scaling rule. Examples:
606
- * * The maximum number of instances (MaxSize) that can be contained in a scaling group is 3 and the current number of instances (Total Capacity) in the scaling group is 2. In this example, the Add3 scaling rule is created to add three ECS instances to the scaling group. However, after you execute Add3, Auto Scaling adds only one ECS instance to the scaling group. In addition, the number of ECS instances to add in the Add3 scaling rule remains unchanged.
607
- * * The minimum number of instances (MinSize) that must be contained in a scaling group is 2 and the current number of instances (Total Capacity) is 3. In this example, the Remove5 scaling rule is created to remove five ECS instances from the scaling group. However, after you execute Remove5, Auto Scaling only removes one ECS instance from the scaling group. In addition, the number of ECS instances to remove in the Remove5 scaling rule remains unchanged.
608
- * Before you call this operation, take note of the following items:
609
- * * If you set AdjustmentType to TotalCapacity, the total number of ECS instances or elastic container instances in your scaling group will be adjusted to a specified number when the scaling rule that you create by calling this operation is executed. You must set AdjustmentValue to an integer that is greater than 0.
610
- * * If you set AdjustmentType to QuantityChangeInCapacity or PercentChangeInCapacity, a positive value of AdjustmentValue specifies that a specific number of ECS instances or elastic container instances will be added to your scaling group, and a negative value of AdjustmentValue specifies that a specific number of ECS instances or elastic container instances will be removed from the scaling group.
611
- * * If you set AdjustmentType to PercentChangeInCapacity, Auto Scaling calculates the number of ECS instances or elastic container instances to add or remove by multiplying the current capacity of the scaling group (Total Capacity) by AdjustmentValue divided by 100, rounding off the result to determine the final adjustment count.
612
- * * If you specify a cooldown period for a scaling rule, the cooldown period of the scaling rule takes effect after you execute the scaling rule. If you do not specify a cooldown period for a scaling rule, the value of DefaultCooldown of the scaling group takes effect after you execute the scaling rule.
613
- * * You can create only a limited number of scaling rules for a scaling group. For more information, see [Limits](https://help.aliyun.com/document_detail/25863.html).
614
- * * The following API operations may use the unique identifier of a scaling rule (ScalingRuleAri) that is returned after you call the CreateScalingRule operation:
615
- * * ExecuteScalingRule: You can call this operation to manually execute a scaling rule. In this operation, you can set ScalingRuleAri to the unique identifier of the scaling rule that you want to execute.
616
- * * CreateScheduledTask: You can call this operation to create a scheduled task for a scaling rule. In this operation, you can set ScalingRuleAri to the unique identifier of the scaling rule for which you want to create a scheduled task.
481
+ * A scaling rule defines specific scale-out or scale-in operations, such as adding or removing N instances. If executing a scaling rule would cause the number of ECS or ECI instances in the scaling group to fall below MinSize or exceed MaxSize, automatic scaling automatically adjusts the number of ECS or ECI instances to be added or removed so that the actual instance count reaches MinSize or MaxSize. However, the configured value of the scaling rule remains unchanged. Examples are as follows:
482
+ * - For a scaling group with MaxSize=3 and a current Total Capacity of 2, if the scaling rule specifies adding 3 ECS instances, only 1 ECS instance will actually be added during execution, but the configured value of the scaling rule remains 3.
483
+ * - For a scaling group with MinSize=2 and a current Total Capacity of 3, if the scaling rule specifies removing 5 ECS instances, only 1 ECS instance will actually be removed during execution, but the configured value of the scaling rule remains 5.
484
+ * Please note the following parameter-related descriptions:
485
+ * - When AdjustmentType is TotalCapacity, it means adjusting the current number of ECS or ECI instances in the scaling group to the specified quantity. The corresponding AdjustmentValue must be greater than or equal to 0.
486
+ * - When AdjustmentType is QuantityChangeInCapacity or PercentChangeInCapacity, a positive AdjustmentValue indicates adding instances, while a negative value indicates removing instances.
487
+ * - When AdjustmentType is PercentChangeInCapacity, the automatic scaling service calculates the number of ECS or ECI instances to add or remove by multiplying the current instance count (Total Capacity) by AdjustmentValue/100 and then applying rounding.
488
+ * - If a cooldown time (Cooldown) is specified in the scaling rule, the scaling group enters a cooldown period for the specified duration after the scaling activity triggered by this rule completes. If no cooldown time is specified in the scaling rule, the default cooldown time (DefaultCooldown) of the scaling group is used.
489
+ * - There is a limit on the number of scaling rules that can be created within a single scaling group. For details, see [Limits](https://help.aliyun.com/document_detail/25863.html).
490
+ * - The returned Unique Identifier (ScalingRuleAri) of the scaling rule can be used with the following APIs:
491
+ * - Specify it in the ScalingRuleAri parameter when invoking ExecuteScalingRule to manually execute the scaling rule.
492
+ * - Specify it in the ScheduledAction parameter when creating a scheduled task (CreateScheduledTask) to execute the scaling rule at a scheduled time.
617
493
  *
618
494
  * @param request - CreateScalingRuleRequest
619
495
  * @param runtime - runtime options for this request RuntimeOptions
@@ -621,21 +497,21 @@ export default class Client extends OpenApi {
621
497
  */
622
498
  createScalingRuleWithOptions(request: $_model.CreateScalingRuleRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateScalingRuleResponse>;
623
499
  /**
624
- * Creates a scaling rule. The purpose of a scaling rule varies based on its type. You can use a scaling rule to trigger a scaling activity or adjust the boundary values for a scaling group. You can call the CreateScalingRule operation to create different types of scaling rules based on your business requirements. For example, if your business requires only automatic adjustment of the boundary values for your scaling group, you can call this operation to create a predictive scaling rule.
500
+ * The function of a scaling rule is determined by its type, which can be used to trigger a scaling activity or intelligently set the boundary values of a scaling group. Depending on your business requirements, you can invoke the CreateScalingRule API to create different types of scaling rules. For example, if your business only requires setting the boundary values of a scaling group, we recommend that you select the predictive rule type.
625
501
  *
626
502
  * @remarks
627
- * A scaling rule defines the specific scaling action. For example, you can use a scaling rule to define N instances to add or remove. If the execution of a scaling rule causes the total number of Elastic Compute Service (ECS) instances or elastic container instances in the scaling group to drop below the value of MinSize or to exceed the value of MaxSize, Auto Scaling adjusts the number of instances to add or remove, which ensures that the total number of instances stays within the valid range. Take note that Auto Scaling does not adjust the number of instances that you defined in the scaling rule. Examples:
628
- * * The maximum number of instances (MaxSize) that can be contained in a scaling group is 3 and the current number of instances (Total Capacity) in the scaling group is 2. In this example, the Add3 scaling rule is created to add three ECS instances to the scaling group. However, after you execute Add3, Auto Scaling adds only one ECS instance to the scaling group. In addition, the number of ECS instances to add in the Add3 scaling rule remains unchanged.
629
- * * The minimum number of instances (MinSize) that must be contained in a scaling group is 2 and the current number of instances (Total Capacity) is 3. In this example, the Remove5 scaling rule is created to remove five ECS instances from the scaling group. However, after you execute Remove5, Auto Scaling only removes one ECS instance from the scaling group. In addition, the number of ECS instances to remove in the Remove5 scaling rule remains unchanged.
630
- * Before you call this operation, take note of the following items:
631
- * * If you set AdjustmentType to TotalCapacity, the total number of ECS instances or elastic container instances in your scaling group will be adjusted to a specified number when the scaling rule that you create by calling this operation is executed. You must set AdjustmentValue to an integer that is greater than 0.
632
- * * If you set AdjustmentType to QuantityChangeInCapacity or PercentChangeInCapacity, a positive value of AdjustmentValue specifies that a specific number of ECS instances or elastic container instances will be added to your scaling group, and a negative value of AdjustmentValue specifies that a specific number of ECS instances or elastic container instances will be removed from the scaling group.
633
- * * If you set AdjustmentType to PercentChangeInCapacity, Auto Scaling calculates the number of ECS instances or elastic container instances to add or remove by multiplying the current capacity of the scaling group (Total Capacity) by AdjustmentValue divided by 100, rounding off the result to determine the final adjustment count.
634
- * * If you specify a cooldown period for a scaling rule, the cooldown period of the scaling rule takes effect after you execute the scaling rule. If you do not specify a cooldown period for a scaling rule, the value of DefaultCooldown of the scaling group takes effect after you execute the scaling rule.
635
- * * You can create only a limited number of scaling rules for a scaling group. For more information, see [Limits](https://help.aliyun.com/document_detail/25863.html).
636
- * * The following API operations may use the unique identifier of a scaling rule (ScalingRuleAri) that is returned after you call the CreateScalingRule operation:
637
- * * ExecuteScalingRule: You can call this operation to manually execute a scaling rule. In this operation, you can set ScalingRuleAri to the unique identifier of the scaling rule that you want to execute.
638
- * * CreateScheduledTask: You can call this operation to create a scheduled task for a scaling rule. In this operation, you can set ScalingRuleAri to the unique identifier of the scaling rule for which you want to create a scheduled task.
503
+ * A scaling rule defines specific scale-out or scale-in operations, such as adding or removing N instances. If executing a scaling rule would cause the number of ECS or ECI instances in the scaling group to fall below MinSize or exceed MaxSize, automatic scaling automatically adjusts the number of ECS or ECI instances to be added or removed so that the actual instance count reaches MinSize or MaxSize. However, the configured value of the scaling rule remains unchanged. Examples are as follows:
504
+ * - For a scaling group with MaxSize=3 and a current Total Capacity of 2, if the scaling rule specifies adding 3 ECS instances, only 1 ECS instance will actually be added during execution, but the configured value of the scaling rule remains 3.
505
+ * - For a scaling group with MinSize=2 and a current Total Capacity of 3, if the scaling rule specifies removing 5 ECS instances, only 1 ECS instance will actually be removed during execution, but the configured value of the scaling rule remains 5.
506
+ * Please note the following parameter-related descriptions:
507
+ * - When AdjustmentType is TotalCapacity, it means adjusting the current number of ECS or ECI instances in the scaling group to the specified quantity. The corresponding AdjustmentValue must be greater than or equal to 0.
508
+ * - When AdjustmentType is QuantityChangeInCapacity or PercentChangeInCapacity, a positive AdjustmentValue indicates adding instances, while a negative value indicates removing instances.
509
+ * - When AdjustmentType is PercentChangeInCapacity, the automatic scaling service calculates the number of ECS or ECI instances to add or remove by multiplying the current instance count (Total Capacity) by AdjustmentValue/100 and then applying rounding.
510
+ * - If a cooldown time (Cooldown) is specified in the scaling rule, the scaling group enters a cooldown period for the specified duration after the scaling activity triggered by this rule completes. If no cooldown time is specified in the scaling rule, the default cooldown time (DefaultCooldown) of the scaling group is used.
511
+ * - There is a limit on the number of scaling rules that can be created within a single scaling group. For details, see [Limits](https://help.aliyun.com/document_detail/25863.html).
512
+ * - The returned Unique Identifier (ScalingRuleAri) of the scaling rule can be used with the following APIs:
513
+ * - Specify it in the ScalingRuleAri parameter when invoking ExecuteScalingRule to manually execute the scaling rule.
514
+ * - Specify it in the ScheduledAction parameter when creating a scheduled task (CreateScheduledTask) to execute the scaling rule at a scheduled time.
639
515
  *
640
516
  * @param request - CreateScalingRuleRequest
641
517
  * @returns CreateScalingRuleResponse
@@ -644,17 +520,6 @@ export default class Client extends OpenApi {
644
520
  /**
645
521
  * Creates a scheduled task. A scheduled task is a type of scaling task that enables automatic execution of a specific scaling rule at a specified point in time. You can call the CreateScheduledTask operation to create a scheduled task to implement automatic scaling of computing resources. This ensures your business continuity and minimizes resource costs.
646
522
  *
647
- * @remarks
648
- * If the scaling rule of a scheduled task fails to be executed due to an ongoing scaling activity in the scaling group or because the scaling group is disabled, the scheduled task is automatically retried during the time window specified by `LaunchExpirationTime`. If the scheduled task still fails after the specified time window ends, the task is automatically skipped.
649
- * * If several scheduled tasks concurrently attempt to execute the same scaling rule within a scaling group, the following rules apply:
650
- * * Scaling groups with **Expected Number of Instances** configured: The scaling activities incurred by the scheduled tasks are parallel scaling activities. In a proximate time window, Auto Scaling can trigger several scheduled tasks and then execute multiple parallel scaling activities at the same time.
651
- * * Scaling groups with **Expected Number of Instances** not configured: The scaling activity incurred by the earliest scheduled task is executed. Considering that a scaling group allows for no more than one ongoing scaling activity simultaneously, other scheduled tasks will spontaneously invoke retries within the time window specified by `LaunchExpirationTime`. Upon completion of the first scheduled task, any retries invoked by other tasks within the time window specified by `LaunchExpirationTime` lead to continuous enforcement of the scaling rule, with each iteration generating a distinct scaling activity.
652
- * * You can use one of the following methods to specify the scaling mode:
653
- * * ScheduledAction: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
654
- * * ScalingGroupId: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you create the scheduled task.
655
- * **
656
- * **Note** You cannot specify ScheduledAction and ScalingGroupId at the same time.
657
- *
658
523
  * @param request - CreateScheduledTaskRequest
659
524
  * @param runtime - runtime options for this request RuntimeOptions
660
525
  * @returns CreateScheduledTaskResponse
@@ -663,26 +528,12 @@ export default class Client extends OpenApi {
663
528
  /**
664
529
  * Creates a scheduled task. A scheduled task is a type of scaling task that enables automatic execution of a specific scaling rule at a specified point in time. You can call the CreateScheduledTask operation to create a scheduled task to implement automatic scaling of computing resources. This ensures your business continuity and minimizes resource costs.
665
530
  *
666
- * @remarks
667
- * If the scaling rule of a scheduled task fails to be executed due to an ongoing scaling activity in the scaling group or because the scaling group is disabled, the scheduled task is automatically retried during the time window specified by `LaunchExpirationTime`. If the scheduled task still fails after the specified time window ends, the task is automatically skipped.
668
- * * If several scheduled tasks concurrently attempt to execute the same scaling rule within a scaling group, the following rules apply:
669
- * * Scaling groups with **Expected Number of Instances** configured: The scaling activities incurred by the scheduled tasks are parallel scaling activities. In a proximate time window, Auto Scaling can trigger several scheduled tasks and then execute multiple parallel scaling activities at the same time.
670
- * * Scaling groups with **Expected Number of Instances** not configured: The scaling activity incurred by the earliest scheduled task is executed. Considering that a scaling group allows for no more than one ongoing scaling activity simultaneously, other scheduled tasks will spontaneously invoke retries within the time window specified by `LaunchExpirationTime`. Upon completion of the first scheduled task, any retries invoked by other tasks within the time window specified by `LaunchExpirationTime` lead to continuous enforcement of the scaling rule, with each iteration generating a distinct scaling activity.
671
- * * You can use one of the following methods to specify the scaling mode:
672
- * * ScheduledAction: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
673
- * * ScalingGroupId: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you create the scheduled task.
674
- * **
675
- * **Note** You cannot specify ScheduledAction and ScalingGroupId at the same time.
676
- *
677
531
  * @param request - CreateScheduledTaskRequest
678
532
  * @returns CreateScheduledTaskResponse
679
533
  */
680
534
  createScheduledTask(request: $_model.CreateScheduledTaskRequest): Promise<$_model.CreateScheduledTaskResponse>;
681
535
  /**
682
- * Deactivates a scaling configuration.
683
- *
684
- * @remarks
685
- * You can call this operation to deactivate a scaling configuration only in a disabled scaling group.
536
+ * 使指定伸缩配置进入失效状态
686
537
  *
687
538
  * @param request - DeactivateScalingConfigurationRequest
688
539
  * @param runtime - runtime options for this request RuntimeOptions
@@ -690,10 +541,7 @@ export default class Client extends OpenApi {
690
541
  */
691
542
  deactivateScalingConfigurationWithOptions(request: $_model.DeactivateScalingConfigurationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeactivateScalingConfigurationResponse>;
692
543
  /**
693
- * Deactivates a scaling configuration.
694
- *
695
- * @remarks
696
- * You can call this operation to deactivate a scaling configuration only in a disabled scaling group.
544
+ * 使指定伸缩配置进入失效状态
697
545
  *
698
546
  * @param request - DeactivateScalingConfigurationRequest
699
547
  * @returns DeactivateScalingConfigurationResponse
@@ -732,11 +580,6 @@ export default class Client extends OpenApi {
732
580
  /**
733
581
  * Deletes a scaling configuration of the Elastic Container Instance type. If the scaling configuration of a scaling group is in the Inactive state and the scaling group contains no elastic container instances created from the scaling configuration, you can call the DeleteEciScalingConfiguration operation to delete the scaling configuration to free up the scaling configuration quota.
734
582
  *
735
- * @remarks
736
- * You cannot call this operation to delete a scaling configuration in the following scenarios:
737
- * * The scaling configuration is in the Active state.
738
- * * The scaling group contains elastic container instances created from the scaling configuration.
739
- *
740
583
  * @param request - DeleteEciScalingConfigurationRequest
741
584
  * @param runtime - runtime options for this request RuntimeOptions
742
585
  * @returns DeleteEciScalingConfigurationResponse
@@ -745,11 +588,6 @@ export default class Client extends OpenApi {
745
588
  /**
746
589
  * Deletes a scaling configuration of the Elastic Container Instance type. If the scaling configuration of a scaling group is in the Inactive state and the scaling group contains no elastic container instances created from the scaling configuration, you can call the DeleteEciScalingConfiguration operation to delete the scaling configuration to free up the scaling configuration quota.
747
590
  *
748
- * @remarks
749
- * You cannot call this operation to delete a scaling configuration in the following scenarios:
750
- * * The scaling configuration is in the Active state.
751
- * * The scaling group contains elastic container instances created from the scaling configuration.
752
- *
753
591
  * @param request - DeleteEciScalingConfigurationRequest
754
592
  * @returns DeleteEciScalingConfigurationResponse
755
593
  */
@@ -757,11 +595,6 @@ export default class Client extends OpenApi {
757
595
  /**
758
596
  * Deletes a lifecycle hook. If you no longer require a lifecycle hook, you can call the DeleteLifecycleHook operation to delete it, which frees up the lifecycle hook quota.
759
597
  *
760
- * @remarks
761
- * If you delete an effective lifecycle hook before its timeout period ends, the instances on which the lifecycle hook takes effect exits the Pending state ahead of schedule. You can use the following methods to delete a lifecycle hook:
762
- * * Include `LifecycleHookId` within your request to specify the lifecycle hook that you want to delete. In this case, `ScalingGroupId` and `LifecycleHookName` are ignored.
763
- * * Include `ScalingGroupId` and `LifecycleHookName` within your request to specify the lifecycle hook that you want to delete.
764
- *
765
598
  * @param request - DeleteLifecycleHookRequest
766
599
  * @param runtime - runtime options for this request RuntimeOptions
767
600
  * @returns DeleteLifecycleHookResponse
@@ -770,11 +603,6 @@ export default class Client extends OpenApi {
770
603
  /**
771
604
  * Deletes a lifecycle hook. If you no longer require a lifecycle hook, you can call the DeleteLifecycleHook operation to delete it, which frees up the lifecycle hook quota.
772
605
  *
773
- * @remarks
774
- * If you delete an effective lifecycle hook before its timeout period ends, the instances on which the lifecycle hook takes effect exits the Pending state ahead of schedule. You can use the following methods to delete a lifecycle hook:
775
- * * Include `LifecycleHookId` within your request to specify the lifecycle hook that you want to delete. In this case, `ScalingGroupId` and `LifecycleHookName` are ignored.
776
- * * Include `ScalingGroupId` and `LifecycleHookName` within your request to specify the lifecycle hook that you want to delete.
777
- *
778
606
  * @param request - DeleteLifecycleHookRequest
779
607
  * @returns DeleteLifecycleHookResponse
780
608
  */
@@ -797,11 +625,6 @@ export default class Client extends OpenApi {
797
625
  /**
798
626
  * Deletes a scaling configuration that is used to create Elastic Compute Service (ECS) instances.
799
627
  *
800
- * @remarks
801
- * You cannot delete a scaling configuration in one of the following scenarios:
802
- * * The scaling configuration in your scaling group is in the Active state.
803
- * * The scaling group contains ECS instances that were created based on the scaling configuration.
804
- *
805
628
  * @param request - DeleteScalingConfigurationRequest
806
629
  * @param runtime - runtime options for this request RuntimeOptions
807
630
  * @returns DeleteScalingConfigurationResponse
@@ -810,11 +633,6 @@ export default class Client extends OpenApi {
810
633
  /**
811
634
  * Deletes a scaling configuration that is used to create Elastic Compute Service (ECS) instances.
812
635
  *
813
- * @remarks
814
- * You cannot delete a scaling configuration in one of the following scenarios:
815
- * * The scaling configuration in your scaling group is in the Active state.
816
- * * The scaling group contains ECS instances that were created based on the scaling configuration.
817
- *
818
636
  * @param request - DeleteScalingConfigurationRequest
819
637
  * @returns DeleteScalingConfigurationResponse
820
638
  */
@@ -822,18 +640,6 @@ export default class Client extends OpenApi {
822
640
  /**
823
641
  * Deletes a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can create scaling groups to manage your computing power with ease. The computing power refers to the instances that provide the computing capability. If you no longer require a scaling group, you can call the DeleteScalingGroup operation to delete it to free up the scaling group quota.
824
642
  *
825
- * @remarks
826
- * Before you call the DeleteScalingGroup operation, take note of the following items:
827
- * * If you delete a scaling group, the scaling configurations, scaling rules, scaling activities, and scaling requests related to the scaling group are also deleted.
828
- * * If you delete a scaling group, the scheduled tasks and event-triggered tasks of the scaling group are not deleted. The Server Load Balancer (SLB) instances and ApsaraDB RDS instances that are attached to the scaling group are also not deleted.
829
- * * If the scaling group that you want to delete contains ECS instances or elastic container instances that are in the In Service state, Auto Scaling stops the instances and then removes all manually added instances from the scaling group or releases all automatically created instances in the scaling group before the scaling group is deleted.
830
- * **
831
- * **Note** Before you delete a scaling group, make sure that the Deletion Protection feature is disabled. If you have enabled the Deletion Protection feature for a scaling group, disable the feature on the Modify Scaling Group page before you delete the scaling group.
832
- * * If you do not disable the Deletion Protection feature for a scaling group, you cannot delete the scaling group by using the Auto Scaling console or calling this operation. The Deletion Protection feature is an effective measure to safeguard scaling groups against unintended deletion.
833
- * * Prior to deleting a scaling group, make sure that your ECS instances within the scaling group are safeguarded against unintended release. Even if you have already enabled the Release Protection feature for the ECS instances, you must manually put these ECS instances into the Protected state. Doing so guarantees that the ECS instances will not be forcibly released during the deletion process of the scaling group, providing an extra layer of security.
834
- * **
835
- * **Note** Before you delete a scaling group, we recommend that you enable the Deletion Protection feature for ECS instances that you want to retain. This action guarantees that the ECS instances are not forcibly released after you delete the scaling group. For more information, see [SetInstancesProtection](https://help.aliyun.com/document_detail/459342.html).
836
- *
837
643
  * @param request - DeleteScalingGroupRequest
838
644
  * @param runtime - runtime options for this request RuntimeOptions
839
645
  * @returns DeleteScalingGroupResponse
@@ -842,18 +648,6 @@ export default class Client extends OpenApi {
842
648
  /**
843
649
  * Deletes a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can create scaling groups to manage your computing power with ease. The computing power refers to the instances that provide the computing capability. If you no longer require a scaling group, you can call the DeleteScalingGroup operation to delete it to free up the scaling group quota.
844
650
  *
845
- * @remarks
846
- * Before you call the DeleteScalingGroup operation, take note of the following items:
847
- * * If you delete a scaling group, the scaling configurations, scaling rules, scaling activities, and scaling requests related to the scaling group are also deleted.
848
- * * If you delete a scaling group, the scheduled tasks and event-triggered tasks of the scaling group are not deleted. The Server Load Balancer (SLB) instances and ApsaraDB RDS instances that are attached to the scaling group are also not deleted.
849
- * * If the scaling group that you want to delete contains ECS instances or elastic container instances that are in the In Service state, Auto Scaling stops the instances and then removes all manually added instances from the scaling group or releases all automatically created instances in the scaling group before the scaling group is deleted.
850
- * **
851
- * **Note** Before you delete a scaling group, make sure that the Deletion Protection feature is disabled. If you have enabled the Deletion Protection feature for a scaling group, disable the feature on the Modify Scaling Group page before you delete the scaling group.
852
- * * If you do not disable the Deletion Protection feature for a scaling group, you cannot delete the scaling group by using the Auto Scaling console or calling this operation. The Deletion Protection feature is an effective measure to safeguard scaling groups against unintended deletion.
853
- * * Prior to deleting a scaling group, make sure that your ECS instances within the scaling group are safeguarded against unintended release. Even if you have already enabled the Release Protection feature for the ECS instances, you must manually put these ECS instances into the Protected state. Doing so guarantees that the ECS instances will not be forcibly released during the deletion process of the scaling group, providing an extra layer of security.
854
- * **
855
- * **Note** Before you delete a scaling group, we recommend that you enable the Deletion Protection feature for ECS instances that you want to retain. This action guarantees that the ECS instances are not forcibly released after you delete the scaling group. For more information, see [SetInstancesProtection](https://help.aliyun.com/document_detail/459342.html).
856
- *
857
651
  * @param request - DeleteScalingGroupRequest
858
652
  * @returns DeleteScalingGroupResponse
859
653
  */
@@ -919,7 +713,7 @@ export default class Client extends OpenApi {
919
713
  */
920
714
  describeAlertConfiguration(request: $_model.DescribeAlertConfigurationRequest): Promise<$_model.DescribeAlertConfigurationResponse>;
921
715
  /**
922
- * 查询备选规格
716
+ * Lists candidate instance types.
923
717
  *
924
718
  * @param request - DescribeCandidateInstanceTypeRequest
925
719
  * @param runtime - runtime options for this request RuntimeOptions
@@ -927,14 +721,14 @@ export default class Client extends OpenApi {
927
721
  */
928
722
  describeCandidateInstanceTypeWithOptions(request: $_model.DescribeCandidateInstanceTypeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeCandidateInstanceTypeResponse>;
929
723
  /**
930
- * 查询备选规格
724
+ * Lists candidate instance types.
931
725
  *
932
726
  * @param request - DescribeCandidateInstanceTypeRequest
933
727
  * @returns DescribeCandidateInstanceTypeResponse
934
728
  */
935
729
  describeCandidateInstanceType(request: $_model.DescribeCandidateInstanceTypeRequest): Promise<$_model.DescribeCandidateInstanceTypeResponse>;
936
730
  /**
937
- * Queries the diagnostic reports.
731
+ * DescribeDiagnoseReports
938
732
  *
939
733
  * @param request - DescribeDiagnoseReportsRequest
940
734
  * @param runtime - runtime options for this request RuntimeOptions
@@ -942,7 +736,7 @@ export default class Client extends OpenApi {
942
736
  */
943
737
  describeDiagnoseReportsWithOptions(request: $_model.DescribeDiagnoseReportsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDiagnoseReportsResponse>;
944
738
  /**
945
- * Queries the diagnostic reports.
739
+ * DescribeDiagnoseReports
946
740
  *
947
741
  * @param request - DescribeDiagnoseReportsRequest
948
742
  * @returns DescribeDiagnoseReportsResponse
@@ -979,7 +773,7 @@ export default class Client extends OpenApi {
979
773
  */
980
774
  describeEciScalingConfigurations(request: $_model.DescribeEciScalingConfigurationsRequest): Promise<$_model.DescribeEciScalingConfigurationsResponse>;
981
775
  /**
982
- * Queries the scaling strength of a scaling configuration. The success rate of scale-out events depends on the scaling strength of the scaling configuration that you want to use. By checking the scaling strength of a scaling configuration, you can enable Auto Scaling to measure its performance and improve specific configurations.
776
+ * A scaling group\\"s configuration is key to successful scale-outs. Auto Scaling uses elasticity strength to quantify the effectiveness of a Scaling Configuration, helping you make targeted optimizations.
983
777
  *
984
778
  * @param request - DescribeElasticStrengthRequest
985
779
  * @param runtime - runtime options for this request RuntimeOptions
@@ -987,7 +781,7 @@ export default class Client extends OpenApi {
987
781
  */
988
782
  describeElasticStrengthWithOptions(request: $_model.DescribeElasticStrengthRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeElasticStrengthResponse>;
989
783
  /**
990
- * Queries the scaling strength of a scaling configuration. The success rate of scale-out events depends on the scaling strength of the scaling configuration that you want to use. By checking the scaling strength of a scaling configuration, you can enable Auto Scaling to measure its performance and improve specific configurations.
784
+ * A scaling group\\"s configuration is key to successful scale-outs. Auto Scaling uses elasticity strength to quantify the effectiveness of a Scaling Configuration, helping you make targeted optimizations.
991
785
  *
992
786
  * @param request - DescribeElasticStrengthRequest
993
787
  * @returns DescribeElasticStrengthResponse
@@ -1009,7 +803,7 @@ export default class Client extends OpenApi {
1009
803
  */
1010
804
  describeInstanceCreateAndDeleteStatistics(request: $_model.DescribeInstanceCreateAndDeleteStatisticsRequest): Promise<$_model.DescribeInstanceCreateAndDeleteStatisticsResponse>;
1011
805
  /**
1012
- * Queries instance refresh tasks. If you want to view the basic information and execution progress of an instance refresh task, you can call the DescribeInstanceRefreshes operation.
806
+ * Queries instance refresh tasks for a scaling group. You can call this operation to view basic information and progress of instance refresh tasks.
1013
807
  *
1014
808
  * @param request - DescribeInstanceRefreshesRequest
1015
809
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1017,7 +811,7 @@ export default class Client extends OpenApi {
1017
811
  */
1018
812
  describeInstanceRefreshesWithOptions(request: $_model.DescribeInstanceRefreshesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeInstanceRefreshesResponse>;
1019
813
  /**
1020
- * Queries instance refresh tasks. If you want to view the basic information and execution progress of an instance refresh task, you can call the DescribeInstanceRefreshes operation.
814
+ * Queries instance refresh tasks for a scaling group. You can call this operation to view basic information and progress of instance refresh tasks.
1021
815
  *
1022
816
  * @param request - DescribeInstanceRefreshesRequest
1023
817
  * @returns DescribeInstanceRefreshesResponse
@@ -1026,13 +820,6 @@ export default class Client extends OpenApi {
1026
820
  /**
1027
821
  * Queries lifecycle hook actions. When you call the DescribeLifecycleActions operation, you can specify parameters such as ScalingActivityId, NextToken, and MaxResults to query the details such as the action status and ID of a lifecycle hook. You can also call this operation to query the IDs of Elastic Compute Service (ECS) instances on which the lifecycle hook takes effect.
1028
822
  *
1029
- * @remarks
1030
- * If a scaling activity is executed and a lifecycle hook is created for the scaling activity, the lifecycle hook triggers a lifecycle action. A lifecycle action can be in one of the following states:
1031
- * * If a lifecycle action is in the Pending state, Elastic Compute Service (ECS) instances are waiting to be added to a scaling group or waiting to be removed from a scaling group.
1032
- * * If a lifecycle action is in the Timeout state, the lifecycle hook that triggers the lifecycle action expires and ECS instances are added to or removed from a scaling group.
1033
- * * If a lifecycle action is in the Completed state, you manually end the lifecycle hook that triggers the lifecycle action ahead of schedule.
1034
- * If you do not specify the action to perform, such as execute a specific OOS template, after a lifecycle hook ends, you can call this operation to obtain the token of the lifecycle action that corresponds to the lifecycle hook. Then, you can specify a custom action to perform after the lifecycle hook ends.
1035
- *
1036
823
  * @param request - DescribeLifecycleActionsRequest
1037
824
  * @param runtime - runtime options for this request RuntimeOptions
1038
825
  * @returns DescribeLifecycleActionsResponse
@@ -1041,13 +828,6 @@ export default class Client extends OpenApi {
1041
828
  /**
1042
829
  * Queries lifecycle hook actions. When you call the DescribeLifecycleActions operation, you can specify parameters such as ScalingActivityId, NextToken, and MaxResults to query the details such as the action status and ID of a lifecycle hook. You can also call this operation to query the IDs of Elastic Compute Service (ECS) instances on which the lifecycle hook takes effect.
1043
830
  *
1044
- * @remarks
1045
- * If a scaling activity is executed and a lifecycle hook is created for the scaling activity, the lifecycle hook triggers a lifecycle action. A lifecycle action can be in one of the following states:
1046
- * * If a lifecycle action is in the Pending state, Elastic Compute Service (ECS) instances are waiting to be added to a scaling group or waiting to be removed from a scaling group.
1047
- * * If a lifecycle action is in the Timeout state, the lifecycle hook that triggers the lifecycle action expires and ECS instances are added to or removed from a scaling group.
1048
- * * If a lifecycle action is in the Completed state, you manually end the lifecycle hook that triggers the lifecycle action ahead of schedule.
1049
- * If you do not specify the action to perform, such as execute a specific OOS template, after a lifecycle hook ends, you can call this operation to obtain the token of the lifecycle action that corresponds to the lifecycle hook. Then, you can specify a custom action to perform after the lifecycle hook ends.
1050
- *
1051
831
  * @param request - DescribeLifecycleActionsRequest
1052
832
  * @returns DescribeLifecycleActionsResponse
1053
833
  */
@@ -1055,12 +835,6 @@ export default class Client extends OpenApi {
1055
835
  /**
1056
836
  * Queries lifecycle hooks. When you call this operation, you can specify the lifecycle hook ID or scaling group ID to query the details of the desired lifecycle hook, such as the default action after the lifecycle hook times out, scaling activity that corresponds to the lifecycle hook, Alibaba Cloud Resource Name (ARN) of the notification recipient, and effective period of the lifecycle hook.
1057
837
  *
1058
- * @remarks
1059
- * You can use one of the following methods to query lifecycle hooks:
1060
- * * Specify a list of lifecycle hook IDs by using the LifecycleHookIds parameter. In this case, you do not need to specify the ScalingGroupId and LifecycleHookName parameters.
1061
- * * Specify the scaling group ID by using the ScalingGroupId parameter.
1062
- * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter at the same time.
1063
- *
1064
838
  * @param request - DescribeLifecycleHooksRequest
1065
839
  * @param runtime - runtime options for this request RuntimeOptions
1066
840
  * @returns DescribeLifecycleHooksResponse
@@ -1069,12 +843,6 @@ export default class Client extends OpenApi {
1069
843
  /**
1070
844
  * Queries lifecycle hooks. When you call this operation, you can specify the lifecycle hook ID or scaling group ID to query the details of the desired lifecycle hook, such as the default action after the lifecycle hook times out, scaling activity that corresponds to the lifecycle hook, Alibaba Cloud Resource Name (ARN) of the notification recipient, and effective period of the lifecycle hook.
1071
845
  *
1072
- * @remarks
1073
- * You can use one of the following methods to query lifecycle hooks:
1074
- * * Specify a list of lifecycle hook IDs by using the LifecycleHookIds parameter. In this case, you do not need to specify the ScalingGroupId and LifecycleHookName parameters.
1075
- * * Specify the scaling group ID by using the ScalingGroupId parameter.
1076
- * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter at the same time.
1077
- *
1078
846
  * @param request - DescribeLifecycleHooksRequest
1079
847
  * @returns DescribeLifecycleHooksResponse
1080
848
  */
@@ -1157,11 +925,6 @@ export default class Client extends OpenApi {
1157
925
  /**
1158
926
  * Queries scaling activities. You can call the DescribeScalingActivities operation to query the results of scaling activities triggered by scheduled tasks, event-triggered tasks, or manual execution of scaling rules. For example, you can query the status and cause of a scaling activity. You can also query the total number of instances after a scaling activity is complete.
1159
927
  *
1160
- * @remarks
1161
- * You can query all scaling activities in a scaling group by specifying ScalingGroupId.
1162
- * * You can filter query results based on the status of scaling activities.
1163
- * * You can query scaling activities within the last 30 days.
1164
- *
1165
928
  * @param request - DescribeScalingActivitiesRequest
1166
929
  * @param runtime - runtime options for this request RuntimeOptions
1167
930
  * @returns DescribeScalingActivitiesResponse
@@ -1170,11 +933,6 @@ export default class Client extends OpenApi {
1170
933
  /**
1171
934
  * Queries scaling activities. You can call the DescribeScalingActivities operation to query the results of scaling activities triggered by scheduled tasks, event-triggered tasks, or manual execution of scaling rules. For example, you can query the status and cause of a scaling activity. You can also query the total number of instances after a scaling activity is complete.
1172
935
  *
1173
- * @remarks
1174
- * You can query all scaling activities in a scaling group by specifying ScalingGroupId.
1175
- * * You can filter query results based on the status of scaling activities.
1176
- * * You can query scaling activities within the last 30 days.
1177
- *
1178
936
  * @param request - DescribeScalingActivitiesRequest
1179
937
  * @returns DescribeScalingActivitiesResponse
1180
938
  */
@@ -1210,7 +968,7 @@ export default class Client extends OpenApi {
1210
968
  */
1211
969
  describeScalingActivityStatistics(request: $_model.DescribeScalingActivityStatisticsRequest): Promise<$_model.DescribeScalingActivityStatisticsResponse>;
1212
970
  /**
1213
- * Queries scaling configurations.
971
+ * You can call the DescribeScalingConfigurations API to query information about ECS-type scaling configurations, including instance type and image details. This helps you understand the ECS instance template used during scale-out operations.
1214
972
  *
1215
973
  * @param request - DescribeScalingConfigurationsRequest
1216
974
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1218,7 +976,7 @@ export default class Client extends OpenApi {
1218
976
  */
1219
977
  describeScalingConfigurationsWithOptions(request: $_model.DescribeScalingConfigurationsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeScalingConfigurationsResponse>;
1220
978
  /**
1221
- * Queries scaling configurations.
979
+ * You can call the DescribeScalingConfigurations API to query information about ECS-type scaling configurations, including instance type and image details. This helps you understand the ECS instance template used during scale-out operations.
1222
980
  *
1223
981
  * @param request - DescribeScalingConfigurationsRequest
1224
982
  * @returns DescribeScalingConfigurationsResponse
@@ -1270,7 +1028,7 @@ export default class Client extends OpenApi {
1270
1028
  */
1271
1029
  describeScalingGroups(request: $_model.DescribeScalingGroupsRequest): Promise<$_model.DescribeScalingGroupsResponse>;
1272
1030
  /**
1273
- * Queries instances in a scaling group. You can call the DescribeScalingInstances operation to query instance details, such as the number of preemptible instances in the Running state, the number of Elastic Compute Service (ECS) instances, the warm-up status of ECS instances, and the lifecycle status of ECS instances in a scaling group. You can specify the scaling group whose instances you want to query by scaling group ID. If you want to filter instances based on conditions, such as the instance health status, lifecycle status, or creation method, you can also call this operation.
1031
+ * Calls DescribeScalingInstances to query the list and information of ECS instances in a scaling group by scaling group ID, including the total number of running spot instances, the total number of ECS instances, the warmup state of ECS instances, and the lifecycle state in the current scaling group. You can also filter ECS instances by health check status, lifecycle state, or creation type.
1274
1032
  *
1275
1033
  * @param request - DescribeScalingInstancesRequest
1276
1034
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1278,7 +1036,7 @@ export default class Client extends OpenApi {
1278
1036
  */
1279
1037
  describeScalingInstancesWithOptions(request: $_model.DescribeScalingInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeScalingInstancesResponse>;
1280
1038
  /**
1281
- * Queries instances in a scaling group. You can call the DescribeScalingInstances operation to query instance details, such as the number of preemptible instances in the Running state, the number of Elastic Compute Service (ECS) instances, the warm-up status of ECS instances, and the lifecycle status of ECS instances in a scaling group. You can specify the scaling group whose instances you want to query by scaling group ID. If you want to filter instances based on conditions, such as the instance health status, lifecycle status, or creation method, you can also call this operation.
1039
+ * Calls DescribeScalingInstances to query the list and information of ECS instances in a scaling group by scaling group ID, including the total number of running spot instances, the total number of ECS instances, the warmup state of ECS instances, and the lifecycle state in the current scaling group. You can also filter ECS instances by health check status, lifecycle state, or creation type.
1282
1040
  *
1283
1041
  * @param request - DescribeScalingInstancesRequest
1284
1042
  * @returns DescribeScalingInstancesResponse
@@ -1287,9 +1045,6 @@ export default class Client extends OpenApi {
1287
1045
  /**
1288
1046
  * Queries scaling rules. When you call this operation, you can specify the ID, name, or Alibaba Cloud Resource Name (ARN) of a scaling rule to query the details of the scaling rule. For example, you can query the adjustment method, instance warm-up period, and associated event-triggered tasks of the desired scaling rule.
1289
1047
  *
1290
- * @remarks
1291
- * You can specify a scaling group ID to query all scaling rules in the scaling group. You can also specify the scaling rule ID, name, unique identifier, and type in the request parameters as filter conditions.
1292
- *
1293
1048
  * @param request - DescribeScalingRulesRequest
1294
1049
  * @param runtime - runtime options for this request RuntimeOptions
1295
1050
  * @returns DescribeScalingRulesResponse
@@ -1298,9 +1053,6 @@ export default class Client extends OpenApi {
1298
1053
  /**
1299
1054
  * Queries scaling rules. When you call this operation, you can specify the ID, name, or Alibaba Cloud Resource Name (ARN) of a scaling rule to query the details of the scaling rule. For example, you can query the adjustment method, instance warm-up period, and associated event-triggered tasks of the desired scaling rule.
1300
1055
  *
1301
- * @remarks
1302
- * You can specify a scaling group ID to query all scaling rules in the scaling group. You can also specify the scaling rule ID, name, unique identifier, and type in the request parameters as filter conditions.
1303
- *
1304
1056
  * @param request - DescribeScalingRulesRequest
1305
1057
  * @returns DescribeScalingRulesResponse
1306
1058
  */
@@ -1308,9 +1060,6 @@ export default class Client extends OpenApi {
1308
1060
  /**
1309
1061
  * Queries scheduled tasks. A scheduled task is a predefined task that triggers the automatic execution of a scaling rule at the specified point in time. It ensures an automatic scaling of computing resources to fulfill your business demands at a minimum cost. After you create a scheduled task, you can call the DescribeScheduledTasks operation to query the details of the task, such as the execution time point and the scaling group ID. You can also call this operation to query the total number of existing scheduled tasks.
1310
1062
  *
1311
- * @remarks
1312
- * You can query scheduled tasks by scaling rule, task ID, or task name.
1313
- *
1314
1063
  * @param request - DescribeScheduledTasksRequest
1315
1064
  * @param runtime - runtime options for this request RuntimeOptions
1316
1065
  * @returns DescribeScheduledTasksResponse
@@ -1319,9 +1068,6 @@ export default class Client extends OpenApi {
1319
1068
  /**
1320
1069
  * Queries scheduled tasks. A scheduled task is a predefined task that triggers the automatic execution of a scaling rule at the specified point in time. It ensures an automatic scaling of computing resources to fulfill your business demands at a minimum cost. After you create a scheduled task, you can call the DescribeScheduledTasks operation to query the details of the task, such as the execution time point and the scaling group ID. You can also call this operation to query the total number of existing scheduled tasks.
1321
1070
  *
1322
- * @remarks
1323
- * You can query scheduled tasks by scaling rule, task ID, or task name.
1324
- *
1325
1071
  * @param request - DescribeScheduledTasksRequest
1326
1072
  * @returns DescribeScheduledTasksResponse
1327
1073
  */
@@ -1359,18 +1105,6 @@ export default class Client extends OpenApi {
1359
1105
  /**
1360
1106
  * Removes instances from a scaling group. If an enabled scaling group has no ongoing scaling activities, you can call the DetachInstances operation to remove one or more Elastic Compute Service (ECS) instances, elastic container instances, or Alibaba Cloud-hosted third-party instances from the scaling group.
1361
1107
  *
1362
- * @remarks
1363
- * Before you call the DetachInstances operation, make sure that the following conditions are met:
1364
- * * The specified scaling group is enabled.
1365
- * * The specified scaling group does not have any ongoing scaling activities.
1366
- * **
1367
- * **Note** If the specified scaling group does not have any ongoing scaling activities, the operation can bypass the cooldown period of the scaling group and immediately trigger scaling activities.
1368
- * * Before you call this operation, take note of the following items:
1369
- * * The ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances that are removed from a scaling group by using this operation can run independently. If needed, you can call the [AttachInstances](https://help.aliyun.com/document_detail/25954.html) operation to re-add these instances to a scaling group.
1370
- * * The ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances that are removed from a scaling group by using this operation are not stopped or released.
1371
- * * A successful call only means that Auto Scaling accepts your request. Scaling activities can be triggered as expected, but their successful execution is not guaranteed. You can query the status of a scaling activity based on the ScalingActivityId response parameter.
1372
- * * The removal of ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances must not result in the overall number of instances within the specified scaling group falling below the minimum capacity threshold (MinSize); otherwise, an error will be reported.
1373
- *
1374
1108
  * @param request - DetachInstancesRequest
1375
1109
  * @param runtime - runtime options for this request RuntimeOptions
1376
1110
  * @returns DetachInstancesResponse
@@ -1379,18 +1113,6 @@ export default class Client extends OpenApi {
1379
1113
  /**
1380
1114
  * Removes instances from a scaling group. If an enabled scaling group has no ongoing scaling activities, you can call the DetachInstances operation to remove one or more Elastic Compute Service (ECS) instances, elastic container instances, or Alibaba Cloud-hosted third-party instances from the scaling group.
1381
1115
  *
1382
- * @remarks
1383
- * Before you call the DetachInstances operation, make sure that the following conditions are met:
1384
- * * The specified scaling group is enabled.
1385
- * * The specified scaling group does not have any ongoing scaling activities.
1386
- * **
1387
- * **Note** If the specified scaling group does not have any ongoing scaling activities, the operation can bypass the cooldown period of the scaling group and immediately trigger scaling activities.
1388
- * * Before you call this operation, take note of the following items:
1389
- * * The ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances that are removed from a scaling group by using this operation can run independently. If needed, you can call the [AttachInstances](https://help.aliyun.com/document_detail/25954.html) operation to re-add these instances to a scaling group.
1390
- * * The ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances that are removed from a scaling group by using this operation are not stopped or released.
1391
- * * A successful call only means that Auto Scaling accepts your request. Scaling activities can be triggered as expected, but their successful execution is not guaranteed. You can query the status of a scaling activity based on the ScalingActivityId response parameter.
1392
- * * The removal of ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances must not result in the overall number of instances within the specified scaling group falling below the minimum capacity threshold (MinSize); otherwise, an error will be reported.
1393
- *
1394
1116
  * @param request - DetachInstancesRequest
1395
1117
  * @returns DetachInstancesResponse
1396
1118
  */
@@ -1428,14 +1150,6 @@ export default class Client extends OpenApi {
1428
1150
  /**
1429
1151
  * Detaches vServer groups from a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups to improve service performance. If the load balancer currently attached to your scaling group is no longer needed to distribute the access traffic to the instances in your scaling group, you can call the DetachVServerGroups operation to detach one or more vServer groups of this load balancer from the scaling group.
1430
1152
  *
1431
- * @remarks
1432
- * When you call the DetachVServerGroups operation, you must use the following parameters to specify the vServer groups that you want to detach from your scaling group:
1433
- * * LoadBalancerId: the ID of the load balancer
1434
- * * VServerGroupId: the ID of the vServer group
1435
- * * Port: the port number of the vServer group
1436
- * * When the vServer group specified by the request parameters matches that attached to your scaling group, this operation yields a favorable result. Otherwise, the request is ignored and no error is reported.
1437
- * * Before you call this operation, you must make sure that the load balancer has ceased routing the access traffic to the instances in the scaling group. Failure to do so may lead to service requests being dropped or lost during the detachment process.
1438
- *
1439
1153
  * @param request - DetachVServerGroupsRequest
1440
1154
  * @param runtime - runtime options for this request RuntimeOptions
1441
1155
  * @returns DetachVServerGroupsResponse
@@ -1444,14 +1158,6 @@ export default class Client extends OpenApi {
1444
1158
  /**
1445
1159
  * Detaches vServer groups from a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups to improve service performance. If the load balancer currently attached to your scaling group is no longer needed to distribute the access traffic to the instances in your scaling group, you can call the DetachVServerGroups operation to detach one or more vServer groups of this load balancer from the scaling group.
1446
1160
  *
1447
- * @remarks
1448
- * When you call the DetachVServerGroups operation, you must use the following parameters to specify the vServer groups that you want to detach from your scaling group:
1449
- * * LoadBalancerId: the ID of the load balancer
1450
- * * VServerGroupId: the ID of the vServer group
1451
- * * Port: the port number of the vServer group
1452
- * * When the vServer group specified by the request parameters matches that attached to your scaling group, this operation yields a favorable result. Otherwise, the request is ignored and no error is reported.
1453
- * * Before you call this operation, you must make sure that the load balancer has ceased routing the access traffic to the instances in the scaling group. Failure to do so may lead to service requests being dropped or lost during the detachment process.
1454
- *
1455
1161
  * @param request - DetachVServerGroupsRequest
1456
1162
  * @returns DetachVServerGroupsResponse
1457
1163
  */
@@ -1459,9 +1165,6 @@ export default class Client extends OpenApi {
1459
1165
  /**
1460
1166
  * Disables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you currently do not need an event-triggered task, you can call the DisableAlarm operation to disable it.
1461
1167
  *
1462
- * @remarks
1463
- * Before you disable an event-triggered task, make sure that the task is in the `Normal`, `Alert`, or `Insufficient Data` state.
1464
- *
1465
1168
  * @param request - DisableAlarmRequest
1466
1169
  * @param runtime - runtime options for this request RuntimeOptions
1467
1170
  * @returns DisableAlarmResponse
@@ -1470,9 +1173,6 @@ export default class Client extends OpenApi {
1470
1173
  /**
1471
1174
  * Disables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you currently do not need an event-triggered task, you can call the DisableAlarm operation to disable it.
1472
1175
  *
1473
- * @remarks
1474
- * Before you disable an event-triggered task, make sure that the task is in the `Normal`, `Alert`, or `Insufficient Data` state.
1475
- *
1476
1176
  * @param request - DisableAlarmRequest
1477
1177
  * @returns DisableAlarmResponse
1478
1178
  */
@@ -1480,11 +1180,6 @@ export default class Client extends OpenApi {
1480
1180
  /**
1481
1181
  * Disables a scaling group. If you temporarily do not require a scaling group that is in the Enabled state, you can call the DisableScalingGroup operation to disable it.
1482
1182
  *
1483
- * @remarks
1484
- * Before you call this operation to disable a scaling group, take note of the following items:
1485
- * * If scaling activities are being executed in the specified scaling group when you call this operation, these activities will continue until they are complete. However, scaling activities that are triggered after this operation is called will be rejected.
1486
- * * This operation can be called only when the scaling group is in the Active state.
1487
- *
1488
1183
  * @param request - DisableScalingGroupRequest
1489
1184
  * @param runtime - runtime options for this request RuntimeOptions
1490
1185
  * @returns DisableScalingGroupResponse
@@ -1493,11 +1188,6 @@ export default class Client extends OpenApi {
1493
1188
  /**
1494
1189
  * Disables a scaling group. If you temporarily do not require a scaling group that is in the Enabled state, you can call the DisableScalingGroup operation to disable it.
1495
1190
  *
1496
- * @remarks
1497
- * Before you call this operation to disable a scaling group, take note of the following items:
1498
- * * If scaling activities are being executed in the specified scaling group when you call this operation, these activities will continue until they are complete. However, scaling activities that are triggered after this operation is called will be rejected.
1499
- * * This operation can be called only when the scaling group is in the Active state.
1500
- *
1501
1191
  * @param request - DisableScalingGroupRequest
1502
1192
  * @returns DisableScalingGroupResponse
1503
1193
  */
@@ -1520,14 +1210,6 @@ export default class Client extends OpenApi {
1520
1210
  /**
1521
1211
  * Enables a scaling group. If a scaling group is in the Disabled state and contains an instance configuration source such as a launch template or a scaling configuration, you can call the EnableScalingGroup operation to enable the scaling group. This operation permits Auto Scaling to dynamically adjust the computing power (also known as the number of instances) in the scaling group based on your business requirements.
1522
1212
  *
1523
- * @remarks
1524
- * You can call this operation to enable a scaling group only if the scaling group is in the Inactive state and contains an instance configuration source such as a launch temple or a scaling configuration. The instance configuration source can also be the Elastic Compute Service (ECS) instance that you specified when you created the scaling group. If the preceding requirements are not met, the operation will fail.
1525
- * **
1526
- * **Note** A scaling group can have only one active instance configuration source at a time. When you call this operation to enable a scaling group, you can specify a scaling configuration or a launch template for the scaling group. If the scaling group already have an instance configuration source defined prior to your calling, the scaling configuration or launch template specified within your request will supersede the existing scaling configuration or launch template.
1527
- * * If you specify InstanceId.N to add to the scaling group within your request, Auto Scaling will check whether the addition of InstanceId.N will cause the total number of ECS instances in the scaling group to fall outside the boundaries specified by MinSize and MaxSize after you call this operation.
1528
- * * If the call results in the total number of ECS instances dropping below the value of MinSize, Auto Scaling proactively creates pay-as-you-go ECS instances to ensure that the total number reaches the minimum threshold. For example, if you set MinSize to 5 when you created a scaling group and include InstanceId.N within your request to add two ECS instances when you attempt to enable the scaling group, Auto Scaling creates three more ECS instances in the scaling group after the two ECS instances are added.
1529
- * * If the call results in the total number of ECS instances exceeding the value of MaxSize, the operation fails.
1530
- *
1531
1213
  * @param request - EnableScalingGroupRequest
1532
1214
  * @param runtime - runtime options for this request RuntimeOptions
1533
1215
  * @returns EnableScalingGroupResponse
@@ -1536,14 +1218,6 @@ export default class Client extends OpenApi {
1536
1218
  /**
1537
1219
  * Enables a scaling group. If a scaling group is in the Disabled state and contains an instance configuration source such as a launch template or a scaling configuration, you can call the EnableScalingGroup operation to enable the scaling group. This operation permits Auto Scaling to dynamically adjust the computing power (also known as the number of instances) in the scaling group based on your business requirements.
1538
1220
  *
1539
- * @remarks
1540
- * You can call this operation to enable a scaling group only if the scaling group is in the Inactive state and contains an instance configuration source such as a launch temple or a scaling configuration. The instance configuration source can also be the Elastic Compute Service (ECS) instance that you specified when you created the scaling group. If the preceding requirements are not met, the operation will fail.
1541
- * **
1542
- * **Note** A scaling group can have only one active instance configuration source at a time. When you call this operation to enable a scaling group, you can specify a scaling configuration or a launch template for the scaling group. If the scaling group already have an instance configuration source defined prior to your calling, the scaling configuration or launch template specified within your request will supersede the existing scaling configuration or launch template.
1543
- * * If you specify InstanceId.N to add to the scaling group within your request, Auto Scaling will check whether the addition of InstanceId.N will cause the total number of ECS instances in the scaling group to fall outside the boundaries specified by MinSize and MaxSize after you call this operation.
1544
- * * If the call results in the total number of ECS instances dropping below the value of MinSize, Auto Scaling proactively creates pay-as-you-go ECS instances to ensure that the total number reaches the minimum threshold. For example, if you set MinSize to 5 when you created a scaling group and include InstanceId.N within your request to add two ECS instances when you attempt to enable the scaling group, Auto Scaling creates three more ECS instances in the scaling group after the two ECS instances are added.
1545
- * * If the call results in the total number of ECS instances exceeding the value of MaxSize, the operation fails.
1546
- *
1547
1221
  * @param request - EnableScalingGroupRequest
1548
1222
  * @returns EnableScalingGroupResponse
1549
1223
  */
@@ -1551,13 +1225,6 @@ export default class Client extends OpenApi {
1551
1225
  /**
1552
1226
  * Puts an Elastic Compute Service (ECS) instance into the Standby state.
1553
1227
  *
1554
- * @remarks
1555
- * ## Description
1556
- * * If you call the operation to put an ECS instance in a scaling group that is associated with a Classic Load Balancer (CLB) instance into the Standby state, the weight of the ECS instance as a backend server of the CLB instance is set to 0.
1557
- * * You can remove an instance that is in the Standby state from a scaling group, and then release the instance.
1558
- * * ECS instances that are in the Standby state are not removed from the scaling group during scale-in activities triggered by event-triggered tasks.
1559
- * * If Auto Scaling considers an ECS instance that is in the Standby state unhealthy, for example, the ECS instance is being stopped or being restarted, Auto Scaling does not update the health status of the ECS instance or trigger scale-in activities to remove the ECS instance from the scaling group. Auto Scaling updates the health status of the ECS instance only when the ECS instance is no longer in the Standby state.
1560
- *
1561
1228
  * @param request - EnterStandbyRequest
1562
1229
  * @param runtime - runtime options for this request RuntimeOptions
1563
1230
  * @returns EnterStandbyResponse
@@ -1566,13 +1233,6 @@ export default class Client extends OpenApi {
1566
1233
  /**
1567
1234
  * Puts an Elastic Compute Service (ECS) instance into the Standby state.
1568
1235
  *
1569
- * @remarks
1570
- * ## Description
1571
- * * If you call the operation to put an ECS instance in a scaling group that is associated with a Classic Load Balancer (CLB) instance into the Standby state, the weight of the ECS instance as a backend server of the CLB instance is set to 0.
1572
- * * You can remove an instance that is in the Standby state from a scaling group, and then release the instance.
1573
- * * ECS instances that are in the Standby state are not removed from the scaling group during scale-in activities triggered by event-triggered tasks.
1574
- * * If Auto Scaling considers an ECS instance that is in the Standby state unhealthy, for example, the ECS instance is being stopped or being restarted, Auto Scaling does not update the health status of the ECS instance or trigger scale-in activities to remove the ECS instance from the scaling group. Auto Scaling updates the health status of the ECS instance only when the ECS instance is no longer in the Standby state.
1575
- *
1576
1236
  * @param request - EnterStandbyRequest
1577
1237
  * @returns EnterStandbyResponse
1578
1238
  */
@@ -1580,16 +1240,6 @@ export default class Client extends OpenApi {
1580
1240
  /**
1581
1241
  * Executes a scaling rule. To adjust the number of Elastic Compute Service (ECS) instances or elastic container instances, you can manually execute a scaling rule or enable Auto Scaling to execute a scaling rule. You can call the ExecuteScalingRule operation to execute simple scaling rules or step scaling rules. Auto Scaling automatically executes target tracking scaling rules and predictive scaling rules on your behalf without requiring explicit execution calls.
1582
1242
  *
1583
- * @remarks
1584
- * Before you call this operation, take note of the following items:
1585
- * * The scaling group is in the Active state.
1586
- * * No scaling activities in the scaling group are in progress.
1587
- * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
1588
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
1589
- * If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.
1590
- * If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.
1591
- * You can specify only a limited number of ECS instances in each adjustment. For more information, see the description of the AdjustmentValue parameter in the CreateScalingRule topic.
1592
- *
1593
1243
  * @param request - ExecuteScalingRuleRequest
1594
1244
  * @param runtime - runtime options for this request RuntimeOptions
1595
1245
  * @returns ExecuteScalingRuleResponse
@@ -1598,16 +1248,6 @@ export default class Client extends OpenApi {
1598
1248
  /**
1599
1249
  * Executes a scaling rule. To adjust the number of Elastic Compute Service (ECS) instances or elastic container instances, you can manually execute a scaling rule or enable Auto Scaling to execute a scaling rule. You can call the ExecuteScalingRule operation to execute simple scaling rules or step scaling rules. Auto Scaling automatically executes target tracking scaling rules and predictive scaling rules on your behalf without requiring explicit execution calls.
1600
1250
  *
1601
- * @remarks
1602
- * Before you call this operation, take note of the following items:
1603
- * * The scaling group is in the Active state.
1604
- * * No scaling activities in the scaling group are in progress.
1605
- * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
1606
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
1607
- * If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.
1608
- * If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.
1609
- * You can specify only a limited number of ECS instances in each adjustment. For more information, see the description of the AdjustmentValue parameter in the CreateScalingRule topic.
1610
- *
1611
1251
  * @param request - ExecuteScalingRuleRequest
1612
1252
  * @returns ExecuteScalingRuleResponse
1613
1253
  */
@@ -1615,13 +1255,6 @@ export default class Client extends OpenApi {
1615
1255
  /**
1616
1256
  * Removes an instance from the Standby state. When a scale-in event is triggered in a scaling group, Auto Scaling does not remove Elastic Compute Service (ECS) instances or elastic container instances that are in the Standby state from the scaling group. If you want to restart the instances that are in the Standby state, you can call the ExitStandby operation to remove the instances from the Standby state and put them into the In Service state.
1617
1257
  *
1618
- * @remarks
1619
- * After ECS instances or elastic container instances are removed from the Standby state, the following rules apply:
1620
- * * The ECS instances or elastic container instances enter the In Service state.
1621
- * * The default weight of each ECS instance or elastic container instance as a backend server of the attached load balancer is 50.
1622
- * * If you stop or restart the ECS instances or elastic container instances, the health check status of the instances will be updated.
1623
- * * When a scale-in event is triggered, Auto Scaling may remove the ECS instances or elastic container instances from the scaling group.
1624
- *
1625
1258
  * @param request - ExitStandbyRequest
1626
1259
  * @param runtime - runtime options for this request RuntimeOptions
1627
1260
  * @returns ExitStandbyResponse
@@ -1630,13 +1263,6 @@ export default class Client extends OpenApi {
1630
1263
  /**
1631
1264
  * Removes an instance from the Standby state. When a scale-in event is triggered in a scaling group, Auto Scaling does not remove Elastic Compute Service (ECS) instances or elastic container instances that are in the Standby state from the scaling group. If you want to restart the instances that are in the Standby state, you can call the ExitStandby operation to remove the instances from the Standby state and put them into the In Service state.
1632
1265
  *
1633
- * @remarks
1634
- * After ECS instances or elastic container instances are removed from the Standby state, the following rules apply:
1635
- * * The ECS instances or elastic container instances enter the In Service state.
1636
- * * The default weight of each ECS instance or elastic container instance as a backend server of the attached load balancer is 50.
1637
- * * If you stop or restart the ECS instances or elastic container instances, the health check status of the instances will be updated.
1638
- * * When a scale-in event is triggered, Auto Scaling may remove the ECS instances or elastic container instances from the scaling group.
1639
- *
1640
1266
  * @param request - ExitStandbyRequest
1641
1267
  * @returns ExitStandbyResponse
1642
1268
  */
@@ -1698,11 +1324,11 @@ export default class Client extends OpenApi {
1698
1324
  * Modifies an event-triggered task.
1699
1325
  *
1700
1326
  * @remarks
1701
- * If you set the MetricType parameter to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using the custom metrics. For more information, see [Custom monitoring event-triggered tasks](https://help.aliyun.com/document_detail/74861.html).
1702
- * * When you create an event-triggered task, you must specify the MetricName, DimensionKey, and DimensionValue parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the user_id and scaling_group dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances or elastic container instances in a scaling group within an Alibaba Cloud account.
1703
- * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
1704
- * * For information about the metrics that are supported if you set the MetricType parameter to system, see[ Event-triggered task for system monitoring](https://help.aliyun.com/document_detail/74854.html).
1705
- * > The user_id and scaling_group dimensions are automatically populated. You need to only specify the device and state dimensions. For more information, see the `DimensionKey` and `DimensionValue` parameters in the "Request parameters" section of this topic.
1327
+ * - 如果您创建自定义监控类型的报警任务(MetricType=custom),您需要先将自定义监控项指标上报到云监控。具体操作,请参见[自定义监控报警任务](https://help.aliyun.com/document_detail/74861.html)
1328
+ * - 创建报警任务时,您需要指定监控项(MetricName),并配合维度信息(Dimension.N.DimensionKey和Dimension.N.DimensionValue),来确定伸缩组中该监控项数据的聚合范围。例如,指定user_idscaling_group来确定聚合该用户、该伸缩组下所有ECS实例或ECI实例的监控项数据。
1329
+ * - 自定义监控报警任务(MetricType=custom)的监控项取决于您自有的监控指标。
1330
+ * - 系统监控报警任务(MetricType=system)支持的监控项的更多信息,请参见[系统监控报警任务](https://help.aliyun.com/document_detail/74854.html)
1331
+ * > 维度信息中,user_idscaling_group由系统自动填充,devicestate需要您手动指定。更多信息,请参见参数`Dimension.N.DimensionKey`和`Dimension.N.DimensionValue`。
1706
1332
  *
1707
1333
  * @param request - ModifyAlarmRequest
1708
1334
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1713,11 +1339,11 @@ export default class Client extends OpenApi {
1713
1339
  * Modifies an event-triggered task.
1714
1340
  *
1715
1341
  * @remarks
1716
- * If you set the MetricType parameter to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using the custom metrics. For more information, see [Custom monitoring event-triggered tasks](https://help.aliyun.com/document_detail/74861.html).
1717
- * * When you create an event-triggered task, you must specify the MetricName, DimensionKey, and DimensionValue parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the user_id and scaling_group dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances or elastic container instances in a scaling group within an Alibaba Cloud account.
1718
- * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
1719
- * * For information about the metrics that are supported if you set the MetricType parameter to system, see[ Event-triggered task for system monitoring](https://help.aliyun.com/document_detail/74854.html).
1720
- * > The user_id and scaling_group dimensions are automatically populated. You need to only specify the device and state dimensions. For more information, see the `DimensionKey` and `DimensionValue` parameters in the "Request parameters" section of this topic.
1342
+ * - 如果您创建自定义监控类型的报警任务(MetricType=custom),您需要先将自定义监控项指标上报到云监控。具体操作,请参见[自定义监控报警任务](https://help.aliyun.com/document_detail/74861.html)
1343
+ * - 创建报警任务时,您需要指定监控项(MetricName),并配合维度信息(Dimension.N.DimensionKey和Dimension.N.DimensionValue),来确定伸缩组中该监控项数据的聚合范围。例如,指定user_idscaling_group来确定聚合该用户、该伸缩组下所有ECS实例或ECI实例的监控项数据。
1344
+ * - 自定义监控报警任务(MetricType=custom)的监控项取决于您自有的监控指标。
1345
+ * - 系统监控报警任务(MetricType=system)支持的监控项的更多信息,请参见[系统监控报警任务](https://help.aliyun.com/document_detail/74854.html)
1346
+ * > 维度信息中,user_idscaling_group由系统自动填充,devicestate需要您手动指定。更多信息,请参见参数`Dimension.N.DimensionKey`和`Dimension.N.DimensionValue`。
1721
1347
  *
1722
1348
  * @param request - ModifyAlarmRequest
1723
1349
  * @returns ModifyAlarmResponse
@@ -1742,8 +1368,8 @@ export default class Client extends OpenApi {
1742
1368
  * Modifies a scaling configuration of the Elastic Container Instance type. When you call the ModifyEciScalingConfiguration operation, you can specify the ID, name, and instance properties of the scaling configuration whose information you want to modify. You can modify the instance restart policy, instance bidding policy, and elastic IP address (EIP) bandwidth.
1743
1369
  *
1744
1370
  * @remarks
1745
- * To rename a scaling configuration in a scaling group, ensure the new name is unique within that group.
1746
- * * You can call the [DescribeEciScalingConfigurations](https://help.aliyun.com/document_detail/459374.html) operation to check the modification result.
1371
+ * - 如果修改伸缩配置的名称,请注意同一伸缩组下不能存在名称相同的伸缩配置。
1372
+ * - 可以调用[DescribeEciScalingConfigurations](https://help.aliyun.com/document_detail/459374.html)查询并验证修改结果。
1747
1373
  *
1748
1374
  * @param request - ModifyEciScalingConfigurationRequest
1749
1375
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1754,8 +1380,8 @@ export default class Client extends OpenApi {
1754
1380
  * Modifies a scaling configuration of the Elastic Container Instance type. When you call the ModifyEciScalingConfiguration operation, you can specify the ID, name, and instance properties of the scaling configuration whose information you want to modify. You can modify the instance restart policy, instance bidding policy, and elastic IP address (EIP) bandwidth.
1755
1381
  *
1756
1382
  * @remarks
1757
- * To rename a scaling configuration in a scaling group, ensure the new name is unique within that group.
1758
- * * You can call the [DescribeEciScalingConfigurations](https://help.aliyun.com/document_detail/459374.html) operation to check the modification result.
1383
+ * - 如果修改伸缩配置的名称,请注意同一伸缩组下不能存在名称相同的伸缩配置。
1384
+ * - 可以调用[DescribeEciScalingConfigurations](https://help.aliyun.com/document_detail/459374.html)查询并验证修改结果。
1759
1385
  *
1760
1386
  * @param request - ModifyEciScalingConfigurationRequest
1761
1387
  * @returns ModifyEciScalingConfigurationResponse
@@ -1779,11 +1405,6 @@ export default class Client extends OpenApi {
1779
1405
  /**
1780
1406
  * Modifies a lifecycle hook. If an existing lifecycle hook does not meet your business requirements anymore, you can call the ModifyLifecycleHook operation to modify the information such as the scaling event, timeout period, and default action of the lifecycle hook. Before you modify a lifecycle hook, you can locate the lifecycle hook by its ID, name, or scaling group.
1781
1407
  *
1782
- * @remarks
1783
- * You can use one of the following methods to locate the lifecycle hook that you want to modify:
1784
- * * Specify LifecycleHookId. In this case, ScalingGroupId and LifecycleHookName are ignored.
1785
- * * Specify ScalingGroupId and LifecycleHookName. Each lifecycle hook within a scaling group has a unique name.
1786
- *
1787
1408
  * @param request - ModifyLifecycleHookRequest
1788
1409
  * @param runtime - runtime options for this request RuntimeOptions
1789
1410
  * @returns ModifyLifecycleHookResponse
@@ -1792,11 +1413,6 @@ export default class Client extends OpenApi {
1792
1413
  /**
1793
1414
  * Modifies a lifecycle hook. If an existing lifecycle hook does not meet your business requirements anymore, you can call the ModifyLifecycleHook operation to modify the information such as the scaling event, timeout period, and default action of the lifecycle hook. Before you modify a lifecycle hook, you can locate the lifecycle hook by its ID, name, or scaling group.
1794
1415
  *
1795
- * @remarks
1796
- * You can use one of the following methods to locate the lifecycle hook that you want to modify:
1797
- * * Specify LifecycleHookId. In this case, ScalingGroupId and LifecycleHookName are ignored.
1798
- * * Specify ScalingGroupId and LifecycleHookName. Each lifecycle hook within a scaling group has a unique name.
1799
- *
1800
1416
  * @param request - ModifyLifecycleHookRequest
1801
1417
  * @returns ModifyLifecycleHookResponse
1802
1418
  */
@@ -1817,13 +1433,13 @@ export default class Client extends OpenApi {
1817
1433
  */
1818
1434
  modifyNotificationConfiguration(request: $_model.ModifyNotificationConfigurationRequest): Promise<$_model.ModifyNotificationConfigurationResponse>;
1819
1435
  /**
1820
- * Modifies a scaling configuration.
1436
+ * If a scaling configuration does not meet your business needs, you can call the ModifyScalingConfiguration operation to modify the scaling configuration. A scaling configuration is a template for creating ECS instances during scale-out events.
1821
1437
  *
1822
1438
  * @remarks
1823
- * If you want to change the name of a scaling configuration in a scaling group, make sure that the new name is unique within the scaling group.
1824
- * * If you want to bind a primary elastic network interface (ENI) when you call this operation, you must use one of the following methods. If you use the following methods at the same time, the call fails and an error is reported. In addition, if you use one of the following methods to modify the ENI information when you call this operation, the ENI information configured by using the other method is cleared.
1825
- * * You can specify SecurityGroupId, SecurityGroupIds, and Ipv6AddressCount to configure ENI-related information.
1826
- * * You can specify NetworkInterfaces to configure primary and secondary ENIs. You must use NetworkInterface to specify at least one primary ENI. If you set NetworkInterface.InstanceType to Primary, it specifies that a primary ENI is configured. If you set NetworkInterface.InstanceType to Secondary or leave it empty, it specifies that a secondary ENI is configured.
1439
+ * - Scaling configurations in the same scaling group cannot have the same name.
1440
+ * - You can configure the primary elastic network interface (ENI) in one of the following ways. You can use only one method in a single API call. If you use both methods, the call fails and an error message is returned. When you modify the ENI configuration, using one method clears any configuration set by the other method.
1441
+ * - Directly set the configuration of the primary ENI using parameters such as \\`SecurityGroupId\\`, \\`SecurityGroupIds\\`, and \\`Ipv6AddressCount\\`.
1442
+ * - Set the configuration of the primary and secondary ENIs using the \\`NetworkInterfaces\\` parameter. When you use this parameter, you must configure the primary ENI. To specify the primary ENI, set \\`NetworkInterface.InstanceType\\` to \\`Primary\\`. To specify a secondary ENI, set \\`NetworkInterface.InstanceType\\` to \\`Secondary\\` or leave the parameter empty.
1827
1443
  *
1828
1444
  * @param tmpReq - ModifyScalingConfigurationRequest
1829
1445
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1831,13 +1447,13 @@ export default class Client extends OpenApi {
1831
1447
  */
1832
1448
  modifyScalingConfigurationWithOptions(tmpReq: $_model.ModifyScalingConfigurationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyScalingConfigurationResponse>;
1833
1449
  /**
1834
- * Modifies a scaling configuration.
1450
+ * If a scaling configuration does not meet your business needs, you can call the ModifyScalingConfiguration operation to modify the scaling configuration. A scaling configuration is a template for creating ECS instances during scale-out events.
1835
1451
  *
1836
1452
  * @remarks
1837
- * If you want to change the name of a scaling configuration in a scaling group, make sure that the new name is unique within the scaling group.
1838
- * * If you want to bind a primary elastic network interface (ENI) when you call this operation, you must use one of the following methods. If you use the following methods at the same time, the call fails and an error is reported. In addition, if you use one of the following methods to modify the ENI information when you call this operation, the ENI information configured by using the other method is cleared.
1839
- * * You can specify SecurityGroupId, SecurityGroupIds, and Ipv6AddressCount to configure ENI-related information.
1840
- * * You can specify NetworkInterfaces to configure primary and secondary ENIs. You must use NetworkInterface to specify at least one primary ENI. If you set NetworkInterface.InstanceType to Primary, it specifies that a primary ENI is configured. If you set NetworkInterface.InstanceType to Secondary or leave it empty, it specifies that a secondary ENI is configured.
1453
+ * - Scaling configurations in the same scaling group cannot have the same name.
1454
+ * - You can configure the primary elastic network interface (ENI) in one of the following ways. You can use only one method in a single API call. If you use both methods, the call fails and an error message is returned. When you modify the ENI configuration, using one method clears any configuration set by the other method.
1455
+ * - Directly set the configuration of the primary ENI using parameters such as \\`SecurityGroupId\\`, \\`SecurityGroupIds\\`, and \\`Ipv6AddressCount\\`.
1456
+ * - Set the configuration of the primary and secondary ENIs using the \\`NetworkInterfaces\\` parameter. When you use this parameter, you must configure the primary ENI. To specify the primary ENI, set \\`NetworkInterface.InstanceType\\` to \\`Primary\\`. To specify a secondary ENI, set \\`NetworkInterface.InstanceType\\` to \\`Secondary\\` or leave the parameter empty.
1841
1457
  *
1842
1458
  * @param request - ModifyScalingConfigurationRequest
1843
1459
  * @returns ModifyScalingConfigurationResponse
@@ -1847,19 +1463,17 @@ export default class Client extends OpenApi {
1847
1463
  * Modifies a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can modify scaling groups to adjust your computing power with ease. The computing power refers to the instances that provide the computing capability. When your scaling group cannot meet your business requirements, you can call the ModifyScalingGroup operation to modify scaling group attributes such as the maximum, minimum, and expected numbers of instances. This prevents repeated creation and configuration of scaling groups, which saves you a lot of time and resource costs.
1848
1464
  *
1849
1465
  * @remarks
1850
- * You cannot modify the following parameters by calling this operation:
1851
- * * RegionId
1852
- * * LoadBalancerId
1853
- * **
1854
- * **Note** If you want to modify the load balancer settings of your scaling group, you can call the AttachLoadBalancers operation or the DetachLoadBalancers operation.
1855
- * * DBInstanceId
1856
- * **
1857
- * **Note** If you want to modify the ApsaraDB RDS instance settings of your scaling group, you can call the AttachDBInstances operation or the DetachDBInstances operation.
1858
- * * You can call this operation to modify a scaling group only when the scaling group is in the `Active` or `Inactive` state.
1859
- * * Enabling a new scaling configuration in the scaling group will not impact existing Elastic Compute Service (ECS) instances or elastic container instances that were provisioned based on the previous scaling configuration. These instances will continue to run as expected.
1860
- * * If the modification of the MaxSize setting leads to the total number of ECS instances or elastic container instances in the scaling group exceeding the new maximum limit, Auto Scaling proactively removes the surplus instances to restore the total number to match the new maximum limit.
1861
- * * If the modification of the MinSize setting leads to the total number of ECS instances or elastic container instances in the scaling group exceeding the new minimum threshold, Auto Scaling proactively adds more instances to the scaling group to ensure that the total number aligns with the new minimum threshold.
1862
- * * If the modification of the DesiredCapacity setting leads to the total number of ECS instances or elastic container instances in the scaling group not matching the new desired capacity, Auto Scaling proactively adjusts the total number of instances to ensure that the total number aligns with the new desired capacity.
1466
+ * - The following parameters cannot be modified:
1467
+ * - RegionId
1468
+ * - LoadBalancerId
1469
+ * > To modify an SLB instance, use the AttachLoadBalancers and DetachLoadBalancers APIs.
1470
+ * - DBInstanceId
1471
+ * > To modify an RDS instance, use the AttachDBInstances and DetachDBInstances APIs.
1472
+ * - You can invoke this API only when the scaling group status is `Active` or `Inactive`.
1473
+ * - Enabling a new scaling configuration does not affect ECS instances or ECI instances that were created using an earlier scaling configuration and are currently running.
1474
+ * - If MaxSize is modified such that the current number of ECS or ECI instances in the scaling group exceeds MaxSize, the scaling group automatically removes ECS or ECI instances until the instance count equals MaxSize.
1475
+ * - If MinSize is modified such that the current number of ECS or ECI instances in the scaling group falls below MinSize, the scaling group automatically adds ECS or ECI instances until the instance count equals MinSize.
1476
+ * - If DesiredCapacity is set for the scaling group and then modified such that the current number of ECS or ECI instances differs from the new DesiredCapacity, the scaling group automatically adds or removes ECS or ECI instances until the instance count equals DesiredCapacity.
1863
1477
  *
1864
1478
  * @param request - ModifyScalingGroupRequest
1865
1479
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1870,19 +1484,17 @@ export default class Client extends OpenApi {
1870
1484
  * Modifies a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can modify scaling groups to adjust your computing power with ease. The computing power refers to the instances that provide the computing capability. When your scaling group cannot meet your business requirements, you can call the ModifyScalingGroup operation to modify scaling group attributes such as the maximum, minimum, and expected numbers of instances. This prevents repeated creation and configuration of scaling groups, which saves you a lot of time and resource costs.
1871
1485
  *
1872
1486
  * @remarks
1873
- * You cannot modify the following parameters by calling this operation:
1874
- * * RegionId
1875
- * * LoadBalancerId
1876
- * **
1877
- * **Note** If you want to modify the load balancer settings of your scaling group, you can call the AttachLoadBalancers operation or the DetachLoadBalancers operation.
1878
- * * DBInstanceId
1879
- * **
1880
- * **Note** If you want to modify the ApsaraDB RDS instance settings of your scaling group, you can call the AttachDBInstances operation or the DetachDBInstances operation.
1881
- * * You can call this operation to modify a scaling group only when the scaling group is in the `Active` or `Inactive` state.
1882
- * * Enabling a new scaling configuration in the scaling group will not impact existing Elastic Compute Service (ECS) instances or elastic container instances that were provisioned based on the previous scaling configuration. These instances will continue to run as expected.
1883
- * * If the modification of the MaxSize setting leads to the total number of ECS instances or elastic container instances in the scaling group exceeding the new maximum limit, Auto Scaling proactively removes the surplus instances to restore the total number to match the new maximum limit.
1884
- * * If the modification of the MinSize setting leads to the total number of ECS instances or elastic container instances in the scaling group exceeding the new minimum threshold, Auto Scaling proactively adds more instances to the scaling group to ensure that the total number aligns with the new minimum threshold.
1885
- * * If the modification of the DesiredCapacity setting leads to the total number of ECS instances or elastic container instances in the scaling group not matching the new desired capacity, Auto Scaling proactively adjusts the total number of instances to ensure that the total number aligns with the new desired capacity.
1487
+ * - The following parameters cannot be modified:
1488
+ * - RegionId
1489
+ * - LoadBalancerId
1490
+ * > To modify an SLB instance, use the AttachLoadBalancers and DetachLoadBalancers APIs.
1491
+ * - DBInstanceId
1492
+ * > To modify an RDS instance, use the AttachDBInstances and DetachDBInstances APIs.
1493
+ * - You can invoke this API only when the scaling group status is `Active` or `Inactive`.
1494
+ * - Enabling a new scaling configuration does not affect ECS instances or ECI instances that were created using an earlier scaling configuration and are currently running.
1495
+ * - If MaxSize is modified such that the current number of ECS or ECI instances in the scaling group exceeds MaxSize, the scaling group automatically removes ECS or ECI instances until the instance count equals MaxSize.
1496
+ * - If MinSize is modified such that the current number of ECS or ECI instances in the scaling group falls below MinSize, the scaling group automatically adds ECS or ECI instances until the instance count equals MinSize.
1497
+ * - If DesiredCapacity is set for the scaling group and then modified such that the current number of ECS or ECI instances differs from the new DesiredCapacity, the scaling group automatically adds or removes ECS or ECI instances until the instance count equals DesiredCapacity.
1886
1498
  *
1887
1499
  * @param request - ModifyScalingGroupRequest
1888
1500
  * @returns ModifyScalingGroupResponse
@@ -1906,12 +1518,6 @@ export default class Client extends OpenApi {
1906
1518
  /**
1907
1519
  * Modifies a scheduled task. If an existing scheduled task cannot meet your business requirements, you can call the ModifyScheduledTask operation to adjust its parameter settings including the scaling rule to execute and the boundary values of your scaling group, without the need to create a new scheduled task. This operation provides a flexible way to optimize scheduled tasks.
1908
1520
  *
1909
- * @remarks
1910
- * You can use the following parameters to specify the scaling method of a scheduled task:
1911
- * * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
1912
- * * If you use the `ScalingGroupId` parameter, you must specify the minimum number, maximum number, or expected number of instances in the scheduled task.
1913
- * > You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.
1914
- *
1915
1521
  * @param request - ModifyScheduledTaskRequest
1916
1522
  * @param runtime - runtime options for this request RuntimeOptions
1917
1523
  * @returns ModifyScheduledTaskResponse
@@ -1920,12 +1526,6 @@ export default class Client extends OpenApi {
1920
1526
  /**
1921
1527
  * Modifies a scheduled task. If an existing scheduled task cannot meet your business requirements, you can call the ModifyScheduledTask operation to adjust its parameter settings including the scaling rule to execute and the boundary values of your scaling group, without the need to create a new scheduled task. This operation provides a flexible way to optimize scheduled tasks.
1922
1528
  *
1923
- * @remarks
1924
- * You can use the following parameters to specify the scaling method of a scheduled task:
1925
- * * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
1926
- * * If you use the `ScalingGroupId` parameter, you must specify the minimum number, maximum number, or expected number of instances in the scheduled task.
1927
- * > You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.
1928
- *
1929
1529
  * @param request - ModifyScheduledTaskRequest
1930
1530
  * @returns ModifyScheduledTaskResponse
1931
1531
  */
@@ -1993,15 +1593,6 @@ export default class Client extends OpenApi {
1993
1593
  /**
1994
1594
  * Rebalances the distribution of Elastic Compute Service (ECS) instances across zones. If ECS instances are unevenly distributed across multiple zones, you can call the RebalanceInstances operation to rebalance the distribution of the ECS instances across the zones.
1995
1595
  *
1996
- * @remarks
1997
- * ## [](#)Usage notes
1998
- * Auto Scaling creates new ECS instances to replace the existing ECS instances to fulfill the rebalancing purpose. Auto Scaling starts the new ECS instances before stopping the existing ECS instances. The rebalancing operation does not affect the performance or service availability of your application.
1999
- * * This operation is supported by only multi-zone scaling groups whose `MultiAZPolicy` is set to `BALANCE`.
2000
- * * A rebalancing operation is required only when the distribution of the instances of a multi-zone scaling group is significantly unbalanced. In a rebalancing activity, Auto Scaling replaces up to 20 ECS instances to rectify the unbalanced distribution.
2001
- * * During the execution of a rebalancing operation, if the number of instances in the scaling group approaches or hits the value of MaxSize but the rebalancing operation needs to continue, Auto Scaling allows the total number of ECS instances to momentarily exceed the value of MaxSize by 10%. This temporary surplus condition persists for a duration until equilibrium in the distribution of ECS instances is achieved. Typically, it takes 1 to 6 minutes.
2002
- * **
2003
- * **Note** If the 10% increment of the maximum number of instances in a scaling group yield a non-integer value, the decimal portion is always rounded up to ensure an additional instance is accounted for. For example, you have a scaling group that holds a maximum of 15 ECS instances. During a rebalancing operation, Auto Scaling would permit the total number of instances to momentarily surpass this limit by 2, instead of the calculated 10% (which is 1.5).
2004
- *
2005
1596
  * @param request - RebalanceInstancesRequest
2006
1597
  * @param runtime - runtime options for this request RuntimeOptions
2007
1598
  * @returns RebalanceInstancesResponse
@@ -2010,15 +1601,6 @@ export default class Client extends OpenApi {
2010
1601
  /**
2011
1602
  * Rebalances the distribution of Elastic Compute Service (ECS) instances across zones. If ECS instances are unevenly distributed across multiple zones, you can call the RebalanceInstances operation to rebalance the distribution of the ECS instances across the zones.
2012
1603
  *
2013
- * @remarks
2014
- * ## [](#)Usage notes
2015
- * Auto Scaling creates new ECS instances to replace the existing ECS instances to fulfill the rebalancing purpose. Auto Scaling starts the new ECS instances before stopping the existing ECS instances. The rebalancing operation does not affect the performance or service availability of your application.
2016
- * * This operation is supported by only multi-zone scaling groups whose `MultiAZPolicy` is set to `BALANCE`.
2017
- * * A rebalancing operation is required only when the distribution of the instances of a multi-zone scaling group is significantly unbalanced. In a rebalancing activity, Auto Scaling replaces up to 20 ECS instances to rectify the unbalanced distribution.
2018
- * * During the execution of a rebalancing operation, if the number of instances in the scaling group approaches or hits the value of MaxSize but the rebalancing operation needs to continue, Auto Scaling allows the total number of ECS instances to momentarily exceed the value of MaxSize by 10%. This temporary surplus condition persists for a duration until equilibrium in the distribution of ECS instances is achieved. Typically, it takes 1 to 6 minutes.
2019
- * **
2020
- * **Note** If the 10% increment of the maximum number of instances in a scaling group yield a non-integer value, the decimal portion is always rounded up to ensure an additional instance is accounted for. For example, you have a scaling group that holds a maximum of 15 ECS instances. During a rebalancing operation, Auto Scaling would permit the total number of instances to momentarily surpass this limit by 2, instead of the calculated 10% (which is 1.5).
2021
- *
2022
1604
  * @param request - RebalanceInstancesRequest
2023
1605
  * @returns RebalanceInstancesResponse
2024
1606
  */
@@ -2026,10 +1608,6 @@ export default class Client extends OpenApi {
2026
1608
  /**
2027
1609
  * Extends the time window during which Elastic Compute Service (ECS) instances stay in a Pending state. If the current time window during which an ECS instance stays in a Pending state is not sufficient for you to complete custom operations on the ECS instance, you can call the RecordLifecycleActionHeartbeat operation to extend the time window. When you call this operation, you can specify lifecycleHookId, lifecycleActionToken, and heartbeatTimeout to extend the time window for the desired ECS instance.
2028
1610
  *
2029
- * @remarks
2030
- * You can call this operation only to extend the time window during which Elastic Compute Service (ECS) instances stay in a Pending state.
2031
- * An ECS instance can stay in a Pending state for up to six hours. Each time an ECS instance enters a Pending state, you can extend the time window during which the ECS instance stays in the Pending state up to 20 times.
2032
- *
2033
1611
  * @param request - RecordLifecycleActionHeartbeatRequest
2034
1612
  * @param runtime - runtime options for this request RuntimeOptions
2035
1613
  * @returns RecordLifecycleActionHeartbeatResponse
@@ -2038,26 +1616,22 @@ export default class Client extends OpenApi {
2038
1616
  /**
2039
1617
  * Extends the time window during which Elastic Compute Service (ECS) instances stay in a Pending state. If the current time window during which an ECS instance stays in a Pending state is not sufficient for you to complete custom operations on the ECS instance, you can call the RecordLifecycleActionHeartbeat operation to extend the time window. When you call this operation, you can specify lifecycleHookId, lifecycleActionToken, and heartbeatTimeout to extend the time window for the desired ECS instance.
2040
1618
  *
2041
- * @remarks
2042
- * You can call this operation only to extend the time window during which Elastic Compute Service (ECS) instances stay in a Pending state.
2043
- * An ECS instance can stay in a Pending state for up to six hours. Each time an ECS instance enters a Pending state, you can extend the time window during which the ECS instance stays in the Pending state up to 20 times.
2044
- *
2045
1619
  * @param request - RecordLifecycleActionHeartbeatRequest
2046
1620
  * @returns RecordLifecycleActionHeartbeatResponse
2047
1621
  */
2048
1622
  recordLifecycleActionHeartbeat(request: $_model.RecordLifecycleActionHeartbeatRequest): Promise<$_model.RecordLifecycleActionHeartbeatResponse>;
2049
1623
  /**
2050
- * Removes one or more instances from a scaling group. If your scaling group is enabled and contains no ongoing scaling activities, you can call the RemoveInstances operation to remove instances that you no longer require from the scaling group.
1624
+ * If a scaling group is enabled and has no ongoing scaling activities, you can call the RemoveInstances API to remove one or more instances from the group.
2051
1625
  *
2052
1626
  * @remarks
2053
- * Before you call this operation, make sure that the following requirements are met:
2054
- * * The scaling group is in the Active state.
2055
- * * No scaling activity is in progress within the scaling group.
2056
- * > If no scaling activity is in progress within the scaling group, you can call the operation even within the cooldown period.
2057
- * * If an ECS instance is automatically created by Auto Scaling, or if an ECS instance is manually added to a scaling group and managed by the scaling group, the ECS instance is stopped in economical mode or is released after the instance is removed from the scaling group.
2058
- * * If an ECS instance is manually added to a scaling group and is not managed by the scaling group, the ECS instance is not stopped or released after the instance is removed from the scaling group.
2059
- * * If the difference between the number of existing ECS instances specified by the TotalCapacity parameter and the number of ECS instances that you call this operation to remove is less than the value of the MinSize parameter, the call fails.
2060
- * A successful call only means that Auto Scaling accepts the request. The scaling activity may still fail. You can obtain the status of a scaling activity based on the value of the ScalingActivityId parameter in the response.
1627
+ * - Ensure the following conditions are met before you call this API:
1628
+ * - The scaling group is in the Active state.
1629
+ * - The scaling group has no scaling activities in progress.
1630
+ * > This API can bypass the cooldown (`DefaultCooldown`) if the scaling group has no ongoing scaling activities.
1631
+ * - If an ECS instance is automatically created by Auto Scaling, or is manually added and managed by the scaling group, removing the instance from the scaling group places it in Economical Mode or releases it.
1632
+ * - If an ECS instance is manually added and not managed by the scaling group, removing the instance from the group does not stop or release it.
1633
+ * - The call fails if the number of remaining instances would fall below the minimum number of instances (`MinSize`).
1634
+ * A successful response confirms the Auto Scaling service has accepted the request, but does not guarantee the scaling activity will succeed. You must use the returned `ScalingActivityId` to check the execution status of the scaling activity.
2061
1635
  *
2062
1636
  * @param tmpReq - RemoveInstancesRequest
2063
1637
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2065,17 +1639,17 @@ export default class Client extends OpenApi {
2065
1639
  */
2066
1640
  removeInstancesWithOptions(tmpReq: $_model.RemoveInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RemoveInstancesResponse>;
2067
1641
  /**
2068
- * Removes one or more instances from a scaling group. If your scaling group is enabled and contains no ongoing scaling activities, you can call the RemoveInstances operation to remove instances that you no longer require from the scaling group.
1642
+ * If a scaling group is enabled and has no ongoing scaling activities, you can call the RemoveInstances API to remove one or more instances from the group.
2069
1643
  *
2070
1644
  * @remarks
2071
- * Before you call this operation, make sure that the following requirements are met:
2072
- * * The scaling group is in the Active state.
2073
- * * No scaling activity is in progress within the scaling group.
2074
- * > If no scaling activity is in progress within the scaling group, you can call the operation even within the cooldown period.
2075
- * * If an ECS instance is automatically created by Auto Scaling, or if an ECS instance is manually added to a scaling group and managed by the scaling group, the ECS instance is stopped in economical mode or is released after the instance is removed from the scaling group.
2076
- * * If an ECS instance is manually added to a scaling group and is not managed by the scaling group, the ECS instance is not stopped or released after the instance is removed from the scaling group.
2077
- * * If the difference between the number of existing ECS instances specified by the TotalCapacity parameter and the number of ECS instances that you call this operation to remove is less than the value of the MinSize parameter, the call fails.
2078
- * A successful call only means that Auto Scaling accepts the request. The scaling activity may still fail. You can obtain the status of a scaling activity based on the value of the ScalingActivityId parameter in the response.
1645
+ * - Ensure the following conditions are met before you call this API:
1646
+ * - The scaling group is in the Active state.
1647
+ * - The scaling group has no scaling activities in progress.
1648
+ * > This API can bypass the cooldown (`DefaultCooldown`) if the scaling group has no ongoing scaling activities.
1649
+ * - If an ECS instance is automatically created by Auto Scaling, or is manually added and managed by the scaling group, removing the instance from the scaling group places it in Economical Mode or releases it.
1650
+ * - If an ECS instance is manually added and not managed by the scaling group, removing the instance from the group does not stop or release it.
1651
+ * - The call fails if the number of remaining instances would fall below the minimum number of instances (`MinSize`).
1652
+ * A successful response confirms the Auto Scaling service has accepted the request, but does not guarantee the scaling activity will succeed. You must use the returned `ScalingActivityId` to check the execution status of the scaling activity.
2079
1653
  *
2080
1654
  * @param request - RemoveInstancesRequest
2081
1655
  * @returns RemoveInstancesResponse
@@ -2127,16 +1701,16 @@ export default class Client extends OpenApi {
2127
1701
  */
2128
1702
  rollbackInstanceRefresh(request: $_model.RollbackInstanceRefreshRequest): Promise<$_model.RollbackInstanceRefreshResponse>;
2129
1703
  /**
2130
- * Scales instances. The ScaleWithAdjustment operation differs from the ExecuteScalingRule operation in that ScaleWithAdjust can directly scale instances without requiring you to create a scaling rule in advance.
1704
+ * Unlike the ExecuteScalingRule API, you can use the ScaleWithAdjustment API to trigger elastic scaling based on a specified adjustment rule, without first creating a scaling rule.
2131
1705
  *
2132
1706
  * @remarks
2133
- * Before you call this operation, take note of the following items:
2134
- * * The scaling group is in the Active state.
2135
- * * The scaling group has no ongoing scaling activities.
2136
- * * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities before the cooldown period of the scaling group expires.
2137
- * * If the addition of a specific number of Elastic Compute Service (ECS) instances to the scaling group causes the total number of ECS instances in the scaling group to exceed the maximum allowed number, Auto Scaling adds ECS instances to the scaling group until the total number of instances is equal to the maximum allowed number.
2138
- * * If the removal of a specific number of ECS instances from the scaling group causes the total number of ECS instances in the scaling group to be less than the minimum allowed number, Auto Scaling removes ECS instances from the scaling group until the total number of instances is equal to the minimum allowed number.
2139
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity based on the value of `ScalingActivityId` in the response.
1707
+ * - Ensure the following conditions are met before calling this operation:
1708
+ * - The scaling group is in the Active state.
1709
+ * - No scaling activities are in progress in the scaling group.
1710
+ * - This operation bypasses the cooldown to immediately execute a scaling activity, provided no other scaling activities are in progress.
1711
+ * - If adding the specified ECS instances would cause the total capacity to exceed the maximum size, Auto Scaling sets the total capacity to the maximum size.
1712
+ * - If removing the specified ECS instances would reduce the total capacity below the minimum size, Auto Scaling sets the total capacity to the minimum size.
1713
+ * A successful response indicates that the API request was accepted, but this does not guarantee that the scaling activity will succeed. You must use the returned `ScalingActivityId` to check the status of the scaling activity.
2140
1714
  *
2141
1715
  * @param tmpReq - ScaleWithAdjustmentRequest
2142
1716
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2144,16 +1718,16 @@ export default class Client extends OpenApi {
2144
1718
  */
2145
1719
  scaleWithAdjustmentWithOptions(tmpReq: $_model.ScaleWithAdjustmentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ScaleWithAdjustmentResponse>;
2146
1720
  /**
2147
- * Scales instances. The ScaleWithAdjustment operation differs from the ExecuteScalingRule operation in that ScaleWithAdjust can directly scale instances without requiring you to create a scaling rule in advance.
1721
+ * Unlike the ExecuteScalingRule API, you can use the ScaleWithAdjustment API to trigger elastic scaling based on a specified adjustment rule, without first creating a scaling rule.
2148
1722
  *
2149
1723
  * @remarks
2150
- * Before you call this operation, take note of the following items:
2151
- * * The scaling group is in the Active state.
2152
- * * The scaling group has no ongoing scaling activities.
2153
- * * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities before the cooldown period of the scaling group expires.
2154
- * * If the addition of a specific number of Elastic Compute Service (ECS) instances to the scaling group causes the total number of ECS instances in the scaling group to exceed the maximum allowed number, Auto Scaling adds ECS instances to the scaling group until the total number of instances is equal to the maximum allowed number.
2155
- * * If the removal of a specific number of ECS instances from the scaling group causes the total number of ECS instances in the scaling group to be less than the minimum allowed number, Auto Scaling removes ECS instances from the scaling group until the total number of instances is equal to the minimum allowed number.
2156
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity based on the value of `ScalingActivityId` in the response.
1724
+ * - Ensure the following conditions are met before calling this operation:
1725
+ * - The scaling group is in the Active state.
1726
+ * - No scaling activities are in progress in the scaling group.
1727
+ * - This operation bypasses the cooldown to immediately execute a scaling activity, provided no other scaling activities are in progress.
1728
+ * - If adding the specified ECS instances would cause the total capacity to exceed the maximum size, Auto Scaling sets the total capacity to the maximum size.
1729
+ * - If removing the specified ECS instances would reduce the total capacity below the minimum size, Auto Scaling sets the total capacity to the minimum size.
1730
+ * A successful response indicates that the API request was accepted, but this does not guarantee that the scaling activity will succeed. You must use the returned `ScalingActivityId` to check the status of the scaling activity.
2157
1731
  *
2158
1732
  * @param request - ScaleWithAdjustmentRequest
2159
1733
  * @returns ScaleWithAdjustmentResponse
@@ -2178,7 +1752,7 @@ export default class Client extends OpenApi {
2178
1752
  * Sets instance health. At times, the automatic health check system might not sufficiently determine the precise health status of your Elastic Compute Service (ECS) instances or elastic container instances. To overcome this, you can call the SetInstanceHealth operation to swiftly pinpoint problematic instances and resolve issues. This operation is designed to more precisely align with real-world business requirements and tackle O\\\\\\&M hurdles efficiently.
2179
1753
  *
2180
1754
  * @remarks
2181
- * Auto Scaling detects and removes unhealthy ECS instances or elastic container instances from their scaling groups. To prevent a specific instance from being removed, you can put it in either the Standby or Protected state. For more information, see [EnterStandby](https://help.aliyun.com/document_detail/459345.html) and [SetInstancesProtection](https://help.aliyun.com/document_detail/459342.html).
1755
+ * 伸缩组会检测并移出处于不健康状态的ECS实例或ECI实例,如果您需要保留指定的ECS实例或ECI实例,请将ECS实例或ECI实例转入备用或者保护状态,更多信息,请参见[EnterStandby](https://help.aliyun.com/document_detail/459345.html)[SetInstancesProtection](https://help.aliyun.com/document_detail/459342.html)
2182
1756
  *
2183
1757
  * @param request - SetInstanceHealthRequest
2184
1758
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2189,7 +1763,7 @@ export default class Client extends OpenApi {
2189
1763
  * Sets instance health. At times, the automatic health check system might not sufficiently determine the precise health status of your Elastic Compute Service (ECS) instances or elastic container instances. To overcome this, you can call the SetInstanceHealth operation to swiftly pinpoint problematic instances and resolve issues. This operation is designed to more precisely align with real-world business requirements and tackle O\\\\\\&M hurdles efficiently.
2190
1764
  *
2191
1765
  * @remarks
2192
- * Auto Scaling detects and removes unhealthy ECS instances or elastic container instances from their scaling groups. To prevent a specific instance from being removed, you can put it in either the Standby or Protected state. For more information, see [EnterStandby](https://help.aliyun.com/document_detail/459345.html) and [SetInstancesProtection](https://help.aliyun.com/document_detail/459342.html).
1766
+ * 伸缩组会检测并移出处于不健康状态的ECS实例或ECI实例,如果您需要保留指定的ECS实例或ECI实例,请将ECS实例或ECI实例转入备用或者保护状态,更多信息,请参见[EnterStandby](https://help.aliyun.com/document_detail/459345.html)[SetInstancesProtection](https://help.aliyun.com/document_detail/459342.html)
2193
1767
  *
2194
1768
  * @param request - SetInstanceHealthRequest
2195
1769
  * @returns SetInstanceHealthResponse
@@ -2198,12 +1772,6 @@ export default class Client extends OpenApi {
2198
1772
  /**
2199
1773
  * Puts or removes Elastic Compute Service (ECS) instances into or from the Protected state. After you put an ECS instance into the Protected state, the ECS instance will not be stopped or released when a scale-in event is triggered. In this case, you can manually delete the ECS instance in the Auto Scaling console or by calling the RemoveInstances operation.
2200
1774
  *
2201
- * @remarks
2202
- * Once ECS instances enter the Protected state, they become subject to the following restrictions:
2203
- * * ECS instances will persist in the Protected state, unless you deliberately remove them from this state.
2204
- * * Even in scenarios where automatic scale-in actions are initiated due to fluctuations in the number of ECS instances or the execution of event-triggered tasks, Auto Scaling does not remove ECS instances that are in the Protected state from their respective scaling groups. Only after being manually removed from their respective scaling groups can ECS instances that are in the Protected state be released. For more information, see [Remove an ECS instance](https://help.aliyun.com/document_detail/459393.html).
2205
- * * ECS instances in the Protected state maintain their health status even when they undergo stopping or restarting processes.
2206
- *
2207
1775
  * @param request - SetInstancesProtectionRequest
2208
1776
  * @param runtime - runtime options for this request RuntimeOptions
2209
1777
  * @returns SetInstancesProtectionResponse
@@ -2212,24 +1780,18 @@ export default class Client extends OpenApi {
2212
1780
  /**
2213
1781
  * Puts or removes Elastic Compute Service (ECS) instances into or from the Protected state. After you put an ECS instance into the Protected state, the ECS instance will not be stopped or released when a scale-in event is triggered. In this case, you can manually delete the ECS instance in the Auto Scaling console or by calling the RemoveInstances operation.
2214
1782
  *
2215
- * @remarks
2216
- * Once ECS instances enter the Protected state, they become subject to the following restrictions:
2217
- * * ECS instances will persist in the Protected state, unless you deliberately remove them from this state.
2218
- * * Even in scenarios where automatic scale-in actions are initiated due to fluctuations in the number of ECS instances or the execution of event-triggered tasks, Auto Scaling does not remove ECS instances that are in the Protected state from their respective scaling groups. Only after being manually removed from their respective scaling groups can ECS instances that are in the Protected state be released. For more information, see [Remove an ECS instance](https://help.aliyun.com/document_detail/459393.html).
2219
- * * ECS instances in the Protected state maintain their health status even when they undergo stopping or restarting processes.
2220
- *
2221
1783
  * @param request - SetInstancesProtectionRequest
2222
1784
  * @returns SetInstancesProtectionResponse
2223
1785
  */
2224
1786
  setInstancesProtection(request: $_model.SetInstancesProtectionRequest): Promise<$_model.SetInstancesProtectionResponse>;
2225
1787
  /**
2226
- * Starts an instance refresh task. If you want to apply a new scaling configuration in a scaling group or update the image specified in a scaling configuration, you can call the StartInstanceRefresh operation.
1788
+ * Refreshes instances in a scaling group when you need to apply a new scaling configuration or update the image used by instances in the scaling group.
2227
1789
  *
2228
1790
  * @remarks
2229
- * Only one instance refresh task can be executed at a time in a scaling group.
2230
- * * You can start instance refresh tasks for Elastic Compute Service (ECS) instances in scaling groups that use the **priority policy** as the scaling policy. Scaling groups whose capacity is measured based on the **number of vCPUs** and scaling groups whose instance reclaim mode is **Economical Mode** or **Forcibly Recycle** do not support the StartInstanceRefresh operation.
2231
- * * When you start an instance refresh task, scaling events can be completed as expected. Take note that instances that are scaled out use the configurations specified in the instance refresh task.
2232
- * * The StartInstanceRefresh operation does not take effect on instances that are manually added or instances that are in the Standby and Protected states.
1791
+ * - Only one instance refresh node can run in a scaling group at a time.
1792
+ * - This feature is supported only for ECS scaling groups whose scale-out policy is set to **Priority Policy**. Scaling groups that use **vCPU-based capacity calculation** and scaling groups whose instance revoke pattern is set to **Shutdown and Revoke Pattern** or **Forced Shutdown and Revoke Pattern** do not support this feature.
1793
+ * - During an instance refresh, normal scale-out and scale-in operations can proceed. However, scale-out operations use the desired configuration specified in the instance refresh node.
1794
+ * - Instances that are manually added to the scaling group, or instances in the standby state or protection status, are ignored by the instance refresh node and do not participate in the refresh.
2233
1795
  *
2234
1796
  * @param request - StartInstanceRefreshRequest
2235
1797
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2237,13 +1799,13 @@ export default class Client extends OpenApi {
2237
1799
  */
2238
1800
  startInstanceRefreshWithOptions(request: $_model.StartInstanceRefreshRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StartInstanceRefreshResponse>;
2239
1801
  /**
2240
- * Starts an instance refresh task. If you want to apply a new scaling configuration in a scaling group or update the image specified in a scaling configuration, you can call the StartInstanceRefresh operation.
1802
+ * Refreshes instances in a scaling group when you need to apply a new scaling configuration or update the image used by instances in the scaling group.
2241
1803
  *
2242
1804
  * @remarks
2243
- * Only one instance refresh task can be executed at a time in a scaling group.
2244
- * * You can start instance refresh tasks for Elastic Compute Service (ECS) instances in scaling groups that use the **priority policy** as the scaling policy. Scaling groups whose capacity is measured based on the **number of vCPUs** and scaling groups whose instance reclaim mode is **Economical Mode** or **Forcibly Recycle** do not support the StartInstanceRefresh operation.
2245
- * * When you start an instance refresh task, scaling events can be completed as expected. Take note that instances that are scaled out use the configurations specified in the instance refresh task.
2246
- * * The StartInstanceRefresh operation does not take effect on instances that are manually added or instances that are in the Standby and Protected states.
1805
+ * - Only one instance refresh node can run in a scaling group at a time.
1806
+ * - This feature is supported only for ECS scaling groups whose scale-out policy is set to **Priority Policy**. Scaling groups that use **vCPU-based capacity calculation** and scaling groups whose instance revoke pattern is set to **Shutdown and Revoke Pattern** or **Forced Shutdown and Revoke Pattern** do not support this feature.
1807
+ * - During an instance refresh, normal scale-out and scale-in operations can proceed. However, scale-out operations use the desired configuration specified in the instance refresh node.
1808
+ * - Instances that are manually added to the scaling group, or instances in the standby state or protection status, are ignored by the instance refresh node and do not participate in the refresh.
2247
1809
  *
2248
1810
  * @param request - StartInstanceRefreshRequest
2249
1811
  * @returns StartInstanceRefreshResponse