@alicloud/ess20220222 1.5.0 → 1.5.2

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.
package/dist/client.js CHANGED
@@ -3582,6 +3582,8 @@ class DescribeScheduledTasksRequest extends $tea.Model {
3582
3582
  ownerId: 'OwnerId',
3583
3583
  pageNumber: 'PageNumber',
3584
3584
  pageSize: 'PageSize',
3585
+ recurrenceType: 'RecurrenceType',
3586
+ recurrenceValue: 'RecurrenceValue',
3585
3587
  regionId: 'RegionId',
3586
3588
  resourceOwnerAccount: 'ResourceOwnerAccount',
3587
3589
  resourceOwnerId: 'ResourceOwnerId',
@@ -3589,6 +3591,8 @@ class DescribeScheduledTasksRequest extends $tea.Model {
3589
3591
  scheduledActions: 'ScheduledActions',
3590
3592
  scheduledTaskIds: 'ScheduledTaskIds',
3591
3593
  scheduledTaskNames: 'ScheduledTaskNames',
3594
+ taskEnabled: 'TaskEnabled',
3595
+ taskName: 'TaskName',
3592
3596
  };
3593
3597
  }
3594
3598
  static types() {
@@ -3597,6 +3601,8 @@ class DescribeScheduledTasksRequest extends $tea.Model {
3597
3601
  ownerId: 'number',
3598
3602
  pageNumber: 'number',
3599
3603
  pageSize: 'number',
3604
+ recurrenceType: 'string',
3605
+ recurrenceValue: 'string',
3600
3606
  regionId: 'string',
3601
3607
  resourceOwnerAccount: 'string',
3602
3608
  resourceOwnerId: 'number',
@@ -3604,6 +3610,8 @@ class DescribeScheduledTasksRequest extends $tea.Model {
3604
3610
  scheduledActions: { 'type': 'array', 'itemType': 'string' },
3605
3611
  scheduledTaskIds: { 'type': 'array', 'itemType': 'string' },
3606
3612
  scheduledTaskNames: { 'type': 'array', 'itemType': 'string' },
3613
+ taskEnabled: 'boolean',
3614
+ taskName: 'string',
3607
3615
  };
3608
3616
  }
3609
3617
  constructor(map) {
@@ -5251,6 +5259,7 @@ class ModifyScalingConfigurationRequest extends $tea.Model {
5251
5259
  override: 'Override',
5252
5260
  ownerAccount: 'OwnerAccount',
5253
5261
  ownerId: 'OwnerId',
5262
+ password: 'Password',
5254
5263
  passwordInherit: 'PasswordInherit',
5255
5264
  ramRoleName: 'RamRoleName',
5256
5265
  resourceGroupId: 'ResourceGroupId',
@@ -5308,6 +5317,7 @@ class ModifyScalingConfigurationRequest extends $tea.Model {
5308
5317
  override: 'boolean',
5309
5318
  ownerAccount: 'string',
5310
5319
  ownerId: 'number',
5320
+ password: 'string',
5311
5321
  passwordInherit: 'boolean',
5312
5322
  ramRoleName: 'string',
5313
5323
  resourceGroupId: 'string',
@@ -5371,6 +5381,7 @@ class ModifyScalingConfigurationShrinkRequest extends $tea.Model {
5371
5381
  override: 'Override',
5372
5382
  ownerAccount: 'OwnerAccount',
5373
5383
  ownerId: 'OwnerId',
5384
+ password: 'Password',
5374
5385
  passwordInherit: 'PasswordInherit',
5375
5386
  ramRoleName: 'RamRoleName',
5376
5387
  resourceGroupId: 'ResourceGroupId',
@@ -5428,6 +5439,7 @@ class ModifyScalingConfigurationShrinkRequest extends $tea.Model {
5428
5439
  override: 'boolean',
5429
5440
  ownerAccount: 'string',
5430
5441
  ownerId: 'number',
5442
+ password: 'string',
5431
5443
  passwordInherit: 'boolean',
5432
5444
  ramRoleName: 'string',
5433
5445
  resourceGroupId: 'string',
@@ -9956,6 +9968,7 @@ class DescribeScalingConfigurationsResponseBodyScalingConfigurations extends $te
9956
9968
  memory: 'Memory',
9957
9969
  networkInterfaces: 'NetworkInterfaces',
9958
9970
  passwordInherit: 'PasswordInherit',
9971
+ passwordSetted: 'PasswordSetted',
9959
9972
  privatePoolOptions_id: 'PrivatePoolOptions.Id',
9960
9973
  privatePoolOptions_matchCriteria: 'PrivatePoolOptions.MatchCriteria',
9961
9974
  ramRoleName: 'RamRoleName',
@@ -10028,6 +10041,7 @@ class DescribeScalingConfigurationsResponseBodyScalingConfigurations extends $te
10028
10041
  memory: 'number',
10029
10042
  networkInterfaces: { 'type': 'array', 'itemType': DescribeScalingConfigurationsResponseBodyScalingConfigurationsNetworkInterfaces },
10030
10043
  passwordInherit: 'boolean',
10044
+ passwordSetted: 'boolean',
10031
10045
  privatePoolOptions_id: 'string',
10032
10046
  privatePoolOptions_matchCriteria: 'string',
10033
10047
  ramRoleName: 'string',
@@ -12562,10 +12576,11 @@ class Client extends openapi_client_1.default {
12562
12576
  return endpoint_util_1.default.getEndpointRules(productId, regionId, endpointRule, network, suffix);
12563
12577
  }
12564
12578
  /**
12565
- * @summary Manages scaling configurations of the Elastic Container Instance type. If you want to efficiently create or update a scaling configuration of the Elastic Container Instance type by using a configuration file, you can call the ApplyEciScalingConfiguration operation.
12579
+ * @summary 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.
12566
12580
  *
12567
- * @description You can manage scaling configurations of the Elastic Container Instance type by using a YAML configuration file based on the following logic:
12568
- * If you specify the ID of a scaling configuration, you can update the scaling configuration by using the YAML configuration file. If you do not specify the ID of a scaling configuration, you can create a scaling configuration by using the YAML configuration file.
12581
+ * @description 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:
12582
+ * * If you include a scaling configuration ID within your request, the system updates the scaling configuration based on the YAML configuration file.
12583
+ * * 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.
12569
12584
  *
12570
12585
  * @param request ApplyEciScalingConfigurationRequest
12571
12586
  * @param runtime runtime options for this request RuntimeOptions
@@ -12606,10 +12621,11 @@ class Client extends openapi_client_1.default {
12606
12621
  return $tea.cast(await this.callApi(params, req, runtime), new ApplyEciScalingConfigurationResponse({}));
12607
12622
  }
12608
12623
  /**
12609
- * @summary Manages scaling configurations of the Elastic Container Instance type. If you want to efficiently create or update a scaling configuration of the Elastic Container Instance type by using a configuration file, you can call the ApplyEciScalingConfiguration operation.
12624
+ * @summary 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.
12610
12625
  *
12611
- * @description You can manage scaling configurations of the Elastic Container Instance type by using a YAML configuration file based on the following logic:
12612
- * If you specify the ID of a scaling configuration, you can update the scaling configuration by using the YAML configuration file. If you do not specify the ID of a scaling configuration, you can create a scaling configuration by using the YAML configuration file.
12626
+ * @description 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:
12627
+ * * If you include a scaling configuration ID within your request, the system updates the scaling configuration based on the YAML configuration file.
12628
+ * * 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.
12613
12629
  *
12614
12630
  * @param request ApplyEciScalingConfigurationRequest
12615
12631
  * @return ApplyEciScalingConfigurationResponse
@@ -12872,7 +12888,7 @@ class Client extends openapi_client_1.default {
12872
12888
  return await this.attachDBInstancesWithOptions(request, runtime);
12873
12889
  }
12874
12890
  /**
12875
- * @summary Adds instances to a scaling group. You can call the AttachInstances operation to add independent Elastic Compute Service (ECS) instances, elastic container instances, or non-Alibaba Cloud instances to your scaling group to provide services. You can also call this operation to change the state of ECS instances in your scaling group from Economical Mode to In Service.
12891
+ * @summary 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.
12876
12892
  *
12877
12893
  * @description Before you call this operation, take note of the following items:
12878
12894
  * * The scaling group is in the Active state.
@@ -12946,7 +12962,7 @@ class Client extends openapi_client_1.default {
12946
12962
  return $tea.cast(await this.callApi(params, req, runtime), new AttachInstancesResponse({}));
12947
12963
  }
12948
12964
  /**
12949
- * @summary Adds instances to a scaling group. You can call the AttachInstances operation to add independent Elastic Compute Service (ECS) instances, elastic container instances, or non-Alibaba Cloud instances to your scaling group to provide services. You can also call this operation to change the state of ECS instances in your scaling group from Economical Mode to In Service.
12965
+ * @summary 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.
12950
12966
  *
12951
12967
  * @description Before you call this operation, take note of the following items:
12952
12968
  * * The scaling group is in the Active state.
@@ -13611,7 +13627,7 @@ class Client extends openapi_client_1.default {
13611
13627
  return await this.createEciScalingConfigurationWithOptions(request, runtime);
13612
13628
  }
13613
13629
  /**
13614
- * @summary Creates one or more lifecycle hooks.
13630
+ * @summary 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.
13615
13631
  *
13616
13632
  * @description You can create up to six lifecycle hooks for each scaling group. After a lifecycle hook is created for a scaling group, Elastic Compute Service (ECS) instances in the scaling group waits to be added to or removed from the scaling group during scaling activities. You can use the HeartbeatTimeout parameter to specify the timeout period of the lifecycle hook. During the timeout period of a lifecycle hook, you can perform custom operations such as initialize ECS instance configurations and download ECS instance data on the ECS instances for which the lifecycle hook is applied.
13617
13633
  * During a scale-out activity and the timeout period of a lifecycle hook, the private IP addresses of ECS instances wait to be added to the associated whitelist that manages access to the ApsaraDB RDS instance. The ECS instances also wait to be added to the backend server group of the associated Classic Load Balancer (CLB) instance. After the lifecycle hook times out, the private IP addresses of the ECS instances are added to the whitelist that manages access to the associated ApsaraDB RDS instance. The ECS instances are also added to the backend server group of the associated CLB instance. During a scale-in activity and the timeout period of a lifecycle hook, the private IP addresses of ECS instances wait to be removed from the whitelist that manages access to the associated ApsaraDB RDS instance. The ECS instances also wait to be removed from the backend server group of the associated CLB instance. After the lifecycle hook times out, the private IP addresses of the ECS instances are removed from the whitelist that manages access to the associated ApsaraDB RDS instance. The ECS instances are also removed from the backend server group of the associated CLB instance.
@@ -13672,7 +13688,7 @@ class Client extends openapi_client_1.default {
13672
13688
  return $tea.cast(await this.callApi(params, req, runtime), new CreateLifecycleHookResponse({}));
13673
13689
  }
13674
13690
  /**
13675
- * @summary Creates one or more lifecycle hooks.
13691
+ * @summary 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.
13676
13692
  *
13677
13693
  * @description You can create up to six lifecycle hooks for each scaling group. After a lifecycle hook is created for a scaling group, Elastic Compute Service (ECS) instances in the scaling group waits to be added to or removed from the scaling group during scaling activities. You can use the HeartbeatTimeout parameter to specify the timeout period of the lifecycle hook. During the timeout period of a lifecycle hook, you can perform custom operations such as initialize ECS instance configurations and download ECS instance data on the ECS instances for which the lifecycle hook is applied.
13678
13694
  * During a scale-out activity and the timeout period of a lifecycle hook, the private IP addresses of ECS instances wait to be added to the associated whitelist that manages access to the ApsaraDB RDS instance. The ECS instances also wait to be added to the backend server group of the associated Classic Load Balancer (CLB) instance. After the lifecycle hook times out, the private IP addresses of the ECS instances are added to the whitelist that manages access to the associated ApsaraDB RDS instance. The ECS instances are also added to the backend server group of the associated CLB instance. During a scale-in activity and the timeout period of a lifecycle hook, the private IP addresses of ECS instances wait to be removed from the whitelist that manages access to the associated ApsaraDB RDS instance. The ECS instances also wait to be removed from the backend server group of the associated CLB instance. After the lifecycle hook times out, the private IP addresses of the ECS instances are removed from the whitelist that manages access to the associated ApsaraDB RDS instance. The ECS instances are also removed from the backend server group of the associated CLB instance.
@@ -13975,27 +13991,27 @@ class Client extends openapi_client_1.default {
13975
13991
  return await this.createScalingConfigurationWithOptions(request, runtime);
13976
13992
  }
13977
13993
  /**
13978
- * @summary Creates a scaling group.
13979
- *
13980
- * @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used in similar business scenarios.
13981
- * You can create only a limited number of scaling groups in a region. Go to Quota Center to check the quota of the scaling groups.
13982
- * A scaling group does not immediately take effect after you create the scaling group. You must call the EnableScalingGroup operation to enable the scaling group. After you enable the scaling group, Auto Scaling can execute scaling rules to trigger scaling activities in the scaling group.
13983
- * The Classic Load Balancer (CLB) instances and ApsaraDB RDS instances that you want to associate with a scaling group must reside in the same region as the scaling group. CLB instances are formerly known as Server Load Balancer (SLB) instances. For more information, see the [Regions and zones](https://help.aliyun.com/document_detail/40654.html) topic.
13984
- * If you associate a CLB instance when you create a scaling group, Auto Scaling automatically adds ECS instances in the scaling group to the backend server group of the associated CLB instance. You can specify a server group to which ECS instances can be added. You can add ECS instances to the following types of server groups:
13985
- * * Default server group: a group of ECS instances that are used to receive requests. If you do not specify a vServer group or a primary/secondary server group for a listener, requests are forwarded to the ECS instances in the default server group.
13986
- * * vServer group: If you want to forward requests to backend servers that are not in the default server group or configure domain name-based or URL-based forwarding rules, you can use vServer groups.
13987
- * > If you specify the default server group and multiple vServer groups at the same time, ECS instances are added to all specified server groups.
13988
- * The default weight of an ECS instance that is added as a backend server of a CLB instance is 50. The CLB instance that you want to associate with your scaling group must meet the following requirements:
13989
- * * The CLB instance must be in the Active state. You can call the DescribeLoadBalancers operation to query the state of the CLB instance.
13990
- * * The health check feature must be enabled on all listener ports that are configured for the CLB instance. Otherwise, the scaling group fails to be created.
13991
- * If you associate an Application Load Balancer (ALB) server group with a scaling group, Auto Scaling automatically adds ECS instances that are in the scaling group to the ALB server group to process requests distributed by the ALB instance to which the ALB server group belongs. You can specify multiple ALB server groups. The server groups must reside in the same virtual private cloud (VPC) as the scaling group. For more information, see the "AttachAlbServerGroups" topic.
13992
- * If you associate an ApsaraDB RDS instance with a scaling group, Auto Scaling automatically adds the private IP addresses of the ECS instances in the scaling group to the IP address whitelist of the ApsaraDB RDS instance. The ApsaraDB RDS instance that you want to associate with your scaling group must meet the following requirements:
13993
- * * The ApsaraDB RDS instance must be in the Running state. You can call the DescribeDBInstances operation to query the state of the ApsaraDB RDS instance.
13994
- * * The number of IP addresses in the IP address whitelist of the ApsaraDB RDS instance cannot exceed the upper limit. For more information, see the "Configure whitelists" topic.
13995
- * If you set the MultiAZPolicy parameter of the scaling group to COST_OPTIMIZED, take note of the following items:
13996
- * * You can use the OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, and SpotInstancePools parameters to specify the instance allocation method based on the cost optimization policy. This instance allocation method is prioritized during scaling.
13997
- * * If you do not specify the OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, or SpotInstancePools parameter, the instance types that are provided at the lowest price are used to create instances based on the cost optimization policy.
13998
- * If you set the `Tags.Propagate` parameter of the scaling group to true, the following rules apply:
13994
+ * @summary 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.
13995
+ *
13996
+ * @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used for similar purposes.
13997
+ * 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.
13998
+ * A scaling group does not immediately take effect after you create the scaling group. 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.
13999
+ * 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).
14000
+ * If you attach a CLB instance to the scaling group that you want to create, Auto Scaling will automatically add 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:
14001
+ * * 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.
14002
+ * * vServer group: If you want to forward different requests to different backend servers, or you want to forward requests based on domain names and URLs, you can specify vServer groups.
14003
+ * > If you specify both the default server group and multiple server groups simultaneously, Auto Scaling will add the ECS instances in your scaling group to these server groups concurrently.
14004
+ * The default weight of each ECS instance as a backend server is 50. If you want to attach a CLB instance to the scaling group that you want to create, make sure that the CLB instance meets the following requirements:
14005
+ * * 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.
14006
+ * * Health check must be enabled on all listener ports configured for the CLB instance. Otherwise, the scaling group will fail to be created.
14007
+ * If you attach Application Load Balancer (ALB) or Network Load Balancer (NLB) server groups to the scaling group that you want to create, Auto Scaling will add 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 attach multiple ALB or NLB server groups to a scaling group. Make sure that the ALB or NLB server groups belong to the same virtual private cloud (VPC). For more information, see [AttachAlbServerGroups](https://help.aliyun.com/document_detail/266800.html) or [AttachServerGroups](https://help.aliyun.com/document_detail/600559.html).
14008
+ * If you attach an ApsaraDB RDS instance to the scaling group that you want to create, Auto Scaling will automatically add the private IP addresses of the ECS instances in your scaling group to the IP address whitelist of the ApsaraDB RDS instance. Before you attach an ApsaraDB RDS instance to your scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
14009
+ * * The ApsaraDB RDS instance is in the Running state. You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/610396.html) state to query the status of ApsaraDB RDS instances.
14010
+ * * The number of IP addresses in the IP address whitelist of the ApsaraDB RDS instance does not reach its upper limit. For more information, see [Configure a whitelist](https://help.aliyun.com/document_detail/43185.html).
14011
+ * If you set MultiAZPolicy for the scaling group that you want to create to COST_OPTIMIZED, the following rules apply:
14012
+ * * If you use OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, and SpotInstancePools to specify the instance allocation mode under the cost optimization policy, Auto Scaling will prioritize the implementation of the specified instance allocation mode during scale-out events.
14013
+ * * If you do not specify OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, or SpotInstancePools, Auto Scaling will preferentially create instances of the lowest-priced instance type based on the cost optimization policy.
14014
+ * If you set `Tags.Propagate` to true, the following rules will apply:
13999
14015
  * * Tags that you add to the scaling group cannot be propagated to existing instances in the scaling group. Tags that you add to the scaling group are propagated to only new instances.
14000
14016
  * * If you specify instance tags in the scaling configuration that is used to create instances and propagate the tags that you add to the scaling group to the instances, all tags exist at the same time.
14001
14017
  * * If the tag key that you specify in a scaling configuration and the tag key that you add to the scaling group of the scaling configuration are the same, the tag value that you specify in the scaling configuration is preferentially used.
@@ -14159,27 +14175,27 @@ class Client extends openapi_client_1.default {
14159
14175
  return $tea.cast(await this.callApi(params, req, runtime), new CreateScalingGroupResponse({}));
14160
14176
  }
14161
14177
  /**
14162
- * @summary Creates a scaling group.
14163
- *
14164
- * @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used in similar business scenarios.
14165
- * You can create only a limited number of scaling groups in a region. Go to Quota Center to check the quota of the scaling groups.
14166
- * A scaling group does not immediately take effect after you create the scaling group. You must call the EnableScalingGroup operation to enable the scaling group. After you enable the scaling group, Auto Scaling can execute scaling rules to trigger scaling activities in the scaling group.
14167
- * The Classic Load Balancer (CLB) instances and ApsaraDB RDS instances that you want to associate with a scaling group must reside in the same region as the scaling group. CLB instances are formerly known as Server Load Balancer (SLB) instances. For more information, see the [Regions and zones](https://help.aliyun.com/document_detail/40654.html) topic.
14168
- * If you associate a CLB instance when you create a scaling group, Auto Scaling automatically adds ECS instances in the scaling group to the backend server group of the associated CLB instance. You can specify a server group to which ECS instances can be added. You can add ECS instances to the following types of server groups:
14169
- * * Default server group: a group of ECS instances that are used to receive requests. If you do not specify a vServer group or a primary/secondary server group for a listener, requests are forwarded to the ECS instances in the default server group.
14170
- * * vServer group: If you want to forward requests to backend servers that are not in the default server group or configure domain name-based or URL-based forwarding rules, you can use vServer groups.
14171
- * > If you specify the default server group and multiple vServer groups at the same time, ECS instances are added to all specified server groups.
14172
- * The default weight of an ECS instance that is added as a backend server of a CLB instance is 50. The CLB instance that you want to associate with your scaling group must meet the following requirements:
14173
- * * The CLB instance must be in the Active state. You can call the DescribeLoadBalancers operation to query the state of the CLB instance.
14174
- * * The health check feature must be enabled on all listener ports that are configured for the CLB instance. Otherwise, the scaling group fails to be created.
14175
- * If you associate an Application Load Balancer (ALB) server group with a scaling group, Auto Scaling automatically adds ECS instances that are in the scaling group to the ALB server group to process requests distributed by the ALB instance to which the ALB server group belongs. You can specify multiple ALB server groups. The server groups must reside in the same virtual private cloud (VPC) as the scaling group. For more information, see the "AttachAlbServerGroups" topic.
14176
- * If you associate an ApsaraDB RDS instance with a scaling group, Auto Scaling automatically adds the private IP addresses of the ECS instances in the scaling group to the IP address whitelist of the ApsaraDB RDS instance. The ApsaraDB RDS instance that you want to associate with your scaling group must meet the following requirements:
14177
- * * The ApsaraDB RDS instance must be in the Running state. You can call the DescribeDBInstances operation to query the state of the ApsaraDB RDS instance.
14178
- * * The number of IP addresses in the IP address whitelist of the ApsaraDB RDS instance cannot exceed the upper limit. For more information, see the "Configure whitelists" topic.
14179
- * If you set the MultiAZPolicy parameter of the scaling group to COST_OPTIMIZED, take note of the following items:
14180
- * * You can use the OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, and SpotInstancePools parameters to specify the instance allocation method based on the cost optimization policy. This instance allocation method is prioritized during scaling.
14181
- * * If you do not specify the OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, or SpotInstancePools parameter, the instance types that are provided at the lowest price are used to create instances based on the cost optimization policy.
14182
- * If you set the `Tags.Propagate` parameter of the scaling group to true, the following rules apply:
14178
+ * @summary 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.
14179
+ *
14180
+ * @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used for similar purposes.
14181
+ * 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.
14182
+ * A scaling group does not immediately take effect after you create the scaling group. 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.
14183
+ * 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).
14184
+ * If you attach a CLB instance to the scaling group that you want to create, Auto Scaling will automatically add 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:
14185
+ * * 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.
14186
+ * * vServer group: If you want to forward different requests to different backend servers, or you want to forward requests based on domain names and URLs, you can specify vServer groups.
14187
+ * > If you specify both the default server group and multiple server groups simultaneously, Auto Scaling will add the ECS instances in your scaling group to these server groups concurrently.
14188
+ * The default weight of each ECS instance as a backend server is 50. If you want to attach a CLB instance to the scaling group that you want to create, make sure that the CLB instance meets the following requirements:
14189
+ * * 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.
14190
+ * * Health check must be enabled on all listener ports configured for the CLB instance. Otherwise, the scaling group will fail to be created.
14191
+ * If you attach Application Load Balancer (ALB) or Network Load Balancer (NLB) server groups to the scaling group that you want to create, Auto Scaling will add 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 attach multiple ALB or NLB server groups to a scaling group. Make sure that the ALB or NLB server groups belong to the same virtual private cloud (VPC). For more information, see [AttachAlbServerGroups](https://help.aliyun.com/document_detail/266800.html) or [AttachServerGroups](https://help.aliyun.com/document_detail/600559.html).
14192
+ * If you attach an ApsaraDB RDS instance to the scaling group that you want to create, Auto Scaling will automatically add the private IP addresses of the ECS instances in your scaling group to the IP address whitelist of the ApsaraDB RDS instance. Before you attach an ApsaraDB RDS instance to your scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
14193
+ * * The ApsaraDB RDS instance is in the Running state. You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/610396.html) state to query the status of ApsaraDB RDS instances.
14194
+ * * The number of IP addresses in the IP address whitelist of the ApsaraDB RDS instance does not reach its upper limit. For more information, see [Configure a whitelist](https://help.aliyun.com/document_detail/43185.html).
14195
+ * If you set MultiAZPolicy for the scaling group that you want to create to COST_OPTIMIZED, the following rules apply:
14196
+ * * If you use OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, and SpotInstancePools to specify the instance allocation mode under the cost optimization policy, Auto Scaling will prioritize the implementation of the specified instance allocation mode during scale-out events.
14197
+ * * If you do not specify OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, or SpotInstancePools, Auto Scaling will preferentially create instances of the lowest-priced instance type based on the cost optimization policy.
14198
+ * If you set `Tags.Propagate` to true, the following rules will apply:
14183
14199
  * * Tags that you add to the scaling group cannot be propagated to existing instances in the scaling group. Tags that you add to the scaling group are propagated to only new instances.
14184
14200
  * * If you specify instance tags in the scaling configuration that is used to create instances and propagate the tags that you add to the scaling group to the instances, all tags exist at the same time.
14185
14201
  * * If the tag key that you specify in a scaling configuration and the tag key that you add to the scaling group of the scaling configuration are the same, the tag value that you specify in the scaling configuration is preferentially used.
@@ -14192,21 +14208,20 @@ class Client extends openapi_client_1.default {
14192
14208
  return await this.createScalingGroupWithOptions(request, runtime);
14193
14209
  }
14194
14210
  /**
14195
- * @summary Creates a scaling rule.
14211
+ * @summary 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.
14196
14212
  *
14197
- * @description ## Description
14198
- * A scaling rule defines a specific scaling activity, such as adding or removing N instances. If the number of Elastic Compute Service (ECS) instances in a scaling group is less than the minimum number allowed or greater than the maximum number allowed after a scaling rule is executed, Auto Scaling adjusts the number of ECS instances that you want to add or remove. This way, the number of ECS instances can be maintained within the valid range after the scaling rule is executed. The number of ECS instances that is specified in the scaling rule remains unchanged. Example:
14199
- * * If your scaling group contains two ECS instances and allows up to three ECS instances, only one ECS instance is added to your scaling group after you execute a scale-out rule in which three ECS instances are specified. The number of ECS instances that is specified in the scaling rule remains unchanged.
14200
- * * If your scaling group contains three ECS instances and requires at least two ECS instances, only one ECS instance is removed from your scaling group after you execute a scale-in rule in which five ECS instances are specified. The number of ECS instances that is specified in the scaling rule remains unchanged.
14213
+ * @description 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:
14214
+ * * 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.
14215
+ * * 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.
14201
14216
  * Before you call this operation, take note of the following items:
14202
- * * If you set the AdjustmentType parameter to TotalCapacity, the number of ECS instances in the scaling group is adjusted to the specified value. The value of the AdjustmentValue parameter must be greater than or equal to 0.
14203
- * * If you set the AdjustmentType parameter to QuantityChangeInCapacity or PercentChangeInCapacity, a positive value of AdjustmentValue specifies the number of ECS instances that are added to the scaling group, and a negative value of AdjustmentValue specifies the number of ECS instances that are removed from the scaling group.
14204
- * * If you set the AdjustmentType parameter to PercentChangeInCapacity, Auto Scaling uses the following formula to calculate a value, and then rounds the value to the nearest integer to obtain the number of ECS instances that need to be scaled: Value of TotalCapacity × Value of AdjustmentValue/100.
14205
- * * If the cooldown time is specified in a scaling rule, the specified time applies to the scaling group after the rule is executed. Otherwise, the value of the DefaultCooldown parameter of the scaling group applies to the scaling group.
14206
- * * You can create only a limited number of scaling rules for a scaling group. For more information, see the "Limits" topic.
14207
- * * The unique identifier (ScalingRuleAri) of a scaling rule can be used by the following operations:
14208
- * * ExecuteScalingRule: You can call this operation to manually execute a specific scaling rule by setting the ScalingRuleAri parameter to the unique identifier of the scaling rule.
14209
- * * CreateScheduledTask: You can call this operation to create a scheduled task for a specific scaling rule by setting the ScheduledAction parameter to the unique identifier of the scaling rule.
14217
+ * * 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.
14218
+ * * 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.
14219
+ * * 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.
14220
+ * * 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.
14221
+ * * 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).
14222
+ * * The following API operations may use the unique identifier of a scaling rule (ScalingRuleAri) that is returned after you call the CreateScalingRule operation:
14223
+ * * 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.
14224
+ * * 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.
14210
14225
  *
14211
14226
  * @param request CreateScalingRuleRequest
14212
14227
  * @param runtime runtime options for this request RuntimeOptions
@@ -14304,21 +14319,20 @@ class Client extends openapi_client_1.default {
14304
14319
  return $tea.cast(await this.callApi(params, req, runtime), new CreateScalingRuleResponse({}));
14305
14320
  }
14306
14321
  /**
14307
- * @summary Creates a scaling rule.
14322
+ * @summary 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.
14308
14323
  *
14309
- * @description ## Description
14310
- * A scaling rule defines a specific scaling activity, such as adding or removing N instances. If the number of Elastic Compute Service (ECS) instances in a scaling group is less than the minimum number allowed or greater than the maximum number allowed after a scaling rule is executed, Auto Scaling adjusts the number of ECS instances that you want to add or remove. This way, the number of ECS instances can be maintained within the valid range after the scaling rule is executed. The number of ECS instances that is specified in the scaling rule remains unchanged. Example:
14311
- * * If your scaling group contains two ECS instances and allows up to three ECS instances, only one ECS instance is added to your scaling group after you execute a scale-out rule in which three ECS instances are specified. The number of ECS instances that is specified in the scaling rule remains unchanged.
14312
- * * If your scaling group contains three ECS instances and requires at least two ECS instances, only one ECS instance is removed from your scaling group after you execute a scale-in rule in which five ECS instances are specified. The number of ECS instances that is specified in the scaling rule remains unchanged.
14324
+ * @description 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:
14325
+ * * 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.
14326
+ * * 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.
14313
14327
  * Before you call this operation, take note of the following items:
14314
- * * If you set the AdjustmentType parameter to TotalCapacity, the number of ECS instances in the scaling group is adjusted to the specified value. The value of the AdjustmentValue parameter must be greater than or equal to 0.
14315
- * * If you set the AdjustmentType parameter to QuantityChangeInCapacity or PercentChangeInCapacity, a positive value of AdjustmentValue specifies the number of ECS instances that are added to the scaling group, and a negative value of AdjustmentValue specifies the number of ECS instances that are removed from the scaling group.
14316
- * * If you set the AdjustmentType parameter to PercentChangeInCapacity, Auto Scaling uses the following formula to calculate a value, and then rounds the value to the nearest integer to obtain the number of ECS instances that need to be scaled: Value of TotalCapacity × Value of AdjustmentValue/100.
14317
- * * If the cooldown time is specified in a scaling rule, the specified time applies to the scaling group after the rule is executed. Otherwise, the value of the DefaultCooldown parameter of the scaling group applies to the scaling group.
14318
- * * You can create only a limited number of scaling rules for a scaling group. For more information, see the "Limits" topic.
14319
- * * The unique identifier (ScalingRuleAri) of a scaling rule can be used by the following operations:
14320
- * * ExecuteScalingRule: You can call this operation to manually execute a specific scaling rule by setting the ScalingRuleAri parameter to the unique identifier of the scaling rule.
14321
- * * CreateScheduledTask: You can call this operation to create a scheduled task for a specific scaling rule by setting the ScheduledAction parameter to the unique identifier of the scaling rule.
14328
+ * * 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.
14329
+ * * 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.
14330
+ * * 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.
14331
+ * * 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.
14332
+ * * 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).
14333
+ * * The following API operations may use the unique identifier of a scaling rule (ScalingRuleAri) that is returned after you call the CreateScalingRule operation:
14334
+ * * 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.
14335
+ * * 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.
14322
14336
  *
14323
14337
  * @param request CreateScalingRuleRequest
14324
14338
  * @return CreateScalingRuleResponse
@@ -14330,12 +14344,15 @@ class Client extends openapi_client_1.default {
14330
14344
  /**
14331
14345
  * @summary 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.
14332
14346
  *
14333
- * @description * If a scheduled task fails to trigger a scaling activity due to an ongoing scaling activity in a scaling group or because the scaling group is disabled, the scheduled task is automatically retried during the period that is specified by the LaunchExpirationTime parameter. If the scheduled task still fails to trigger a scaling activity after the period ends, the task is automatically skipped.
14334
- * * If multiple tasks are scheduled at similar points in time to trigger scaling activities in the same scaling group, the earliest task triggers the scaling activity first. Other tasks trigger scaling activities within their launch expiration time. Only one scaling activity can be triggered in a scaling group at a time.`` If the previous scaling activity is complete and another scheduled task attempts to trigger a scaling activity, Auto Scaling executes the scaling rule that is specified in the scheduled task and then triggers a scaling activity.``
14335
- * * A scheduled task supports the following scaling methods:
14336
- * * `ScheduledAction`: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
14337
- * * `ScalingGroupId`: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you created the scheduled task.
14338
- * > You cannot specify the `ScheduledAction` and ScalingGroupId parameters at the same time.
14347
+ * @description * 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.
14348
+ * * If several scheduled tasks concurrently attempt to execute the same scaling rule within a scaling group, the following rules apply:
14349
+ * * 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.
14350
+ * * 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.
14351
+ * * You can use one of the following methods to specify the scaling mode:
14352
+ * * ScheduledAction: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
14353
+ * * ScalingGroupId: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you create the scheduled task.
14354
+ * **
14355
+ * **Note** You cannot specify ScheduledAction and ScalingGroupId at the same time.
14339
14356
  *
14340
14357
  * @param request CreateScheduledTaskRequest
14341
14358
  * @param runtime runtime options for this request RuntimeOptions
@@ -14414,12 +14431,15 @@ class Client extends openapi_client_1.default {
14414
14431
  /**
14415
14432
  * @summary 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.
14416
14433
  *
14417
- * @description * If a scheduled task fails to trigger a scaling activity due to an ongoing scaling activity in a scaling group or because the scaling group is disabled, the scheduled task is automatically retried during the period that is specified by the LaunchExpirationTime parameter. If the scheduled task still fails to trigger a scaling activity after the period ends, the task is automatically skipped.
14418
- * * If multiple tasks are scheduled at similar points in time to trigger scaling activities in the same scaling group, the earliest task triggers the scaling activity first. Other tasks trigger scaling activities within their launch expiration time. Only one scaling activity can be triggered in a scaling group at a time.`` If the previous scaling activity is complete and another scheduled task attempts to trigger a scaling activity, Auto Scaling executes the scaling rule that is specified in the scheduled task and then triggers a scaling activity.``
14419
- * * A scheduled task supports the following scaling methods:
14420
- * * `ScheduledAction`: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
14421
- * * `ScalingGroupId`: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you created the scheduled task.
14422
- * > You cannot specify the `ScheduledAction` and ScalingGroupId parameters at the same time.
14434
+ * @description * 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.
14435
+ * * If several scheduled tasks concurrently attempt to execute the same scaling rule within a scaling group, the following rules apply:
14436
+ * * 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.
14437
+ * * 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.
14438
+ * * You can use one of the following methods to specify the scaling mode:
14439
+ * * ScheduledAction: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
14440
+ * * ScalingGroupId: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you create the scheduled task.
14441
+ * **
14442
+ * **Note** You cannot specify ScheduledAction and ScalingGroupId at the same time.
14423
14443
  *
14424
14444
  * @param request CreateScheduledTaskRequest
14425
14445
  * @return CreateScheduledTaskResponse
@@ -14588,11 +14608,11 @@ class Client extends openapi_client_1.default {
14588
14608
  return await this.deleteEciScalingConfigurationWithOptions(request, runtime);
14589
14609
  }
14590
14610
  /**
14591
- * @summary Deletes a lifecycle hook.
14611
+ * @summary 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.
14592
14612
  *
14593
- * @description If you delete a lifecycle hook that is in effect in a scaling group, instances exit the Pending state in advance. You can use one of the following methods to specify the lifecycle hooks that you want to delete:
14594
- * * Specify the scaling group ID of the lifecycle hook that you want to delete by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter.
14595
- * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. In this case, the ScalingGroupId parameter and the LifecycleHookName parameter are ignored.
14613
+ * @description 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:
14614
+ * * Include `LifecycleHookId` within your request to specify the lifecycle hook that you want to delete. In this case, `ScalingGroupId` and `LifecycleHookName` are ignored.
14615
+ * * Include `ScalingGroupId` and `LifecycleHookName` within your request to specify the lifecycle hook that you want to delete.
14596
14616
  *
14597
14617
  * @param request DeleteLifecycleHookRequest
14598
14618
  * @param runtime runtime options for this request RuntimeOptions
@@ -14639,11 +14659,11 @@ class Client extends openapi_client_1.default {
14639
14659
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteLifecycleHookResponse({}));
14640
14660
  }
14641
14661
  /**
14642
- * @summary Deletes a lifecycle hook.
14662
+ * @summary 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.
14643
14663
  *
14644
- * @description If you delete a lifecycle hook that is in effect in a scaling group, instances exit the Pending state in advance. You can use one of the following methods to specify the lifecycle hooks that you want to delete:
14645
- * * Specify the scaling group ID of the lifecycle hook that you want to delete by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter.
14646
- * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. In this case, the ScalingGroupId parameter and the LifecycleHookName parameter are ignored.
14664
+ * @description 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:
14665
+ * * Include `LifecycleHookId` within your request to specify the lifecycle hook that you want to delete. In this case, `ScalingGroupId` and `LifecycleHookName` are ignored.
14666
+ * * Include `ScalingGroupId` and `LifecycleHookName` within your request to specify the lifecycle hook that you want to delete.
14647
14667
  *
14648
14668
  * @param request DeleteLifecycleHookRequest
14649
14669
  * @return DeleteLifecycleHookResponse
@@ -15007,6 +15027,8 @@ class Client extends openapi_client_1.default {
15007
15027
  return await this.describeAlarmsWithOptions(request, runtime);
15008
15028
  }
15009
15029
  /**
15030
+ * @summary Queries the status of scaling activities that prompt text message or email notifications.
15031
+ *
15010
15032
  * @param request DescribeAlertConfigurationRequest
15011
15033
  * @param runtime runtime options for this request RuntimeOptions
15012
15034
  * @return DescribeAlertConfigurationResponse
@@ -15043,6 +15065,8 @@ class Client extends openapi_client_1.default {
15043
15065
  return $tea.cast(await this.callApi(params, req, runtime), new DescribeAlertConfigurationResponse({}));
15044
15066
  }
15045
15067
  /**
15068
+ * @summary Queries the status of scaling activities that prompt text message or email notifications.
15069
+ *
15046
15070
  * @param request DescribeAlertConfigurationRequest
15047
15071
  * @return DescribeAlertConfigurationResponse
15048
15072
  */
@@ -15051,7 +15075,7 @@ class Client extends openapi_client_1.default {
15051
15075
  return await this.describeAlertConfigurationWithOptions(request, runtime);
15052
15076
  }
15053
15077
  /**
15054
- * @summary Queries scaling configurations of the Elastic Container Instance type to learn the scaling configuration details. This allows you to select an appropriate template when you create elastic container instances. If you set OutputFormat to yaml, the output is a Kubernetes Deployment file in the YAML format.
15078
+ * @summary Queries the details of a scaling configuration. You can query a scaling configuration by its ID to learn about its details such as the temporary storage size, number of IPv6 addresses, and bandwidth of the elastic IP address (EIP). The scaling configuration details can be obtained as a YAML file.
15055
15079
  *
15056
15080
  * @param request DescribeEciScalingConfigurationDetailRequest
15057
15081
  * @param runtime runtime options for this request RuntimeOptions
@@ -15089,7 +15113,7 @@ class Client extends openapi_client_1.default {
15089
15113
  return $tea.cast(await this.callApi(params, req, runtime), new DescribeEciScalingConfigurationDetailResponse({}));
15090
15114
  }
15091
15115
  /**
15092
- * @summary Queries scaling configurations of the Elastic Container Instance type to learn the scaling configuration details. This allows you to select an appropriate template when you create elastic container instances. If you set OutputFormat to yaml, the output is a Kubernetes Deployment file in the YAML format.
15116
+ * @summary Queries the details of a scaling configuration. You can query a scaling configuration by its ID to learn about its details such as the temporary storage size, number of IPv6 addresses, and bandwidth of the elastic IP address (EIP). The scaling configuration details can be obtained as a YAML file.
15093
15117
  *
15094
15118
  * @param request DescribeEciScalingConfigurationDetailRequest
15095
15119
  * @return DescribeEciScalingConfigurationDetailResponse
@@ -15165,7 +15189,7 @@ class Client extends openapi_client_1.default {
15165
15189
  return await this.describeEciScalingConfigurationsWithOptions(request, runtime);
15166
15190
  }
15167
15191
  /**
15168
- * @summary Queries lifecycle actions.
15192
+ * @summary Queries the details of a lifecycle hook. If you want to query the details of a lifecycle hook, you can call the DescribeLifecycleActions operation. For example, you can query the execution status and ID of a lifecycle hook, along with the Elastic Compute Service (ECS) instances on which the lifecycle hook takes effect. When you call this operation, you can specify parameters such as ScalingActivityId, LifecycleActionToken, and MaxResults to query the details of a lifecycle hook.
15169
15193
  *
15170
15194
  * @description 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:
15171
15195
  * * 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.
@@ -15218,7 +15242,7 @@ class Client extends openapi_client_1.default {
15218
15242
  return $tea.cast(await this.callApi(params, req, runtime), new DescribeLifecycleActionsResponse({}));
15219
15243
  }
15220
15244
  /**
15221
- * @summary Queries lifecycle actions.
15245
+ * @summary Queries the details of a lifecycle hook. If you want to query the details of a lifecycle hook, you can call the DescribeLifecycleActions operation. For example, you can query the execution status and ID of a lifecycle hook, along with the Elastic Compute Service (ECS) instances on which the lifecycle hook takes effect. When you call this operation, you can specify parameters such as ScalingActivityId, LifecycleActionToken, and MaxResults to query the details of a lifecycle hook.
15222
15246
  *
15223
15247
  * @description 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:
15224
15248
  * * 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.
@@ -15234,7 +15258,7 @@ class Client extends openapi_client_1.default {
15234
15258
  return await this.describeLifecycleActionsWithOptions(request, runtime);
15235
15259
  }
15236
15260
  /**
15237
- * @summary Queries lifecycle hooks.
15261
+ * @summary Queries lifecycle hooks. If you want to check whether the configurations of your lifecycle hooks are correct or you want to query the details of multiple lifecycle hooks at the same time, you can call the DescribeLifecycleHooks operation. You can specify lifecycle hook IDs or scaling group IDs when you call this operation. This operation returns details such as the default actions, scaling activities, Alibaba Cloud Resource Names (ARNs) of notification recipients, and timeout periods of lifecycle hooks.
15238
15262
  *
15239
15263
  * @description You can use one of the following methods to query lifecycle hooks:
15240
15264
  * * 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.
@@ -15292,7 +15316,7 @@ class Client extends openapi_client_1.default {
15292
15316
  return $tea.cast(await this.callApi(params, req, runtime), new DescribeLifecycleHooksResponse({}));
15293
15317
  }
15294
15318
  /**
15295
- * @summary Queries lifecycle hooks.
15319
+ * @summary Queries lifecycle hooks. If you want to check whether the configurations of your lifecycle hooks are correct or you want to query the details of multiple lifecycle hooks at the same time, you can call the DescribeLifecycleHooks operation. You can specify lifecycle hook IDs or scaling group IDs when you call this operation. This operation returns details such as the default actions, scaling activities, Alibaba Cloud Resource Names (ARNs) of notification recipients, and timeout periods of lifecycle hooks.
15296
15320
  *
15297
15321
  * @description You can use one of the following methods to query lifecycle hooks:
15298
15322
  * * 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.
@@ -15349,7 +15373,7 @@ class Client extends openapi_client_1.default {
15349
15373
  return await this.describeLimitationWithOptions(request, runtime);
15350
15374
  }
15351
15375
  /**
15352
- * @summary Queries event notifications.
15376
+ * @summary Queries notifications. If you want to learn about a notification regarding the status of a scaling event or resource changes, you can call the DescribeNotificationConfigurations operation. This operation enables you to retrieve notification details, analyze resource change data, and refine scaling policies to efficiently utilize resources and fulfill business needs.
15353
15377
  *
15354
15378
  * @param request DescribeNotificationConfigurationsRequest
15355
15379
  * @param runtime runtime options for this request RuntimeOptions
@@ -15387,7 +15411,7 @@ class Client extends openapi_client_1.default {
15387
15411
  return $tea.cast(await this.callApi(params, req, runtime), new DescribeNotificationConfigurationsResponse({}));
15388
15412
  }
15389
15413
  /**
15390
- * @summary Queries event notifications.
15414
+ * @summary Queries notifications. If you want to learn about a notification regarding the status of a scaling event or resource changes, you can call the DescribeNotificationConfigurations operation. This operation enables you to retrieve notification details, analyze resource change data, and refine scaling policies to efficiently utilize resources and fulfill business needs.
15391
15415
  *
15392
15416
  * @param request DescribeNotificationConfigurationsRequest
15393
15417
  * @return DescribeNotificationConfigurationsResponse
@@ -15397,7 +15421,7 @@ class Client extends openapi_client_1.default {
15397
15421
  return await this.describeNotificationConfigurationsWithOptions(request, runtime);
15398
15422
  }
15399
15423
  /**
15400
- * @summary Queries notification types.
15424
+ * @summary Queries notification types. You can call the DescribeNotificationTypes operation to query the types of notifications on scaling events or resource changes occurred in your scaling groups. Notifications are triggered in scenarios such as successful scale-out events, successful scale-in events, expiration of scheduled tasks, and partially successful scale-out events.
15401
15425
  *
15402
15426
  * @param request DescribeNotificationTypesRequest
15403
15427
  * @param runtime runtime options for this request RuntimeOptions
@@ -15429,7 +15453,7 @@ class Client extends openapi_client_1.default {
15429
15453
  return $tea.cast(await this.callApi(params, req, runtime), new DescribeNotificationTypesResponse({}));
15430
15454
  }
15431
15455
  /**
15432
- * @summary Queries notification types.
15456
+ * @summary Queries notification types. You can call the DescribeNotificationTypes operation to query the types of notifications on scaling events or resource changes occurred in your scaling groups. Notifications are triggered in scenarios such as successful scale-out events, successful scale-in events, expiration of scheduled tasks, and partially successful scale-out events.
15433
15457
  *
15434
15458
  * @param request DescribeNotificationTypesRequest
15435
15459
  * @return DescribeNotificationTypesResponse
@@ -15597,7 +15621,7 @@ class Client extends openapi_client_1.default {
15597
15621
  return await this.describeScalingActivitiesWithOptions(request, runtime);
15598
15622
  }
15599
15623
  /**
15600
- * @summary Queries the details about a scaling activity.
15624
+ * @summary Queries the details of a scaling activity. The DescribeScalingActivityDetail operation enables you to access and monitor the details of a scaling activity, which is beneficial for troubleshooting and performance analysis purposes.
15601
15625
  *
15602
15626
  * @param request DescribeScalingActivityDetailRequest
15603
15627
  * @param runtime runtime options for this request RuntimeOptions
@@ -15635,7 +15659,7 @@ class Client extends openapi_client_1.default {
15635
15659
  return $tea.cast(await this.callApi(params, req, runtime), new DescribeScalingActivityDetailResponse({}));
15636
15660
  }
15637
15661
  /**
15638
- * @summary Queries the details about a scaling activity.
15662
+ * @summary Queries the details of a scaling activity. The DescribeScalingActivityDetail operation enables you to access and monitor the details of a scaling activity, which is beneficial for troubleshooting and performance analysis purposes.
15639
15663
  *
15640
15664
  * @param request DescribeScalingActivityDetailRequest
15641
15665
  * @return DescribeScalingActivityDetailResponse
@@ -15834,7 +15858,7 @@ class Client extends openapi_client_1.default {
15834
15858
  return await this.describeScalingGroupsWithOptions(request, runtime);
15835
15859
  }
15836
15860
  /**
15837
- * @summary Queries the Elastic Compute Service (ECS) instances in a scaling group
15861
+ * @summary Queries the Elastic Compute Service (ECS) instances in a scaling group. If you want to flexibly filter ECS instances that meet the specified criteria and query the instance details, you can call the DescribeScalingInstances operation. This operation enables you to input custom parameters for precise query of ECS instances, helping you gain a clear understanding of the instance details and optimize scaling configurations.
15838
15862
  *
15839
15863
  * @param request DescribeScalingInstancesRequest
15840
15864
  * @param runtime runtime options for this request RuntimeOptions
@@ -15908,7 +15932,7 @@ class Client extends openapi_client_1.default {
15908
15932
  return $tea.cast(await this.callApi(params, req, runtime), new DescribeScalingInstancesResponse({}));
15909
15933
  }
15910
15934
  /**
15911
- * @summary Queries the Elastic Compute Service (ECS) instances in a scaling group
15935
+ * @summary Queries the Elastic Compute Service (ECS) instances in a scaling group. If you want to flexibly filter ECS instances that meet the specified criteria and query the instance details, you can call the DescribeScalingInstances operation. This operation enables you to input custom parameters for precise query of ECS instances, helping you gain a clear understanding of the instance details and optimize scaling configurations.
15912
15936
  *
15913
15937
  * @param request DescribeScalingInstancesRequest
15914
15938
  * @return DescribeScalingInstancesResponse
@@ -15997,7 +16021,7 @@ class Client extends openapi_client_1.default {
15997
16021
  return await this.describeScalingRulesWithOptions(request, runtime);
15998
16022
  }
15999
16023
  /**
16000
- * @summary Queries scheduled tasks.
16024
+ * @summary 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.
16001
16025
  *
16002
16026
  * @description You can query scheduled tasks by scaling rule, task ID, or task name.
16003
16027
  *
@@ -16020,6 +16044,12 @@ class Client extends openapi_client_1.default {
16020
16044
  if (!tea_util_1.default.isUnset(request.pageSize)) {
16021
16045
  query["PageSize"] = request.pageSize;
16022
16046
  }
16047
+ if (!tea_util_1.default.isUnset(request.recurrenceType)) {
16048
+ query["RecurrenceType"] = request.recurrenceType;
16049
+ }
16050
+ if (!tea_util_1.default.isUnset(request.recurrenceValue)) {
16051
+ query["RecurrenceValue"] = request.recurrenceValue;
16052
+ }
16023
16053
  if (!tea_util_1.default.isUnset(request.regionId)) {
16024
16054
  query["RegionId"] = request.regionId;
16025
16055
  }
@@ -16041,6 +16071,12 @@ class Client extends openapi_client_1.default {
16041
16071
  if (!tea_util_1.default.isUnset(request.scheduledTaskNames)) {
16042
16072
  query["ScheduledTaskNames"] = request.scheduledTaskNames;
16043
16073
  }
16074
+ if (!tea_util_1.default.isUnset(request.taskEnabled)) {
16075
+ query["TaskEnabled"] = request.taskEnabled;
16076
+ }
16077
+ if (!tea_util_1.default.isUnset(request.taskName)) {
16078
+ query["TaskName"] = request.taskName;
16079
+ }
16044
16080
  let req = new $OpenApi.OpenApiRequest({
16045
16081
  query: openapi_util_1.default.query(query),
16046
16082
  });
@@ -16058,7 +16094,7 @@ class Client extends openapi_client_1.default {
16058
16094
  return $tea.cast(await this.callApi(params, req, runtime), new DescribeScheduledTasksResponse({}));
16059
16095
  }
16060
16096
  /**
16061
- * @summary Queries scheduled tasks.
16097
+ * @summary 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.
16062
16098
  *
16063
16099
  * @description You can query scheduled tasks by scaling rule, task ID, or task name.
16064
16100
  *
@@ -16187,16 +16223,18 @@ class Client extends openapi_client_1.default {
16187
16223
  return await this.detachDBInstancesWithOptions(request, runtime);
16188
16224
  }
16189
16225
  /**
16190
- * @summary Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
16226
+ * @summary 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.
16191
16227
  *
16192
- * @description After ECS instances or elastic container instances are removed from a scaling group, you can call the AttachInstances operation to add the ECS instances or elastic container instances that are removed from the scaling group to other scaling groups.
16193
- * After you remove an ECS instance or elastic container instance by calling the DetachInstances operation, the instance is not stopped or released.
16194
- * Before you call this operation, make sure that the following conditions are met:
16195
- * * The specified scaling group is enabled.
16196
- * * No scaling activities in the specified scaling group are in progress.
16197
- * > If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
16198
- * A successful call indicates only 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 the ScalingActivityId parameter in the response.
16199
- * The number of ECS instances or elastic container instances in a scaling group after you remove a specific number of instances from the scaling group must be equal to or greater than the value of the MinSize parameter. Otherwise, an error is reported when you call the DetachInstances operation.
16228
+ * @description * Before you call the DetachInstances operation, make sure that the following conditions are met:
16229
+ * * The specified scaling group is enabled.
16230
+ * * The specified scaling group does not have any ongoing scaling activities.
16231
+ * **
16232
+ * **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.
16233
+ * * Before you call this operation, take note of the following items:
16234
+ * * 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.
16235
+ * * 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.
16236
+ * * 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.
16237
+ * * 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.
16200
16238
  *
16201
16239
  * @param request DetachInstancesRequest
16202
16240
  * @param runtime runtime options for this request RuntimeOptions
@@ -16255,16 +16293,18 @@ class Client extends openapi_client_1.default {
16255
16293
  return $tea.cast(await this.callApi(params, req, runtime), new DetachInstancesResponse({}));
16256
16294
  }
16257
16295
  /**
16258
- * @summary Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
16296
+ * @summary 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.
16259
16297
  *
16260
- * @description After ECS instances or elastic container instances are removed from a scaling group, you can call the AttachInstances operation to add the ECS instances or elastic container instances that are removed from the scaling group to other scaling groups.
16261
- * After you remove an ECS instance or elastic container instance by calling the DetachInstances operation, the instance is not stopped or released.
16262
- * Before you call this operation, make sure that the following conditions are met:
16263
- * * The specified scaling group is enabled.
16264
- * * No scaling activities in the specified scaling group are in progress.
16265
- * > If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
16266
- * A successful call indicates only 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 the ScalingActivityId parameter in the response.
16267
- * The number of ECS instances or elastic container instances in a scaling group after you remove a specific number of instances from the scaling group must be equal to or greater than the value of the MinSize parameter. Otherwise, an error is reported when you call the DetachInstances operation.
16298
+ * @description * Before you call the DetachInstances operation, make sure that the following conditions are met:
16299
+ * * The specified scaling group is enabled.
16300
+ * * The specified scaling group does not have any ongoing scaling activities.
16301
+ * **
16302
+ * **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.
16303
+ * * Before you call this operation, take note of the following items:
16304
+ * * 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.
16305
+ * * 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.
16306
+ * * 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.
16307
+ * * 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.
16268
16308
  *
16269
16309
  * @param request DetachInstancesRequest
16270
16310
  * @return DetachInstancesResponse
@@ -16274,7 +16314,7 @@ class Client extends openapi_client_1.default {
16274
16314
  return await this.detachInstancesWithOptions(request, runtime);
16275
16315
  }
16276
16316
  /**
16277
- * @summary Detaches one or more Classic Load Balancer (CLB) instances from a scaling group.
16317
+ * @summary Detaches Classic Load Balancer (CLB, formerly known as Server Load Balancer or SLB) instances from a scaling group. If the current CLB instance no longer meets your business requirements, you can call the DetachLoadBalancers operation to detach it from your scaling group. When you call this operation, you can use ScalingGroupId, LoadBalancer.N, and ForceDetach to specify one or more CLB instances to detach. You can also determine whether to call this operation asynchronously and whether to remove the Elastic Compute Service (ECS) instances acting as backend servers from the backend server groups of the CLB instance. You can call this operation to detach only CLB instances from a scaling group.
16278
16318
  *
16279
16319
  * @param request DetachLoadBalancersRequest
16280
16320
  * @param runtime runtime options for this request RuntimeOptions
@@ -16324,7 +16364,7 @@ class Client extends openapi_client_1.default {
16324
16364
  return $tea.cast(await this.callApi(params, req, runtime), new DetachLoadBalancersResponse({}));
16325
16365
  }
16326
16366
  /**
16327
- * @summary Detaches one or more Classic Load Balancer (CLB) instances from a scaling group.
16367
+ * @summary Detaches Classic Load Balancer (CLB, formerly known as Server Load Balancer or SLB) instances from a scaling group. If the current CLB instance no longer meets your business requirements, you can call the DetachLoadBalancers operation to detach it from your scaling group. When you call this operation, you can use ScalingGroupId, LoadBalancer.N, and ForceDetach to specify one or more CLB instances to detach. You can also determine whether to call this operation asynchronously and whether to remove the Elastic Compute Service (ECS) instances acting as backend servers from the backend server groups of the CLB instance. You can call this operation to detach only CLB instances from a scaling group.
16328
16368
  *
16329
16369
  * @param request DetachLoadBalancersRequest
16330
16370
  * @return DetachLoadBalancersResponse
@@ -16773,7 +16813,7 @@ class Client extends openapi_client_1.default {
16773
16813
  return await this.enterStandbyWithOptions(request, runtime);
16774
16814
  }
16775
16815
  /**
16776
- * @summary Executes a scaling rule.
16816
+ * @summary 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.
16777
16817
  *
16778
16818
  * @description Before you call this operation, take note of the following items:
16779
16819
  * * The scaling group is in the Active state.
@@ -16835,7 +16875,7 @@ class Client extends openapi_client_1.default {
16835
16875
  return $tea.cast(await this.callApi(params, req, runtime), new ExecuteScalingRuleResponse({}));
16836
16876
  }
16837
16877
  /**
16838
- * @summary Executes a scaling rule.
16878
+ * @summary 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.
16839
16879
  *
16840
16880
  * @description Before you call this operation, take note of the following items:
16841
16881
  * * The scaling group is in the Active state.
@@ -16854,10 +16894,13 @@ class Client extends openapi_client_1.default {
16854
16894
  return await this.executeScalingRuleWithOptions(request, runtime);
16855
16895
  }
16856
16896
  /**
16857
- * @summary Moves an Elastic Compute Service (ECS) instance out of the Standby state.
16897
+ * @summary 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.
16858
16898
  *
16859
- * @description ## Description
16860
- * If your scaling group is associated with a Classic Load Balancer (CLB) instance and you move an ECS instance in your scaling group out of the Standby state, the weight of the ECS instance is reset to the value that is specified in the scaling configuration of your scaling group.
16899
+ * @description After ECS instances or elastic container instances are removed from the Standby state, the following rules apply:
16900
+ * * The ECS instances or elastic container instances enter the In Service state.
16901
+ * * The default weight of each ECS instance or elastic container instance as a backend server of the attached load balancer is 50.
16902
+ * * If you stop or restart the ECS instances or elastic container instances, the health check status of the instances will be updated.
16903
+ * * When a scale-in event is triggered, Auto Scaling may remove the ECS instances or elastic container instances from the scaling group.
16861
16904
  *
16862
16905
  * @param request ExitStandbyRequest
16863
16906
  * @param runtime runtime options for this request RuntimeOptions
@@ -16904,10 +16947,13 @@ class Client extends openapi_client_1.default {
16904
16947
  return $tea.cast(await this.callApi(params, req, runtime), new ExitStandbyResponse({}));
16905
16948
  }
16906
16949
  /**
16907
- * @summary Moves an Elastic Compute Service (ECS) instance out of the Standby state.
16950
+ * @summary 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.
16908
16951
  *
16909
- * @description ## Description
16910
- * If your scaling group is associated with a Classic Load Balancer (CLB) instance and you move an ECS instance in your scaling group out of the Standby state, the weight of the ECS instance is reset to the value that is specified in the scaling configuration of your scaling group.
16952
+ * @description After ECS instances or elastic container instances are removed from the Standby state, the following rules apply:
16953
+ * * The ECS instances or elastic container instances enter the In Service state.
16954
+ * * The default weight of each ECS instance or elastic container instance as a backend server of the attached load balancer is 50.
16955
+ * * If you stop or restart the ECS instances or elastic container instances, the health check status of the instances will be updated.
16956
+ * * When a scale-in event is triggered, Auto Scaling may remove the ECS instances or elastic container instances from the scaling group.
16911
16957
  *
16912
16958
  * @param request ExitStandbyRequest
16913
16959
  * @return ExitStandbyResponse
@@ -17196,6 +17242,8 @@ class Client extends openapi_client_1.default {
17196
17242
  return await this.modifyAlarmWithOptions(request, runtime);
17197
17243
  }
17198
17244
  /**
17245
+ * @summary Sets the status of scaling activities that prompt text message or email notifications.
17246
+ *
17199
17247
  * @param request ModifyAlertConfigurationRequest
17200
17248
  * @param runtime runtime options for this request RuntimeOptions
17201
17249
  * @return ModifyAlertConfigurationResponse
@@ -17235,6 +17283,8 @@ class Client extends openapi_client_1.default {
17235
17283
  return $tea.cast(await this.callApi(params, req, runtime), new ModifyAlertConfigurationResponse({}));
17236
17284
  }
17237
17285
  /**
17286
+ * @summary Sets the status of scaling activities that prompt text message or email notifications.
17287
+ *
17238
17288
  * @param request ModifyAlertConfigurationRequest
17239
17289
  * @return ModifyAlertConfigurationResponse
17240
17290
  */
@@ -17487,11 +17537,11 @@ class Client extends openapi_client_1.default {
17487
17537
  return await this.modifyInstanceAttributeWithOptions(request, runtime);
17488
17538
  }
17489
17539
  /**
17490
- * @summary Modifies a lifecycle hook.
17540
+ * @summary 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.
17491
17541
  *
17492
- * @description You can use one of the following methods to specify the lifecycle hook that you want to modify:
17493
- * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. When you use this method, the ScalingGroupId and LifecycleHookName parameters are ignored.
17494
- * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter.
17542
+ * @description You can use one of the following methods to locate the lifecycle hook that you want to modify:
17543
+ * * Specify LifecycleHookId. In this case, ScalingGroupId and LifecycleHookName are ignored.
17544
+ * * Specify ScalingGroupId and LifecycleHookName. Each lifecycle hook within a scaling group has a unique name.
17495
17545
  *
17496
17546
  * @param request ModifyLifecycleHookRequest
17497
17547
  * @param runtime runtime options for this request RuntimeOptions
@@ -17556,11 +17606,11 @@ class Client extends openapi_client_1.default {
17556
17606
  return $tea.cast(await this.callApi(params, req, runtime), new ModifyLifecycleHookResponse({}));
17557
17607
  }
17558
17608
  /**
17559
- * @summary Modifies a lifecycle hook.
17609
+ * @summary 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.
17560
17610
  *
17561
- * @description You can use one of the following methods to specify the lifecycle hook that you want to modify:
17562
- * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. When you use this method, the ScalingGroupId and LifecycleHookName parameters are ignored.
17563
- * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter.
17611
+ * @description You can use one of the following methods to locate the lifecycle hook that you want to modify:
17612
+ * * Specify LifecycleHookId. In this case, ScalingGroupId and LifecycleHookName are ignored.
17613
+ * * Specify ScalingGroupId and LifecycleHookName. Each lifecycle hook within a scaling group has a unique name.
17564
17614
  *
17565
17615
  * @param request ModifyLifecycleHookRequest
17566
17616
  * @return ModifyLifecycleHookResponse
@@ -17570,7 +17620,7 @@ class Client extends openapi_client_1.default {
17570
17620
  return await this.modifyLifecycleHookWithOptions(request, runtime);
17571
17621
  }
17572
17622
  /**
17573
- * @summary Modifies a notification.
17623
+ * @summary Modifies event notification rules. Event notification rules support automatic sending of notifications to CloudMonitor, Message Service (MNS) topics, or MNS queues when a specified type of events occur. This helps you learn about the dynamics of your scaling group at the earliest opportunity and further automate resource management. If an existing event notification rule does not meet your business requirements, you can call the ModifyNotificationConfiguration operation to modify the event notification rule, without the need to create a new rule. Take not that you cannot modify the notification method of an event notification rule by calling this operation.
17574
17624
  *
17575
17625
  * @param request ModifyNotificationConfigurationRequest
17576
17626
  * @param runtime runtime options for this request RuntimeOptions
@@ -17614,7 +17664,7 @@ class Client extends openapi_client_1.default {
17614
17664
  return $tea.cast(await this.callApi(params, req, runtime), new ModifyNotificationConfigurationResponse({}));
17615
17665
  }
17616
17666
  /**
17617
- * @summary Modifies a notification.
17667
+ * @summary Modifies event notification rules. Event notification rules support automatic sending of notifications to CloudMonitor, Message Service (MNS) topics, or MNS queues when a specified type of events occur. This helps you learn about the dynamics of your scaling group at the earliest opportunity and further automate resource management. If an existing event notification rule does not meet your business requirements, you can call the ModifyNotificationConfiguration operation to modify the event notification rule, without the need to create a new rule. Take not that you cannot modify the notification method of an event notification rule by calling this operation.
17618
17668
  *
17619
17669
  * @param request ModifyNotificationConfigurationRequest
17620
17670
  * @return ModifyNotificationConfigurationResponse
@@ -17730,6 +17780,9 @@ class Client extends openapi_client_1.default {
17730
17780
  if (!tea_util_1.default.isUnset(request.ownerId)) {
17731
17781
  query["OwnerId"] = request.ownerId;
17732
17782
  }
17783
+ if (!tea_util_1.default.isUnset(request.password)) {
17784
+ query["Password"] = request.password;
17785
+ }
17733
17786
  if (!tea_util_1.default.isUnset(request.passwordInherit)) {
17734
17787
  query["PasswordInherit"] = request.passwordInherit;
17735
17788
  }
@@ -17988,7 +18041,7 @@ class Client extends openapi_client_1.default {
17988
18041
  return await this.modifyScalingGroupWithOptions(request, runtime);
17989
18042
  }
17990
18043
  /**
17991
- * @summary Modifies a scaling rule.
18044
+ * @summary Modifies a scaling rule. If an existing scaling rule cannot meet your business requirements, you can call the ModifyScalingRule operation to modify the scaling rule, without the need to create a new one. This streamlines your workflow, enhancing operational efficiency while also contributing to cost optimization by avoiding redundant steps.
17992
18045
  *
17993
18046
  * @param request ModifyScalingRuleRequest
17994
18047
  * @param runtime runtime options for this request RuntimeOptions
@@ -18083,7 +18136,7 @@ class Client extends openapi_client_1.default {
18083
18136
  return $tea.cast(await this.callApi(params, req, runtime), new ModifyScalingRuleResponse({}));
18084
18137
  }
18085
18138
  /**
18086
- * @summary Modifies a scaling rule.
18139
+ * @summary Modifies a scaling rule. If an existing scaling rule cannot meet your business requirements, you can call the ModifyScalingRule operation to modify the scaling rule, without the need to create a new one. This streamlines your workflow, enhancing operational efficiency while also contributing to cost optimization by avoiding redundant steps.
18087
18140
  *
18088
18141
  * @param request ModifyScalingRuleRequest
18089
18142
  * @return ModifyScalingRuleResponse
@@ -18093,7 +18146,7 @@ class Client extends openapi_client_1.default {
18093
18146
  return await this.modifyScalingRuleWithOptions(request, runtime);
18094
18147
  }
18095
18148
  /**
18096
- * @summary Modifies a scheduled task.
18149
+ * @summary 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.
18097
18150
  *
18098
18151
  * @description You can use the following parameters to specify the scaling method of a scheduled task:
18099
18152
  * * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
@@ -18178,7 +18231,7 @@ class Client extends openapi_client_1.default {
18178
18231
  return $tea.cast(await this.callApi(params, req, runtime), new ModifyScheduledTaskResponse({}));
18179
18232
  }
18180
18233
  /**
18181
- * @summary Modifies a scheduled task.
18234
+ * @summary 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.
18182
18235
  *
18183
18236
  * @description You can use the following parameters to specify the scaling method of a scheduled task:
18184
18237
  * * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
@@ -18263,9 +18316,10 @@ class Client extends openapi_client_1.default {
18263
18316
  return await this.rebalanceInstancesWithOptions(request, runtime);
18264
18317
  }
18265
18318
  /**
18266
- * @summary Prolongs a lifecycle hook for Elastic Compute Service (ECS) instances.
18319
+ * @summary 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.
18267
18320
  *
18268
- * @description You can call this operation to prolong the length of a lifecycle hook up to 20 times. Take note that the total length of a lifecycle hook cannot exceed 6 hours.
18321
+ * @description You can call this operation only when the desired ECS instance enters a Pending state.\\
18322
+ * 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 a Pending state up to 20 times.
18269
18323
  *
18270
18324
  * @param request RecordLifecycleActionHeartbeatRequest
18271
18325
  * @param runtime runtime options for this request RuntimeOptions
@@ -18312,9 +18366,10 @@ class Client extends openapi_client_1.default {
18312
18366
  return $tea.cast(await this.callApi(params, req, runtime), new RecordLifecycleActionHeartbeatResponse({}));
18313
18367
  }
18314
18368
  /**
18315
- * @summary Prolongs a lifecycle hook for Elastic Compute Service (ECS) instances.
18369
+ * @summary 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.
18316
18370
  *
18317
- * @description You can call this operation to prolong the length of a lifecycle hook up to 20 times. Take note that the total length of a lifecycle hook cannot exceed 6 hours.
18371
+ * @description You can call this operation only when the desired ECS instance enters a Pending state.\\
18372
+ * 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 a Pending state up to 20 times.
18318
18373
  *
18319
18374
  * @param request RecordLifecycleActionHeartbeatRequest
18320
18375
  * @return RecordLifecycleActionHeartbeatResponse