@alicloud/ess20220222 1.3.2 → 1.4.1

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.d.ts CHANGED
@@ -1880,6 +1880,59 @@ export declare class DescribeNotificationTypesResponse extends $tea.Model {
1880
1880
  [key: string]: any;
1881
1881
  });
1882
1882
  }
1883
+ export declare class DescribePatternTypesRequest extends $tea.Model {
1884
+ architecture?: string[];
1885
+ burstablePerformance?: string;
1886
+ channelId?: number;
1887
+ cores?: number;
1888
+ coresList?: number[];
1889
+ excludedInstanceType?: string[];
1890
+ instanceFamilyLevel?: string;
1891
+ maxPrice?: number;
1892
+ memory?: number;
1893
+ memoryList?: number[];
1894
+ regionId?: string;
1895
+ spotStrategy?: string;
1896
+ vSwitchId?: string[];
1897
+ static names(): {
1898
+ [key: string]: string;
1899
+ };
1900
+ static types(): {
1901
+ [key: string]: any;
1902
+ };
1903
+ constructor(map?: {
1904
+ [key: string]: any;
1905
+ });
1906
+ }
1907
+ export declare class DescribePatternTypesResponseBody extends $tea.Model {
1908
+ patternTypes?: DescribePatternTypesResponseBodyPatternTypes[];
1909
+ requestId?: string;
1910
+ static names(): {
1911
+ [key: string]: string;
1912
+ };
1913
+ static types(): {
1914
+ [key: string]: any;
1915
+ };
1916
+ constructor(map?: {
1917
+ [key: string]: any;
1918
+ });
1919
+ }
1920
+ export declare class DescribePatternTypesResponse extends $tea.Model {
1921
+ headers?: {
1922
+ [key: string]: string;
1923
+ };
1924
+ statusCode?: number;
1925
+ body?: DescribePatternTypesResponseBody;
1926
+ static names(): {
1927
+ [key: string]: string;
1928
+ };
1929
+ static types(): {
1930
+ [key: string]: any;
1931
+ };
1932
+ constructor(map?: {
1933
+ [key: string]: any;
1934
+ });
1935
+ }
1883
1936
  export declare class DescribeRegionsRequest extends $tea.Model {
1884
1937
  acceptLanguage?: string;
1885
1938
  ownerId?: number;
@@ -2444,6 +2497,7 @@ export declare class DetachInstancesRequest extends $tea.Model {
2444
2497
  clientToken?: string;
2445
2498
  decreaseDesiredCapacity?: boolean;
2446
2499
  detachOption?: string;
2500
+ ignoreInvalidInstance?: boolean;
2447
2501
  instanceIds?: string[];
2448
2502
  lifecycleHook?: boolean;
2449
2503
  ownerAccount?: string;
@@ -3832,6 +3886,7 @@ export declare class RecordLifecycleActionHeartbeatResponse extends $tea.Model {
3832
3886
  export declare class RemoveInstancesRequest extends $tea.Model {
3833
3887
  clientToken?: string;
3834
3888
  decreaseDesiredCapacity?: boolean;
3889
+ ignoreInvalidInstance?: boolean;
3835
3890
  instanceIds?: string[];
3836
3891
  ownerAccount?: string;
3837
3892
  ownerId?: number;
@@ -6227,6 +6282,22 @@ export declare class DescribeNotificationConfigurationsResponseBodyNotificationC
6227
6282
  [key: string]: any;
6228
6283
  });
6229
6284
  }
6285
+ export declare class DescribePatternTypesResponseBodyPatternTypes extends $tea.Model {
6286
+ cores?: number;
6287
+ instanceFamilyLevel?: string;
6288
+ instanceType?: string;
6289
+ instanceTypeFamily?: string;
6290
+ memory?: number;
6291
+ static names(): {
6292
+ [key: string]: string;
6293
+ };
6294
+ static types(): {
6295
+ [key: string]: any;
6296
+ };
6297
+ constructor(map?: {
6298
+ [key: string]: any;
6299
+ });
6300
+ }
6230
6301
  export declare class DescribeRegionsResponseBodyRegions extends $tea.Model {
6231
6302
  classicUnavailable?: boolean;
6232
6303
  localName?: string;
@@ -8051,905 +8122,1875 @@ export default class Client extends OpenApi {
8051
8122
  getEndpoint(productId: string, regionId: string, endpointRule: string, network: string, suffix: string, endpointMap: {
8052
8123
  [key: string]: string;
8053
8124
  }, endpoint: string): string;
8125
+ /**
8126
+ * @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.
8127
+ *
8128
+ * @description You can manage scaling configurations of the Elastic Container Instance type by using a YAML configuration file based on the following logic:
8129
+ * 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.
8130
+ *
8131
+ * @param request ApplyEciScalingConfigurationRequest
8132
+ * @param runtime runtime options for this request RuntimeOptions
8133
+ * @return ApplyEciScalingConfigurationResponse
8134
+ */
8054
8135
  applyEciScalingConfigurationWithOptions(request: ApplyEciScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ApplyEciScalingConfigurationResponse>;
8136
+ /**
8137
+ * @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.
8138
+ *
8139
+ * @description You can manage scaling configurations of the Elastic Container Instance type by using a YAML configuration file based on the following logic:
8140
+ * 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.
8141
+ *
8142
+ * @param request ApplyEciScalingConfigurationRequest
8143
+ * @return ApplyEciScalingConfigurationResponse
8144
+ */
8055
8145
  applyEciScalingConfiguration(request: ApplyEciScalingConfigurationRequest): Promise<ApplyEciScalingConfigurationResponse>;
8146
+ /**
8147
+ * @summary 基于yaml配置进行弹性伸缩管理
8148
+ *
8149
+ * @description You can call the ApplyScalingGroup operation to create scaling groups of the Elastic Container Instance type with ease. The resources of the scaling groups are defined in Kubernetes Deployment YAML files. You can also call this operation to extend annotations for elastic container instances in Kubernetes Deployment YAML files. For more information, see "Supported annotations" in this topic.
8150
+ * Mapping between YAML files and scaling groups: You can map the triplet of namespace, kind, and name in a YAML file to a scaling group name. A YAML file and a scaling group have a one-to-one mapping relationship in a region. For example, if you use the Kubernetes Deployment YAML file whose name is NGINX in the default namespace to create a scaling group in a region, the unique name of the mapped scaling group is k8s_default_Deployment_nginx.
8151
+ * You can use a Kubernetes Deployment YAML file to manage a scaling group based on the following logic:
8152
+ * * If an existing scaling group has a mapping relationship with your Kubernetes Deployment YAML file, you can update the scaling group by using the YAML file.
8153
+ * * If no scaling group that has a mapping relationship with your Kubernetes Deployment YAML file exists, you can create a scaling group with ease by using the YAML file.
8154
+ * ### Precautions
8155
+ * 1. If you do not specify a virtual private cloud (VPC), vSwitch, security group, or annotation in your Kubernetes Deployment YAML file, the system creates a default VPC that has default vSwitches and uses the default security group ess-default-sg of Auto Scaling. By default, the security group rule allows traffic on Transmission Control Protocol (TCP)-based port 22 and port 3389 and enables Internet Control Message Protocol (ICMP) for IPv4 addresses. If you want to enable other ports or protocols, you can create custom security group rules.
8156
+ * 2. If you want to use a public image, you must enable the Internet access feature and configure the k8s.aliyun.com/eci-with-eip pod annotation to enable the elastic IP address (EIP) feature.
8157
+ * 3. After you call the ApplyScalingGroup operation to apply a Kubernetes Deployment YAML file, the scaling group immediately enters the Enabled state and the scaling configuration immediately enters the Active state. If the number of replicas that you specified in the YAML file is grater than 0, elastic container instances are automatically created.
8158
+ * ### Supported annotations
8159
+ * For more information about annotations, see [ECI Pod Annotation](https://help.aliyun.com/document_detail/186939.html).
8160
+ * |Annotation|Example|Description|
8161
+ * |---|---|---|
8162
+ * |k8s.aliyun.com/ess-scaling-group-min-size|1|The minimum size of the scaling group that you want to create. Default value: 0.|
8163
+ * |k8s.aliyun.com/ess-scaling-group-max-size|20|The maximum size of the scaling group that you want to create. Default value: maximum number of replicas or 30, whichever is greater.|
8164
+ * |k8s.aliyun.com/eci-ntp-server|100.100.*.*|The IP address of the Network Time Protocol (NTP) server.|
8165
+ * |k8s.aliyun.com/eci-use-specs|2-4Gi|The specifications of 2 vCPUs and 4 GB memory. For more information, see [Create pods by specifying multiple specifications](https://help.aliyun.com/document_detail/451267.html).|
8166
+ * |k8s.aliyun.com/eci-vswitch|vsw-bp1xpiowfm5vo8o3c\\*\\*\\*\\*|The ID of the vSwitch. You can specify multiple vSwitches to specify multiple zones.|
8167
+ * |k8s.aliyun.com/eci-security-group|sg-bp1dktddjsg5nktv\\*\\*\\*\\*|The ID of the security group. Before you configure this annotation, take note of the following requirements:<ul data-sourcepos="26:74-26:168"><li data-sourcepos="26:78-26:114">You can specify one or more security groups. You can specify up to five security groups for each scaling group.</li><li data-sourcepos="26:114-26:140">If you specify multiple security groups, the security groups must belong to the same VPC.</li><li data-sourcepos="26:140-26:163">If you specify multiple security groups, the security groups must be of the same type.</li></ul>|
8168
+ * |k8s.aliyun.com/eci-sls-enable|"false"|If you set the value to false, the log collection feature is disabled.
8169
+ * If you do not want to use Custom Resource Definition (CRD) for Simple Log Service to collect logs of specific pods, you can configure this annotation for the pods and set the value to false. This prevents resource wastes caused by Logtails created by the system.|
8170
+ * |k8s.aliyun.com/eci-spot-strategy|SpotAsPriceGo|The bidding policy for the preemptible instance. Valid values:<ul data-sourcepos="28:69-28:204"><li data-sourcepos="28:73-28:158">SpotWithPriceLimit: The instance is created as a preemptible instance for which you specify the maximum hourly price If you set the value to SpotWithPriceLimit, you must configure the k8s.aliyun.com/eci-spot-price-limit annotation.</li><li data-sourcepos="28:158-28:199">SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is used as the bid price.</li></ul>|
8171
+ * |k8s.aliyun.com/eci-spot-price-limit|"0.5"|The maximum hourly price of the preemptible instance. This value can be accurate to up to three decimal places.
8172
+ * This annotation takes effect only when you set the k8s.aliyun.com/eci-spot-strategy annotation to SpotWithPriceLimit.|
8173
+ * |k8s.aliyun.com/eci-with-eip|"true"|If you set the value to true, an EIP is automatically created and bound to each elastic container instance.|
8174
+ * |k8s.aliyun.com/eci-data-cache-bucket|default|The bucket of the specified DataCache. If you want to use a DataCache to create a pod, you must configure this annotation.|
8175
+ * |k8s.aliyun.com/eci-data-cache-pl|PL1|The performance level (PL) of the cloud disk that you want to create by using the specified DataCache.
8176
+ * By default, enhanced SSDs (ESSDs) are created. Default value: PL1.|
8177
+ * |k8s.aliyun.com/eci-data-cache-provisionedIops|"40000"|The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50000, 1000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. For more information, see [ESSD AutoPL](https://help.aliyun.com/document_detail/368372.html).
8178
+ * If you configure this annotation, the cloud disk that is created by using the specified DataCache is of the ESSD AutoPL type.|
8179
+ * |k8s.aliyun.com/eci-data-cache-burstingEnabled|"true"|Specifies whether the Burst feature is enabled for the ESSD AutoPL disk. For more information, see [ESSD AutoPL](https://help.aliyun.com/document_detail/368372.html).
8180
+ * If you configure this annotation, the cloud disk that is created by using the specified DataCache is of the ESSD AutoPL type.|
8181
+ * |k8s.aliyun.com/eci-custom-tags|"env:test,name:alice"|The tags that you want to add to each elastic container instance. You can add up to three tags for each elastic container instance. Separate a tag key and a tag value with a colon (:). Separate multiple tags with commas (,).|
8182
+ *
8183
+ * @param request ApplyScalingGroupRequest
8184
+ * @param runtime runtime options for this request RuntimeOptions
8185
+ * @return ApplyScalingGroupResponse
8186
+ */
8056
8187
  applyScalingGroupWithOptions(request: ApplyScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<ApplyScalingGroupResponse>;
8188
+ /**
8189
+ * @summary 基于yaml配置进行弹性伸缩管理
8190
+ *
8191
+ * @description You can call the ApplyScalingGroup operation to create scaling groups of the Elastic Container Instance type with ease. The resources of the scaling groups are defined in Kubernetes Deployment YAML files. You can also call this operation to extend annotations for elastic container instances in Kubernetes Deployment YAML files. For more information, see "Supported annotations" in this topic.
8192
+ * Mapping between YAML files and scaling groups: You can map the triplet of namespace, kind, and name in a YAML file to a scaling group name. A YAML file and a scaling group have a one-to-one mapping relationship in a region. For example, if you use the Kubernetes Deployment YAML file whose name is NGINX in the default namespace to create a scaling group in a region, the unique name of the mapped scaling group is k8s_default_Deployment_nginx.
8193
+ * You can use a Kubernetes Deployment YAML file to manage a scaling group based on the following logic:
8194
+ * * If an existing scaling group has a mapping relationship with your Kubernetes Deployment YAML file, you can update the scaling group by using the YAML file.
8195
+ * * If no scaling group that has a mapping relationship with your Kubernetes Deployment YAML file exists, you can create a scaling group with ease by using the YAML file.
8196
+ * ### Precautions
8197
+ * 1. If you do not specify a virtual private cloud (VPC), vSwitch, security group, or annotation in your Kubernetes Deployment YAML file, the system creates a default VPC that has default vSwitches and uses the default security group ess-default-sg of Auto Scaling. By default, the security group rule allows traffic on Transmission Control Protocol (TCP)-based port 22 and port 3389 and enables Internet Control Message Protocol (ICMP) for IPv4 addresses. If you want to enable other ports or protocols, you can create custom security group rules.
8198
+ * 2. If you want to use a public image, you must enable the Internet access feature and configure the k8s.aliyun.com/eci-with-eip pod annotation to enable the elastic IP address (EIP) feature.
8199
+ * 3. After you call the ApplyScalingGroup operation to apply a Kubernetes Deployment YAML file, the scaling group immediately enters the Enabled state and the scaling configuration immediately enters the Active state. If the number of replicas that you specified in the YAML file is grater than 0, elastic container instances are automatically created.
8200
+ * ### Supported annotations
8201
+ * For more information about annotations, see [ECI Pod Annotation](https://help.aliyun.com/document_detail/186939.html).
8202
+ * |Annotation|Example|Description|
8203
+ * |---|---|---|
8204
+ * |k8s.aliyun.com/ess-scaling-group-min-size|1|The minimum size of the scaling group that you want to create. Default value: 0.|
8205
+ * |k8s.aliyun.com/ess-scaling-group-max-size|20|The maximum size of the scaling group that you want to create. Default value: maximum number of replicas or 30, whichever is greater.|
8206
+ * |k8s.aliyun.com/eci-ntp-server|100.100.*.*|The IP address of the Network Time Protocol (NTP) server.|
8207
+ * |k8s.aliyun.com/eci-use-specs|2-4Gi|The specifications of 2 vCPUs and 4 GB memory. For more information, see [Create pods by specifying multiple specifications](https://help.aliyun.com/document_detail/451267.html).|
8208
+ * |k8s.aliyun.com/eci-vswitch|vsw-bp1xpiowfm5vo8o3c\\*\\*\\*\\*|The ID of the vSwitch. You can specify multiple vSwitches to specify multiple zones.|
8209
+ * |k8s.aliyun.com/eci-security-group|sg-bp1dktddjsg5nktv\\*\\*\\*\\*|The ID of the security group. Before you configure this annotation, take note of the following requirements:<ul data-sourcepos="26:74-26:168"><li data-sourcepos="26:78-26:114">You can specify one or more security groups. You can specify up to five security groups for each scaling group.</li><li data-sourcepos="26:114-26:140">If you specify multiple security groups, the security groups must belong to the same VPC.</li><li data-sourcepos="26:140-26:163">If you specify multiple security groups, the security groups must be of the same type.</li></ul>|
8210
+ * |k8s.aliyun.com/eci-sls-enable|"false"|If you set the value to false, the log collection feature is disabled.
8211
+ * If you do not want to use Custom Resource Definition (CRD) for Simple Log Service to collect logs of specific pods, you can configure this annotation for the pods and set the value to false. This prevents resource wastes caused by Logtails created by the system.|
8212
+ * |k8s.aliyun.com/eci-spot-strategy|SpotAsPriceGo|The bidding policy for the preemptible instance. Valid values:<ul data-sourcepos="28:69-28:204"><li data-sourcepos="28:73-28:158">SpotWithPriceLimit: The instance is created as a preemptible instance for which you specify the maximum hourly price If you set the value to SpotWithPriceLimit, you must configure the k8s.aliyun.com/eci-spot-price-limit annotation.</li><li data-sourcepos="28:158-28:199">SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is used as the bid price.</li></ul>|
8213
+ * |k8s.aliyun.com/eci-spot-price-limit|"0.5"|The maximum hourly price of the preemptible instance. This value can be accurate to up to three decimal places.
8214
+ * This annotation takes effect only when you set the k8s.aliyun.com/eci-spot-strategy annotation to SpotWithPriceLimit.|
8215
+ * |k8s.aliyun.com/eci-with-eip|"true"|If you set the value to true, an EIP is automatically created and bound to each elastic container instance.|
8216
+ * |k8s.aliyun.com/eci-data-cache-bucket|default|The bucket of the specified DataCache. If you want to use a DataCache to create a pod, you must configure this annotation.|
8217
+ * |k8s.aliyun.com/eci-data-cache-pl|PL1|The performance level (PL) of the cloud disk that you want to create by using the specified DataCache.
8218
+ * By default, enhanced SSDs (ESSDs) are created. Default value: PL1.|
8219
+ * |k8s.aliyun.com/eci-data-cache-provisionedIops|"40000"|The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50000, 1000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. For more information, see [ESSD AutoPL](https://help.aliyun.com/document_detail/368372.html).
8220
+ * If you configure this annotation, the cloud disk that is created by using the specified DataCache is of the ESSD AutoPL type.|
8221
+ * |k8s.aliyun.com/eci-data-cache-burstingEnabled|"true"|Specifies whether the Burst feature is enabled for the ESSD AutoPL disk. For more information, see [ESSD AutoPL](https://help.aliyun.com/document_detail/368372.html).
8222
+ * If you configure this annotation, the cloud disk that is created by using the specified DataCache is of the ESSD AutoPL type.|
8223
+ * |k8s.aliyun.com/eci-custom-tags|"env:test,name:alice"|The tags that you want to add to each elastic container instance. You can add up to three tags for each elastic container instance. Separate a tag key and a tag value with a colon (:). Separate multiple tags with commas (,).|
8224
+ *
8225
+ * @param request ApplyScalingGroupRequest
8226
+ * @return ApplyScalingGroupResponse
8227
+ */
8057
8228
  applyScalingGroup(request: ApplyScalingGroupRequest): Promise<ApplyScalingGroupResponse>;
8058
8229
  /**
8059
- * Before you associate an ALB server group with a scaling group, make sure that the following requirements are met:
8060
- * * The scaling group resides in a virtual private cloud (VPC). The scaling group and the ALB server group must reside in the same VPC.
8061
- * * The ALB server group is in the Available state.
8062
- * * You can associate only a limited number of ALB server groups with a scaling group. To view the quota or manually request a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).
8063
- *
8064
- * @param request AttachAlbServerGroupsRequest
8065
- * @param runtime runtime options for this request RuntimeOptions
8066
- * @return AttachAlbServerGroupsResponse
8230
+ * @summary Associates Application Load Balancer (ALB) server groups with a scaling group.
8231
+ *
8232
+ * @description Before you associate an ALB server group with a scaling group, make sure that the following requirements are met:
8233
+ * * The scaling group resides in a virtual private cloud (VPC). The scaling group and the ALB server group must reside in the same VPC.
8234
+ * * The ALB server group is in the Available state.
8235
+ * * You can associate only a limited number of ALB server groups with a scaling group. To view the quota or manually request a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).
8236
+ *
8237
+ * @param request AttachAlbServerGroupsRequest
8238
+ * @param runtime runtime options for this request RuntimeOptions
8239
+ * @return AttachAlbServerGroupsResponse
8067
8240
  */
8068
8241
  attachAlbServerGroupsWithOptions(request: AttachAlbServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<AttachAlbServerGroupsResponse>;
8069
8242
  /**
8070
- * Before you associate an ALB server group with a scaling group, make sure that the following requirements are met:
8071
- * * The scaling group resides in a virtual private cloud (VPC). The scaling group and the ALB server group must reside in the same VPC.
8072
- * * The ALB server group is in the Available state.
8073
- * * You can associate only a limited number of ALB server groups with a scaling group. To view the quota or manually request a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).
8074
- *
8075
- * @param request AttachAlbServerGroupsRequest
8076
- * @return AttachAlbServerGroupsResponse
8243
+ * @summary Associates Application Load Balancer (ALB) server groups with a scaling group.
8244
+ *
8245
+ * @description Before you associate an ALB server group with a scaling group, make sure that the following requirements are met:
8246
+ * * The scaling group resides in a virtual private cloud (VPC). The scaling group and the ALB server group must reside in the same VPC.
8247
+ * * The ALB server group is in the Available state.
8248
+ * * You can associate only a limited number of ALB server groups with a scaling group. To view the quota or manually request a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).
8249
+ *
8250
+ * @param request AttachAlbServerGroupsRequest
8251
+ * @return AttachAlbServerGroupsResponse
8077
8252
  */
8078
8253
  attachAlbServerGroups(request: AttachAlbServerGroupsRequest): Promise<AttachAlbServerGroupsResponse>;
8079
8254
  /**
8080
- * Before you associate an ApsaraDB RDS instance with a scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
8081
- * * The ApsaraDB RDS instance and the scaling group must belong to the same Alibaba Cloud account.
8082
- * * The ApsaraDB RDS instance must be unlocked. For more information about the lock policy, see [ApsaraDB RDS usage notes](~~41872~~).
8083
- * * The ApsaraDB RDS instance must be in the Running state.
8084
- * After an ApsaraDB RDS instance is associated with the scaling group, the default IP address whitelist of the ApsaraDB RDS instance can contain no more than 1,000 IP addresses. For more information, see [Set the whitelist](~~43185~~).
8085
- *
8086
- * @param request AttachDBInstancesRequest
8087
- * @param runtime runtime options for this request RuntimeOptions
8088
- * @return AttachDBInstancesResponse
8255
+ * @summary Associates one or more ApsaraDB RDS instances with a scaling group.
8256
+ *
8257
+ * @description Before you associate an ApsaraDB RDS instance with a scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
8258
+ * * The ApsaraDB RDS instance and the scaling group must belong to the same Alibaba Cloud account.
8259
+ * * The ApsaraDB RDS instance must be unlocked. For more information about the lock policy, see [ApsaraDB RDS usage notes](https://help.aliyun.com/document_detail/41872.html).
8260
+ * * The ApsaraDB RDS instance must be in the Running state.
8261
+ * After an ApsaraDB RDS instance is associated with the scaling group, the default IP address whitelist of the ApsaraDB RDS instance can contain no more than 1,000 IP addresses. For more information, see [Set the whitelist](https://help.aliyun.com/document_detail/43185.html).
8262
+ *
8263
+ * @param request AttachDBInstancesRequest
8264
+ * @param runtime runtime options for this request RuntimeOptions
8265
+ * @return AttachDBInstancesResponse
8089
8266
  */
8090
8267
  attachDBInstancesWithOptions(request: AttachDBInstancesRequest, runtime: $Util.RuntimeOptions): Promise<AttachDBInstancesResponse>;
8091
8268
  /**
8092
- * Before you associate an ApsaraDB RDS instance with a scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
8093
- * * The ApsaraDB RDS instance and the scaling group must belong to the same Alibaba Cloud account.
8094
- * * The ApsaraDB RDS instance must be unlocked. For more information about the lock policy, see [ApsaraDB RDS usage notes](~~41872~~).
8095
- * * The ApsaraDB RDS instance must be in the Running state.
8096
- * After an ApsaraDB RDS instance is associated with the scaling group, the default IP address whitelist of the ApsaraDB RDS instance can contain no more than 1,000 IP addresses. For more information, see [Set the whitelist](~~43185~~).
8097
- *
8098
- * @param request AttachDBInstancesRequest
8099
- * @return AttachDBInstancesResponse
8269
+ * @summary Associates one or more ApsaraDB RDS instances with a scaling group.
8270
+ *
8271
+ * @description Before you associate an ApsaraDB RDS instance with a scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
8272
+ * * The ApsaraDB RDS instance and the scaling group must belong to the same Alibaba Cloud account.
8273
+ * * The ApsaraDB RDS instance must be unlocked. For more information about the lock policy, see [ApsaraDB RDS usage notes](https://help.aliyun.com/document_detail/41872.html).
8274
+ * * The ApsaraDB RDS instance must be in the Running state.
8275
+ * After an ApsaraDB RDS instance is associated with the scaling group, the default IP address whitelist of the ApsaraDB RDS instance can contain no more than 1,000 IP addresses. For more information, see [Set the whitelist](https://help.aliyun.com/document_detail/43185.html).
8276
+ *
8277
+ * @param request AttachDBInstancesRequest
8278
+ * @return AttachDBInstancesResponse
8100
8279
  */
8101
8280
  attachDBInstances(request: AttachDBInstancesRequest): Promise<AttachDBInstancesResponse>;
8102
8281
  /**
8103
- * Before you call this operation, take note of the following items:
8104
- * * The scaling group is in the Active state.
8105
- * * No scaling activities in the scaling group are in progress.
8106
- * The ECS instances or the elastic container instances that you want to add to a scaling group must meet the following requirements:
8107
- * * The instances reside in the same region as the scaling group.
8108
- * * The instances must be in the Running state.
8109
- * * The instances are not added to other scaling groups.
8110
- * * The instances use the subscription or pay-as-you-go billing method, or are preemptible instances.
8111
- * * If the VswitchID parameter is specified for a scaling group, the instances that are in the classic network or those that are not in the same virtual private cloud (VPC) as the specified vSwitch cannot be added to the scaling group.
8112
- * * If the VswitchID parameter is not specified for a scaling group, the instances that are in VPCs cannot be added to the scaling group.
8113
- * If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8114
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
8115
- * If the sum of the number of instances that you want to add and the number of existing instances in the scaling group is greater than the value of the MaxSize parameter, the call fails.
8116
- * Instances that are manually added by calling the AttachInstances operation are not associated with the active scaling configuration of the scaling group.
8117
- *
8118
- * @param request AttachInstancesRequest
8119
- * @param runtime runtime options for this request RuntimeOptions
8120
- * @return AttachInstancesResponse
8282
+ * @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.
8283
+ *
8284
+ * @description Before you call this operation, take note of the following items:
8285
+ * * The scaling group is in the Active state.
8286
+ * * No scaling activities in the scaling group are in progress.
8287
+ * The ECS instances or the elastic container instances that you want to add to a scaling group must meet the following requirements:
8288
+ * * The instances reside in the same region as the scaling group.
8289
+ * * The instances must be in the Running state.
8290
+ * * The instances are not added to other scaling groups.
8291
+ * * The instances use the subscription or pay-as-you-go billing method, or are preemptible instances.
8292
+ * * If the VswitchID parameter is specified for a scaling group, the instances that are in the classic network or those that are not in the same virtual private cloud (VPC) as the specified vSwitch cannot be added to the scaling group.
8293
+ * * If the VswitchID parameter is not specified for a scaling group, the instances that are in VPCs cannot be added to the scaling group.
8294
+ * If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8295
+ * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
8296
+ * If the sum of the number of instances that you want to add and the number of existing instances in the scaling group is greater than the value of the MaxSize parameter, the call fails.
8297
+ * Instances that are manually added by calling the AttachInstances operation are not associated with the active scaling configuration of the scaling group.
8298
+ *
8299
+ * @param request AttachInstancesRequest
8300
+ * @param runtime runtime options for this request RuntimeOptions
8301
+ * @return AttachInstancesResponse
8121
8302
  */
8122
8303
  attachInstancesWithOptions(request: AttachInstancesRequest, runtime: $Util.RuntimeOptions): Promise<AttachInstancesResponse>;
8123
8304
  /**
8124
- * Before you call this operation, take note of the following items:
8125
- * * The scaling group is in the Active state.
8126
- * * No scaling activities in the scaling group are in progress.
8127
- * The ECS instances or the elastic container instances that you want to add to a scaling group must meet the following requirements:
8128
- * * The instances reside in the same region as the scaling group.
8129
- * * The instances must be in the Running state.
8130
- * * The instances are not added to other scaling groups.
8131
- * * The instances use the subscription or pay-as-you-go billing method, or are preemptible instances.
8132
- * * If the VswitchID parameter is specified for a scaling group, the instances that are in the classic network or those that are not in the same virtual private cloud (VPC) as the specified vSwitch cannot be added to the scaling group.
8133
- * * If the VswitchID parameter is not specified for a scaling group, the instances that are in VPCs cannot be added to the scaling group.
8134
- * If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8135
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
8136
- * If the sum of the number of instances that you want to add and the number of existing instances in the scaling group is greater than the value of the MaxSize parameter, the call fails.
8137
- * Instances that are manually added by calling the AttachInstances operation are not associated with the active scaling configuration of the scaling group.
8138
- *
8139
- * @param request AttachInstancesRequest
8140
- * @return AttachInstancesResponse
8305
+ * @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.
8306
+ *
8307
+ * @description Before you call this operation, take note of the following items:
8308
+ * * The scaling group is in the Active state.
8309
+ * * No scaling activities in the scaling group are in progress.
8310
+ * The ECS instances or the elastic container instances that you want to add to a scaling group must meet the following requirements:
8311
+ * * The instances reside in the same region as the scaling group.
8312
+ * * The instances must be in the Running state.
8313
+ * * The instances are not added to other scaling groups.
8314
+ * * The instances use the subscription or pay-as-you-go billing method, or are preemptible instances.
8315
+ * * If the VswitchID parameter is specified for a scaling group, the instances that are in the classic network or those that are not in the same virtual private cloud (VPC) as the specified vSwitch cannot be added to the scaling group.
8316
+ * * If the VswitchID parameter is not specified for a scaling group, the instances that are in VPCs cannot be added to the scaling group.
8317
+ * If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8318
+ * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
8319
+ * If the sum of the number of instances that you want to add and the number of existing instances in the scaling group is greater than the value of the MaxSize parameter, the call fails.
8320
+ * Instances that are manually added by calling the AttachInstances operation are not associated with the active scaling configuration of the scaling group.
8321
+ *
8322
+ * @param request AttachInstancesRequest
8323
+ * @return AttachInstancesResponse
8141
8324
  */
8142
8325
  attachInstances(request: AttachInstancesRequest): Promise<AttachInstancesResponse>;
8143
8326
  /**
8144
- * Before you call this operation to attach a CLB instance to your scaling group, take note of the following items:
8145
- * * The CLB instance and the scaling group must belong to the same Alibaba Cloud account.
8146
- * * The CLB instance and the scaling group must reside in the same region.
8147
- * * The CLB instance must be in the Running state.
8148
- * * The CLB instance must be configured with at least one listener. Health check is enabled for the CLB instance.
8149
- * * The CLB instance and the scaling group must be in the same virtual private cloud (VPC) if their network type is VPC.
8150
- * * If the network type of the scaling group is VPC, the network type of the CLB instance is classic network, and the CLB backend server groups contain instances of the VPC network type, the instances and the scaling group must be in the same VPC.
8151
- * * You can attach only a limited number of CLB instances to a scaling group. Fore more information, see [Limits](~~25863~~).
8152
- *
8153
- * @param request AttachLoadBalancersRequest
8154
- * @param runtime runtime options for this request RuntimeOptions
8155
- * @return AttachLoadBalancersResponse
8327
+ * @summary Attaches load balancers to a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups. Load balancers help distribute the access traffic to the instances in scaling groups, which effectively improves the service performance of the scaling groups. You can call the AttachLoadBalancers operation to attach one or more load balancers to your scaling group.
8328
+ *
8329
+ * @description Before you call this operation, make sure that the following requirements are met:
8330
+ * * The load balancer and the scaling group belong to the same Alibaba Cloud account and region.
8331
+ * * The load balancer is in the `Running` state.
8332
+ * * At least one listener is configured for the load balancer, and the health check feature is enabled for the load balancer.
8333
+ * * If the network type of the load balancer and the scaling group is virtual private cloud (VPC), they use the same VPC.
8334
+ * * If the network type of the scaling group is VPC, and that of the load balancer is classic network and a backend server of the load balancer uses a VPC, the scaling group and the backend server use the same VPC.
8335
+ * * The attachment of load balancers ensures that the cumulative number of load balancers attached to the scaling group stays within the predefined maximum limit. For information about the load balancer quota, see [Limits](https://help.aliyun.com/document_detail/25863.html).
8336
+ *
8337
+ * @param request AttachLoadBalancersRequest
8338
+ * @param runtime runtime options for this request RuntimeOptions
8339
+ * @return AttachLoadBalancersResponse
8156
8340
  */
8157
8341
  attachLoadBalancersWithOptions(request: AttachLoadBalancersRequest, runtime: $Util.RuntimeOptions): Promise<AttachLoadBalancersResponse>;
8158
8342
  /**
8159
- * Before you call this operation to attach a CLB instance to your scaling group, take note of the following items:
8160
- * * The CLB instance and the scaling group must belong to the same Alibaba Cloud account.
8161
- * * The CLB instance and the scaling group must reside in the same region.
8162
- * * The CLB instance must be in the Running state.
8163
- * * The CLB instance must be configured with at least one listener. Health check is enabled for the CLB instance.
8164
- * * The CLB instance and the scaling group must be in the same virtual private cloud (VPC) if their network type is VPC.
8165
- * * If the network type of the scaling group is VPC, the network type of the CLB instance is classic network, and the CLB backend server groups contain instances of the VPC network type, the instances and the scaling group must be in the same VPC.
8166
- * * You can attach only a limited number of CLB instances to a scaling group. Fore more information, see [Limits](~~25863~~).
8167
- *
8168
- * @param request AttachLoadBalancersRequest
8169
- * @return AttachLoadBalancersResponse
8343
+ * @summary Attaches load balancers to a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups. Load balancers help distribute the access traffic to the instances in scaling groups, which effectively improves the service performance of the scaling groups. You can call the AttachLoadBalancers operation to attach one or more load balancers to your scaling group.
8344
+ *
8345
+ * @description Before you call this operation, make sure that the following requirements are met:
8346
+ * * The load balancer and the scaling group belong to the same Alibaba Cloud account and region.
8347
+ * * The load balancer is in the `Running` state.
8348
+ * * At least one listener is configured for the load balancer, and the health check feature is enabled for the load balancer.
8349
+ * * If the network type of the load balancer and the scaling group is virtual private cloud (VPC), they use the same VPC.
8350
+ * * If the network type of the scaling group is VPC, and that of the load balancer is classic network and a backend server of the load balancer uses a VPC, the scaling group and the backend server use the same VPC.
8351
+ * * The attachment of load balancers ensures that the cumulative number of load balancers attached to the scaling group stays within the predefined maximum limit. For information about the load balancer quota, see [Limits](https://help.aliyun.com/document_detail/25863.html).
8352
+ *
8353
+ * @param request AttachLoadBalancersRequest
8354
+ * @return AttachLoadBalancersResponse
8170
8355
  */
8171
8356
  attachLoadBalancers(request: AttachLoadBalancersRequest): Promise<AttachLoadBalancersResponse>;
8357
+ /**
8358
+ * @summary Attaches one or more server groups to a scaling group. You can attach the following server groups to a scaling group: Application Load Balancer (ALB) and Network Load Balancer (NLB) server groups.
8359
+ *
8360
+ * @param request AttachServerGroupsRequest
8361
+ * @param runtime runtime options for this request RuntimeOptions
8362
+ * @return AttachServerGroupsResponse
8363
+ */
8172
8364
  attachServerGroupsWithOptions(request: AttachServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<AttachServerGroupsResponse>;
8365
+ /**
8366
+ * @summary Attaches one or more server groups to a scaling group. You can attach the following server groups to a scaling group: Application Load Balancer (ALB) and Network Load Balancer (NLB) server groups.
8367
+ *
8368
+ * @param request AttachServerGroupsRequest
8369
+ * @return AttachServerGroupsResponse
8370
+ */
8173
8371
  attachServerGroups(request: AttachServerGroupsRequest): Promise<AttachServerGroupsResponse>;
8174
8372
  /**
8175
- * Before you call this operation to attach a vServer group to your scaling group, take note of the following items:
8176
- * * The CLB instance and the scaling group must belong to the same Alibaba Cloud account.
8177
- * * The CLB instance and the scaling group must reside in the same region.
8178
- * * The CLB instance must be in the Running state.
8179
- * * The CLB instance must be configured with at least one listener. Health check is enabled for the CLB instance.
8180
- * * The CLB instance and the scaling group must be in the same VPC if their network type is VPC.
8181
- * * If the network type of the scaling group is VPC, the network type of the CLB instance is classic network, and the vServer groups of the CLB instance contain instances of the VPC network type, the instances and the scaling group must be in the same VPC.
8182
- * * The vServer group that you want to attach to your scaling group must belong to the CLB instance.
8183
- * * You can attach only a limited number of vServer groups to a scaling group. For information about the quota on vServer groups, see [Limits](~~25863~~).
8184
- * When you call this operation, you must specify the following parameters:
8185
- * * LoadBalancerId: the ID of the CLB instance.
8186
- * * VServerGroupId: the ID of the vServer group.
8187
- * * Port: the port number of the vServer group.
8188
- * If a vServer group is attached to a scaling group by using different ports, Auto Scaling considers that more than one vServer group is attached to the scaling group. If multiple vServer groups with the same group ID and port number are specified in the request parameters, only the first vServer group is used. The other vServer groups are ignored.
8189
- *
8190
- * @param request AttachVServerGroupsRequest
8191
- * @param runtime runtime options for this request RuntimeOptions
8192
- * @return AttachVServerGroupsResponse
8373
+ * @summary Associates Sever Load Balancer (SLB) vServer groups with a scaling group.
8374
+ *
8375
+ * @description Before you call this operation to attach a vServer group to your scaling group, take note of the following items:
8376
+ * * The CLB instance and the scaling group must belong to the same Alibaba Cloud account.
8377
+ * * The CLB instance and the scaling group must reside in the same region.
8378
+ * * The CLB instance must be in the Running state.
8379
+ * * The CLB instance must be configured with at least one listener. Health check is enabled for the CLB instance.
8380
+ * * The CLB instance and the scaling group must be in the same VPC if their network type is VPC.
8381
+ * * If the network type of the scaling group is VPC, the network type of the CLB instance is classic network, and the vServer groups of the CLB instance contain instances of the VPC network type, the instances and the scaling group must be in the same VPC.
8382
+ * * The vServer group that you want to attach to your scaling group must belong to the CLB instance.
8383
+ * * You can attach only a limited number of vServer groups to a scaling group. For information about the quota on vServer groups, see [Limits](https://help.aliyun.com/document_detail/25863.html).
8384
+ * When you call this operation, you must specify the following parameters:
8385
+ * * LoadBalancerId: the ID of the CLB instance.
8386
+ * * VServerGroupId: the ID of the vServer group.
8387
+ * * Port: the port number of the vServer group.
8388
+ * If a vServer group is attached to a scaling group by using different ports, Auto Scaling considers that more than one vServer group is attached to the scaling group. If multiple vServer groups with the same group ID and port number are specified in the request parameters, only the first vServer group is used. The other vServer groups are ignored.
8389
+ *
8390
+ * @param request AttachVServerGroupsRequest
8391
+ * @param runtime runtime options for this request RuntimeOptions
8392
+ * @return AttachVServerGroupsResponse
8193
8393
  */
8194
8394
  attachVServerGroupsWithOptions(request: AttachVServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<AttachVServerGroupsResponse>;
8195
8395
  /**
8196
- * Before you call this operation to attach a vServer group to your scaling group, take note of the following items:
8197
- * * The CLB instance and the scaling group must belong to the same Alibaba Cloud account.
8198
- * * The CLB instance and the scaling group must reside in the same region.
8199
- * * The CLB instance must be in the Running state.
8200
- * * The CLB instance must be configured with at least one listener. Health check is enabled for the CLB instance.
8201
- * * The CLB instance and the scaling group must be in the same VPC if their network type is VPC.
8202
- * * If the network type of the scaling group is VPC, the network type of the CLB instance is classic network, and the vServer groups of the CLB instance contain instances of the VPC network type, the instances and the scaling group must be in the same VPC.
8203
- * * The vServer group that you want to attach to your scaling group must belong to the CLB instance.
8204
- * * You can attach only a limited number of vServer groups to a scaling group. For information about the quota on vServer groups, see [Limits](~~25863~~).
8205
- * When you call this operation, you must specify the following parameters:
8206
- * * LoadBalancerId: the ID of the CLB instance.
8207
- * * VServerGroupId: the ID of the vServer group.
8208
- * * Port: the port number of the vServer group.
8209
- * If a vServer group is attached to a scaling group by using different ports, Auto Scaling considers that more than one vServer group is attached to the scaling group. If multiple vServer groups with the same group ID and port number are specified in the request parameters, only the first vServer group is used. The other vServer groups are ignored.
8210
- *
8211
- * @param request AttachVServerGroupsRequest
8212
- * @return AttachVServerGroupsResponse
8396
+ * @summary Associates Sever Load Balancer (SLB) vServer groups with a scaling group.
8397
+ *
8398
+ * @description Before you call this operation to attach a vServer group to your scaling group, take note of the following items:
8399
+ * * The CLB instance and the scaling group must belong to the same Alibaba Cloud account.
8400
+ * * The CLB instance and the scaling group must reside in the same region.
8401
+ * * The CLB instance must be in the Running state.
8402
+ * * The CLB instance must be configured with at least one listener. Health check is enabled for the CLB instance.
8403
+ * * The CLB instance and the scaling group must be in the same VPC if their network type is VPC.
8404
+ * * If the network type of the scaling group is VPC, the network type of the CLB instance is classic network, and the vServer groups of the CLB instance contain instances of the VPC network type, the instances and the scaling group must be in the same VPC.
8405
+ * * The vServer group that you want to attach to your scaling group must belong to the CLB instance.
8406
+ * * You can attach only a limited number of vServer groups to a scaling group. For information about the quota on vServer groups, see [Limits](https://help.aliyun.com/document_detail/25863.html).
8407
+ * When you call this operation, you must specify the following parameters:
8408
+ * * LoadBalancerId: the ID of the CLB instance.
8409
+ * * VServerGroupId: the ID of the vServer group.
8410
+ * * Port: the port number of the vServer group.
8411
+ * If a vServer group is attached to a scaling group by using different ports, Auto Scaling considers that more than one vServer group is attached to the scaling group. If multiple vServer groups with the same group ID and port number are specified in the request parameters, only the first vServer group is used. The other vServer groups are ignored.
8412
+ *
8413
+ * @param request AttachVServerGroupsRequest
8414
+ * @return AttachVServerGroupsResponse
8213
8415
  */
8214
8416
  attachVServerGroups(request: AttachVServerGroupsRequest): Promise<AttachVServerGroupsResponse>;
8417
+ /**
8418
+ * @summary Adds a scaling group to a resource group.
8419
+ *
8420
+ * @param request ChangeResourceGroupRequest
8421
+ * @param runtime runtime options for this request RuntimeOptions
8422
+ * @return ChangeResourceGroupResponse
8423
+ */
8215
8424
  changeResourceGroupWithOptions(request: ChangeResourceGroupRequest, runtime: $Util.RuntimeOptions): Promise<ChangeResourceGroupResponse>;
8425
+ /**
8426
+ * @summary Adds a scaling group to a resource group.
8427
+ *
8428
+ * @param request ChangeResourceGroupRequest
8429
+ * @return ChangeResourceGroupResponse
8430
+ */
8216
8431
  changeResourceGroup(request: ChangeResourceGroupRequest): Promise<ChangeResourceGroupResponse>;
8217
8432
  /**
8218
- * If you set the LifecycleActionResult parameter for a lifecycle hook of a scaling group to CONTINUE in the operation, Auto Scaling continues to complete the scaling activity in the scaling group after the lifecycle hook times out. If you set the LifecycleActionResult parameter to ABANDON, Auto Scaling stops the scaling activity in the scaling group after the lifecycle hook times out.
8219
- *
8220
- * @param request CompleteLifecycleActionRequest
8221
- * @param runtime runtime options for this request RuntimeOptions
8222
- * @return CompleteLifecycleActionResponse
8433
+ * @summary Ends the timeout period of a lifecycle hook ahead of schedule. If you have created a lifecycle hook for your scaling group, you can call the CompleteLifecycleAction operation to end the timeout period of the lifecycle hook ahead of schedule based on your business requirements.
8434
+ *
8435
+ * @description When you manually cut short the timeout period of a lifecycle hook, Auto Scaling proceeds with one of the following actions based on the predefined settings: responding to the scaling request, aborting the scaling request, and initiating a rollback process.
8436
+ *
8437
+ * @param request CompleteLifecycleActionRequest
8438
+ * @param runtime runtime options for this request RuntimeOptions
8439
+ * @return CompleteLifecycleActionResponse
8223
8440
  */
8224
8441
  completeLifecycleActionWithOptions(request: CompleteLifecycleActionRequest, runtime: $Util.RuntimeOptions): Promise<CompleteLifecycleActionResponse>;
8225
8442
  /**
8226
- * If you set the LifecycleActionResult parameter for a lifecycle hook of a scaling group to CONTINUE in the operation, Auto Scaling continues to complete the scaling activity in the scaling group after the lifecycle hook times out. If you set the LifecycleActionResult parameter to ABANDON, Auto Scaling stops the scaling activity in the scaling group after the lifecycle hook times out.
8227
- *
8228
- * @param request CompleteLifecycleActionRequest
8229
- * @return CompleteLifecycleActionResponse
8443
+ * @summary Ends the timeout period of a lifecycle hook ahead of schedule. If you have created a lifecycle hook for your scaling group, you can call the CompleteLifecycleAction operation to end the timeout period of the lifecycle hook ahead of schedule based on your business requirements.
8444
+ *
8445
+ * @description When you manually cut short the timeout period of a lifecycle hook, Auto Scaling proceeds with one of the following actions based on the predefined settings: responding to the scaling request, aborting the scaling request, and initiating a rollback process.
8446
+ *
8447
+ * @param request CompleteLifecycleActionRequest
8448
+ * @return CompleteLifecycleActionResponse
8230
8449
  */
8231
8450
  completeLifecycleAction(request: CompleteLifecycleActionRequest): Promise<CompleteLifecycleActionResponse>;
8451
+ /**
8452
+ * @summary Creates an event-triggered task.
8453
+ *
8454
+ * @description * If you set the MetricType parameter to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using custom metrics. For more information, see [Custom monitoring event-triggered tasks](https://help.aliyun.com/document_detail/74861.html).
8455
+ * * When you create an event-triggered task, you must specify the MetricName, DimensionKey, and DimensionValue parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the user_id and scaling_group dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances or elastic container instances in a scaling group within an Alibaba Cloud account.
8456
+ * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
8457
+ * * For information about the supported metrics when you set the MetricType parameter to system, see [Event-triggered task for system monitoring](https://help.aliyun.com/document_detail/74854.html).
8458
+ * > The user_id and scaling_group dimensions are automatically populated. You need to only specify the device and state dimensions. For more information, see the `DimensionKey` and `DimensionValue` parameters in the "Request parameters" section of this topic.
8459
+ *
8460
+ * @param request CreateAlarmRequest
8461
+ * @param runtime runtime options for this request RuntimeOptions
8462
+ * @return CreateAlarmResponse
8463
+ */
8232
8464
  createAlarmWithOptions(request: CreateAlarmRequest, runtime: $Util.RuntimeOptions): Promise<CreateAlarmResponse>;
8465
+ /**
8466
+ * @summary Creates an event-triggered task.
8467
+ *
8468
+ * @description * If you set the MetricType parameter to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using custom metrics. For more information, see [Custom monitoring event-triggered tasks](https://help.aliyun.com/document_detail/74861.html).
8469
+ * * When you create an event-triggered task, you must specify the MetricName, DimensionKey, and DimensionValue parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the user_id and scaling_group dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances or elastic container instances in a scaling group within an Alibaba Cloud account.
8470
+ * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
8471
+ * * For information about the supported metrics when you set the MetricType parameter to system, see [Event-triggered task for system monitoring](https://help.aliyun.com/document_detail/74854.html).
8472
+ * > The user_id and scaling_group dimensions are automatically populated. You need to only specify the device and state dimensions. For more information, see the `DimensionKey` and `DimensionValue` parameters in the "Request parameters" section of this topic.
8473
+ *
8474
+ * @param request CreateAlarmRequest
8475
+ * @return CreateAlarmResponse
8476
+ */
8233
8477
  createAlarm(request: CreateAlarmRequest): Promise<CreateAlarmResponse>;
8234
8478
  /**
8235
- * A scaling configuration is a template that is used to create elastic container instances during scale-out activities.
8236
- * You can specify the Cpu and Memory parameters to determine the range of instance types. If you specify the parameters, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Auto Scaling preferentially creates elastic container instances of the instance type that is provided at the lowest price. This scaling mode is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
8237
- *
8238
- * @param request CreateEciScalingConfigurationRequest
8239
- * @param runtime runtime options for this request RuntimeOptions
8240
- * @return CreateEciScalingConfigurationResponse
8479
+ * @summary Creates a scaling configuration of the Elastic Container Instance type. Auto Scaling uses the scaling configuration as a template to create elastic container instances to meet your business requirements during scale-outs.
8480
+ *
8481
+ * @description A scaling configuration is a template that is used to create elastic container instances during scale-out activities.
8482
+ * You can specify the Cpu and Memory parameters to determine the range of instance types. If you specify the parameters, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Auto Scaling preferentially creates elastic container instances of the instance type that is provided at the lowest price. This scaling mode is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
8483
+ *
8484
+ * @param request CreateEciScalingConfigurationRequest
8485
+ * @param runtime runtime options for this request RuntimeOptions
8486
+ * @return CreateEciScalingConfigurationResponse
8241
8487
  */
8242
8488
  createEciScalingConfigurationWithOptions(request: CreateEciScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateEciScalingConfigurationResponse>;
8243
8489
  /**
8244
- * A scaling configuration is a template that is used to create elastic container instances during scale-out activities.
8245
- * You can specify the Cpu and Memory parameters to determine the range of instance types. If you specify the parameters, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Auto Scaling preferentially creates elastic container instances of the instance type that is provided at the lowest price. This scaling mode is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
8246
- *
8247
- * @param request CreateEciScalingConfigurationRequest
8248
- * @return CreateEciScalingConfigurationResponse
8490
+ * @summary Creates a scaling configuration of the Elastic Container Instance type. Auto Scaling uses the scaling configuration as a template to create elastic container instances to meet your business requirements during scale-outs.
8491
+ *
8492
+ * @description A scaling configuration is a template that is used to create elastic container instances during scale-out activities.
8493
+ * You can specify the Cpu and Memory parameters to determine the range of instance types. If you specify the parameters, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Auto Scaling preferentially creates elastic container instances of the instance type that is provided at the lowest price. This scaling mode is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
8494
+ *
8495
+ * @param request CreateEciScalingConfigurationRequest
8496
+ * @return CreateEciScalingConfigurationResponse
8249
8497
  */
8250
8498
  createEciScalingConfiguration(request: CreateEciScalingConfigurationRequest): Promise<CreateEciScalingConfigurationResponse>;
8251
8499
  /**
8252
- * You can create up to six lifecycle hooks for each scaling group. Elastic Compute Service (ECS) instances are not immediately added to or removed from scaling groups that have effective lifecycle hooks during scaling activities. The ECS instances are added to or removed from the scaling groups only after the lifecycle hooks time out. The period of time before the lifecycle hooks time out is specified by the HeartbeatTimeout parameter. Before lifecycle hooks time out, you can initialize the configurations of ECS instances and query data on the ECS instances.
8253
- * If lifecycle hooks take effect for scale-out activities, the private IP addresses of ECS instances are added to the IP address whitelists of the associated ApsaraDB RDS instances and the ECS instances are added to the backend server groups of the associated Server Load Balancer (SLB) instances only after the lifecycle hooks time out. If lifecycle hooks take effect for scale-in activities, the private IP addresses of ECS instances are removed from the IP address whitelists of the disassociated ApsaraDB RDS instances and the ECS instances are removed from the backend server groups of the disassociated SLB instances only after the lifecycle hooks time out.
8254
- * You can configure a notification method for a lifecycle hook. When the lifecycle hook takes effect, a notification can be sent by using a Message Service (MNS) topic, an MNS queue, or an Operation Orchestration Service (OOS) template. If you want to configure an OOS template, you must create a RAM role for OOS. For more information, see [Grant RAM permissions to OOS](~~120810~~).
8255
- * > If your scaling group contains ECS instances and you configure an OOS template to add the private IP addresses of the ECS instances to or remove the private IP addresses of the ECS instances from the IP address whitelists of cloud databases other than ApsaraDB RDS databases, you must manually add the private IP addresses of the ECS instances to the IP address whitelists of the cloud databases.
8256
- *
8257
- * @param request CreateLifecycleHookRequest
8258
- * @param runtime runtime options for this request RuntimeOptions
8259
- * @return CreateLifecycleHookResponse
8500
+ * @summary Creates one or more lifecycle hooks.
8501
+ *
8502
+ * @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.
8503
+ * 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.
8504
+ * You can configure a notification method for a lifecycle hook. When the lifecycle hook is triggered, a notification can be sent to the specified Message Service (MNS) topic or queue, or an operation can be performed based on the specified Operation Orchestration Service (OOS) template. If you want to configure an OOS template, you must create a Resource Access Management (RAM) role for OOS. For more information, see [Grant RAM permissions to OOS](https://help.aliyun.com/document_detail/120810.html).
8505
+ * > If your scaling group has existing ECS instances and you configured an OOS template that is used to add the private IP addresses of ECS instances to or remove the private IP addresses of ECS instances from the whitelists that manage access to cloud databases that are not ApsaraDB RDS databases, you must manually add the private IP addresses of the ECS instances to or remove the private IP addresses of the ECS instances from the whitelists that manage access to the cloud databases.
8506
+ *
8507
+ * @param request CreateLifecycleHookRequest
8508
+ * @param runtime runtime options for this request RuntimeOptions
8509
+ * @return CreateLifecycleHookResponse
8260
8510
  */
8261
8511
  createLifecycleHookWithOptions(request: CreateLifecycleHookRequest, runtime: $Util.RuntimeOptions): Promise<CreateLifecycleHookResponse>;
8262
8512
  /**
8263
- * You can create up to six lifecycle hooks for each scaling group. Elastic Compute Service (ECS) instances are not immediately added to or removed from scaling groups that have effective lifecycle hooks during scaling activities. The ECS instances are added to or removed from the scaling groups only after the lifecycle hooks time out. The period of time before the lifecycle hooks time out is specified by the HeartbeatTimeout parameter. Before lifecycle hooks time out, you can initialize the configurations of ECS instances and query data on the ECS instances.
8264
- * If lifecycle hooks take effect for scale-out activities, the private IP addresses of ECS instances are added to the IP address whitelists of the associated ApsaraDB RDS instances and the ECS instances are added to the backend server groups of the associated Server Load Balancer (SLB) instances only after the lifecycle hooks time out. If lifecycle hooks take effect for scale-in activities, the private IP addresses of ECS instances are removed from the IP address whitelists of the disassociated ApsaraDB RDS instances and the ECS instances are removed from the backend server groups of the disassociated SLB instances only after the lifecycle hooks time out.
8265
- * You can configure a notification method for a lifecycle hook. When the lifecycle hook takes effect, a notification can be sent by using a Message Service (MNS) topic, an MNS queue, or an Operation Orchestration Service (OOS) template. If you want to configure an OOS template, you must create a RAM role for OOS. For more information, see [Grant RAM permissions to OOS](~~120810~~).
8266
- * > If your scaling group contains ECS instances and you configure an OOS template to add the private IP addresses of the ECS instances to or remove the private IP addresses of the ECS instances from the IP address whitelists of cloud databases other than ApsaraDB RDS databases, you must manually add the private IP addresses of the ECS instances to the IP address whitelists of the cloud databases.
8267
- *
8268
- * @param request CreateLifecycleHookRequest
8269
- * @return CreateLifecycleHookResponse
8513
+ * @summary Creates one or more lifecycle hooks.
8514
+ *
8515
+ * @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.
8516
+ * 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.
8517
+ * You can configure a notification method for a lifecycle hook. When the lifecycle hook is triggered, a notification can be sent to the specified Message Service (MNS) topic or queue, or an operation can be performed based on the specified Operation Orchestration Service (OOS) template. If you want to configure an OOS template, you must create a Resource Access Management (RAM) role for OOS. For more information, see [Grant RAM permissions to OOS](https://help.aliyun.com/document_detail/120810.html).
8518
+ * > If your scaling group has existing ECS instances and you configured an OOS template that is used to add the private IP addresses of ECS instances to or remove the private IP addresses of ECS instances from the whitelists that manage access to cloud databases that are not ApsaraDB RDS databases, you must manually add the private IP addresses of the ECS instances to or remove the private IP addresses of the ECS instances from the whitelists that manage access to the cloud databases.
8519
+ *
8520
+ * @param request CreateLifecycleHookRequest
8521
+ * @return CreateLifecycleHookResponse
8270
8522
  */
8271
8523
  createLifecycleHook(request: CreateLifecycleHookRequest): Promise<CreateLifecycleHookResponse>;
8272
8524
  /**
8273
- * ## Description
8274
- * You can configure CloudMonitor system events, Message Service (MNS) queues, or MNS topics to receive notifications. When a specified type of scaling activity or resource change occurs in a scaling group, Auto Scaling sends notifications by using CloudMonitor or MNS.
8275
- *
8276
- * @param request CreateNotificationConfigurationRequest
8277
- * @param runtime runtime options for this request RuntimeOptions
8278
- * @return CreateNotificationConfigurationResponse
8525
+ * @summary Creates a notification rule. You can call the CreateNotificationConfiguration operation to create a notification rule to stay informed about scaling events or resource changes. This helps you learn about the dynamic status of your scaling group in real time and further automates the management of scaling events.
8526
+ *
8527
+ * @description ## Description
8528
+ * You can configure CloudMonitor system events, Message Service (MNS) queues, or MNS topics to receive notifications. When a specified type of scaling activity or resource change occurs in a scaling group, Auto Scaling sends notifications by using CloudMonitor or MNS.
8529
+ *
8530
+ * @param request CreateNotificationConfigurationRequest
8531
+ * @param runtime runtime options for this request RuntimeOptions
8532
+ * @return CreateNotificationConfigurationResponse
8279
8533
  */
8280
8534
  createNotificationConfigurationWithOptions(request: CreateNotificationConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateNotificationConfigurationResponse>;
8281
8535
  /**
8282
- * ## Description
8283
- * You can configure CloudMonitor system events, Message Service (MNS) queues, or MNS topics to receive notifications. When a specified type of scaling activity or resource change occurs in a scaling group, Auto Scaling sends notifications by using CloudMonitor or MNS.
8284
- *
8285
- * @param request CreateNotificationConfigurationRequest
8286
- * @return CreateNotificationConfigurationResponse
8536
+ * @summary Creates a notification rule. You can call the CreateNotificationConfiguration operation to create a notification rule to stay informed about scaling events or resource changes. This helps you learn about the dynamic status of your scaling group in real time and further automates the management of scaling events.
8537
+ *
8538
+ * @description ## Description
8539
+ * You can configure CloudMonitor system events, Message Service (MNS) queues, or MNS topics to receive notifications. When a specified type of scaling activity or resource change occurs in a scaling group, Auto Scaling sends notifications by using CloudMonitor or MNS.
8540
+ *
8541
+ * @param request CreateNotificationConfigurationRequest
8542
+ * @return CreateNotificationConfigurationResponse
8287
8543
  */
8288
8544
  createNotificationConfiguration(request: CreateNotificationConfigurationRequest): Promise<CreateNotificationConfigurationResponse>;
8289
8545
  /**
8290
- * Auto Scaling automatically creates Elastic Compute Service (ECS) instances based on the specified scaling configuration. ECS instances can be created in the following modes:
8291
- * * InstancePatternInfos: intelligent configuration mode. In this mode, you need to only specify the number of vCPUs, memory size, instance family, and maximum price. Auto Scaling selects the instance type that has the lowest price based on the configurations to create ECS instances. This mode is available only for scaling groups that reside in virtual private clouds (VPCs). This mode reduces scale-out failures caused by insufficient inventory of instance types.
8292
- * * InstanceType: In this mode, you must specify one instance type.
8293
- * * InstanceTypes: In this mode, you can specify more than one instance type.
8294
- * * InstanceTypeOverrides: In this mode, you can specify multiple instance types and weights for the instance types.
8295
- * * Cpu and Memory: In this mode, you must specify the number of vCPUs and the memory size. Auto Scaling determines the range of available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling creates ECS instances by using the lowest-priced instance type. This mode is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
8296
- * > You cannot specify InstanceType, InstanceTypes, InstanceTypeOverrides, and Cpu and Memory at the same time. You can specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfo at the same time. If you specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfos at the same time, Auto Scaling preferentially uses the instance types that are specified by InstanceType or InstanceTypes for scale-outs. If the instance types that are specified by InstanceType or InstanceTypes do not have sufficient inventory, Auto Scaling uses the instance types that are specified by InstancePatternInfos for scale-outs.
8297
- *
8298
- * @param tmpReq CreateScalingConfigurationRequest
8299
- * @param runtime runtime options for this request RuntimeOptions
8300
- * @return CreateScalingConfigurationResponse
8546
+ * @summary Creates a scaling configuration.
8547
+ *
8548
+ * @description Auto Scaling automatically creates Elastic Compute Service (ECS) instances based on the specified scaling configuration. ECS instances can be created in the following modes:
8549
+ * * InstancePatternInfos: intelligent configuration mode. In this mode, you need to only specify the number of vCPUs, memory size, instance family, and maximum price. Auto Scaling selects the instance type that has the lowest price based on the configurations to create ECS instances. This mode is available only for scaling groups that reside in virtual private clouds (VPCs). This mode reduces scale-out failures caused by insufficient inventory of instance types.
8550
+ * * InstanceType: In this mode, you must specify one instance type.
8551
+ * * InstanceTypes: In this mode, you can specify more than one instance type.
8552
+ * * InstanceTypeOverrides: In this mode, you can specify multiple instance types and weights for the instance types.
8553
+ * * Cpu and Memory: In this mode, you must specify the number of vCPUs and the memory size. Auto Scaling determines the range of available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling creates ECS instances by using the lowest-priced instance type. This mode is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
8554
+ * > You cannot specify InstanceType, InstanceTypes, InstanceTypeOverrides, and Cpu and Memory at the same time. You can specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfo at the same time. If you specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfos at the same time, Auto Scaling preferentially uses the instance types that are specified by InstanceType or InstanceTypes for scale-outs. If the instance types that are specified by InstanceType or InstanceTypes do not have sufficient inventory, Auto Scaling uses the instance types that are specified by InstancePatternInfos for scale-outs.
8555
+ *
8556
+ * @param tmpReq CreateScalingConfigurationRequest
8557
+ * @param runtime runtime options for this request RuntimeOptions
8558
+ * @return CreateScalingConfigurationResponse
8301
8559
  */
8302
8560
  createScalingConfigurationWithOptions(tmpReq: CreateScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateScalingConfigurationResponse>;
8303
8561
  /**
8304
- * Auto Scaling automatically creates Elastic Compute Service (ECS) instances based on the specified scaling configuration. ECS instances can be created in the following modes:
8305
- * * InstancePatternInfos: intelligent configuration mode. In this mode, you need to only specify the number of vCPUs, memory size, instance family, and maximum price. Auto Scaling selects the instance type that has the lowest price based on the configurations to create ECS instances. This mode is available only for scaling groups that reside in virtual private clouds (VPCs). This mode reduces scale-out failures caused by insufficient inventory of instance types.
8306
- * * InstanceType: In this mode, you must specify one instance type.
8307
- * * InstanceTypes: In this mode, you can specify more than one instance type.
8308
- * * InstanceTypeOverrides: In this mode, you can specify multiple instance types and weights for the instance types.
8309
- * * Cpu and Memory: In this mode, you must specify the number of vCPUs and the memory size. Auto Scaling determines the range of available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling creates ECS instances by using the lowest-priced instance type. This mode is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
8310
- * > You cannot specify InstanceType, InstanceTypes, InstanceTypeOverrides, and Cpu and Memory at the same time. You can specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfo at the same time. If you specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfos at the same time, Auto Scaling preferentially uses the instance types that are specified by InstanceType or InstanceTypes for scale-outs. If the instance types that are specified by InstanceType or InstanceTypes do not have sufficient inventory, Auto Scaling uses the instance types that are specified by InstancePatternInfos for scale-outs.
8311
- *
8312
- * @param request CreateScalingConfigurationRequest
8313
- * @return CreateScalingConfigurationResponse
8562
+ * @summary Creates a scaling configuration.
8563
+ *
8564
+ * @description Auto Scaling automatically creates Elastic Compute Service (ECS) instances based on the specified scaling configuration. ECS instances can be created in the following modes:
8565
+ * * InstancePatternInfos: intelligent configuration mode. In this mode, you need to only specify the number of vCPUs, memory size, instance family, and maximum price. Auto Scaling selects the instance type that has the lowest price based on the configurations to create ECS instances. This mode is available only for scaling groups that reside in virtual private clouds (VPCs). This mode reduces scale-out failures caused by insufficient inventory of instance types.
8566
+ * * InstanceType: In this mode, you must specify one instance type.
8567
+ * * InstanceTypes: In this mode, you can specify more than one instance type.
8568
+ * * InstanceTypeOverrides: In this mode, you can specify multiple instance types and weights for the instance types.
8569
+ * * Cpu and Memory: In this mode, you must specify the number of vCPUs and the memory size. Auto Scaling determines the range of available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling creates ECS instances by using the lowest-priced instance type. This mode is available only if Scaling Policy is set to Cost Optimization Policy and no instance type is specified in the scaling configuration.
8570
+ * > You cannot specify InstanceType, InstanceTypes, InstanceTypeOverrides, and Cpu and Memory at the same time. You can specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfo at the same time. If you specify InstanceType and InstancePatternInfos or specify InstanceTypes and InstancePatternInfos at the same time, Auto Scaling preferentially uses the instance types that are specified by InstanceType or InstanceTypes for scale-outs. If the instance types that are specified by InstanceType or InstanceTypes do not have sufficient inventory, Auto Scaling uses the instance types that are specified by InstancePatternInfos for scale-outs.
8571
+ *
8572
+ * @param request CreateScalingConfigurationRequest
8573
+ * @return CreateScalingConfigurationResponse
8314
8574
  */
8315
8575
  createScalingConfiguration(request: CreateScalingConfigurationRequest): Promise<CreateScalingConfigurationResponse>;
8316
8576
  /**
8317
- * A scaling group is a group of Elastic Compute Service (ECS) instances that can be used in similar business scenarios.
8318
- * 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.
8319
- * 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.
8320
- * 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](~~40654~~) topic.
8321
- * 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:
8322
- * * 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.
8323
- * * 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.
8324
- * > If you specify the default server group and multiple vServer groups at the same time, ECS instances are added to all specified server groups.
8325
- * 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:
8326
- * * The CLB instance must be in the Active state. You can call the DescribeLoadBalancers operation to query the state of the CLB instance.
8327
- * * 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.
8328
- * 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.
8329
- * 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:
8330
- * * 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.
8331
- * * 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.
8332
- * If you set the MultiAZPolicy parameter of the scaling group to COST_OPTIMIZED, take note of the following items:
8333
- * * 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.
8334
- * * 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.
8335
- * If you set the `Tags.Propagate` parameter of the scaling group to true, the following rules apply:
8336
- * * 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.
8337
- * * 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.
8338
- * * 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.
8339
- *
8340
- * @param request CreateScalingGroupRequest
8341
- * @param runtime runtime options for this request RuntimeOptions
8342
- * @return CreateScalingGroupResponse
8577
+ * @summary Creates a scaling group.
8578
+ *
8579
+ * @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used in similar business scenarios.
8580
+ * 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.
8581
+ * 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.
8582
+ * 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.
8583
+ * 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:
8584
+ * * 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.
8585
+ * * 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.
8586
+ * > If you specify the default server group and multiple vServer groups at the same time, ECS instances are added to all specified server groups.
8587
+ * 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:
8588
+ * * The CLB instance must be in the Active state. You can call the DescribeLoadBalancers operation to query the state of the CLB instance.
8589
+ * * 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.
8590
+ * 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.
8591
+ * 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:
8592
+ * * 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.
8593
+ * * 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.
8594
+ * If you set the MultiAZPolicy parameter of the scaling group to COST_OPTIMIZED, take note of the following items:
8595
+ * * 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.
8596
+ * * 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.
8597
+ * If you set the `Tags.Propagate` parameter of the scaling group to true, the following rules apply:
8598
+ * * 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.
8599
+ * * 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.
8600
+ * * 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.
8601
+ *
8602
+ * @param request CreateScalingGroupRequest
8603
+ * @param runtime runtime options for this request RuntimeOptions
8604
+ * @return CreateScalingGroupResponse
8343
8605
  */
8344
8606
  createScalingGroupWithOptions(request: CreateScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateScalingGroupResponse>;
8345
8607
  /**
8346
- * A scaling group is a group of Elastic Compute Service (ECS) instances that can be used in similar business scenarios.
8347
- * 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.
8348
- * 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.
8349
- * 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](~~40654~~) topic.
8350
- * 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:
8351
- * * 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.
8352
- * * 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.
8353
- * > If you specify the default server group and multiple vServer groups at the same time, ECS instances are added to all specified server groups.
8354
- * 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:
8355
- * * The CLB instance must be in the Active state. You can call the DescribeLoadBalancers operation to query the state of the CLB instance.
8356
- * * 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.
8357
- * 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.
8358
- * 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:
8359
- * * 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.
8360
- * * 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.
8361
- * If you set the MultiAZPolicy parameter of the scaling group to COST_OPTIMIZED, take note of the following items:
8362
- * * 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.
8363
- * * 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.
8364
- * If you set the `Tags.Propagate` parameter of the scaling group to true, the following rules apply:
8365
- * * 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.
8366
- * * 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.
8367
- * * 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.
8368
- *
8369
- * @param request CreateScalingGroupRequest
8370
- * @return CreateScalingGroupResponse
8608
+ * @summary Creates a scaling group.
8609
+ *
8610
+ * @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used in similar business scenarios.
8611
+ * 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.
8612
+ * 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.
8613
+ * 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.
8614
+ * 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:
8615
+ * * 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.
8616
+ * * 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.
8617
+ * > If you specify the default server group and multiple vServer groups at the same time, ECS instances are added to all specified server groups.
8618
+ * 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:
8619
+ * * The CLB instance must be in the Active state. You can call the DescribeLoadBalancers operation to query the state of the CLB instance.
8620
+ * * 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.
8621
+ * 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.
8622
+ * 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:
8623
+ * * 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.
8624
+ * * 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.
8625
+ * If you set the MultiAZPolicy parameter of the scaling group to COST_OPTIMIZED, take note of the following items:
8626
+ * * 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.
8627
+ * * 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.
8628
+ * If you set the `Tags.Propagate` parameter of the scaling group to true, the following rules apply:
8629
+ * * 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.
8630
+ * * 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.
8631
+ * * 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.
8632
+ *
8633
+ * @param request CreateScalingGroupRequest
8634
+ * @return CreateScalingGroupResponse
8371
8635
  */
8372
8636
  createScalingGroup(request: CreateScalingGroupRequest): Promise<CreateScalingGroupResponse>;
8373
8637
  /**
8374
- * ## Description
8375
- * 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:
8376
- * * 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.
8377
- * * 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.
8378
- * Before you call this operation, take note of the following items:
8379
- * * 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.
8380
- * * 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.
8381
- * * 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.
8382
- * * 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.
8383
- * * You can create only a limited number of scaling rules for a scaling group. For more information, see the "Limits" topic.
8384
- * * The unique identifier (ScalingRuleAri) of a scaling rule can be used by the following operations:
8385
- * * 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.
8386
- * * 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.
8387
- *
8388
- * @param request CreateScalingRuleRequest
8389
- * @param runtime runtime options for this request RuntimeOptions
8390
- * @return CreateScalingRuleResponse
8638
+ * @summary Creates a scaling rule.
8639
+ *
8640
+ * @description ## Description
8641
+ * 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:
8642
+ * * 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.
8643
+ * * 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.
8644
+ * Before you call this operation, take note of the following items:
8645
+ * * 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.
8646
+ * * 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.
8647
+ * * 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.
8648
+ * * 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.
8649
+ * * You can create only a limited number of scaling rules for a scaling group. For more information, see the "Limits" topic.
8650
+ * * The unique identifier (ScalingRuleAri) of a scaling rule can be used by the following operations:
8651
+ * * 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.
8652
+ * * 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.
8653
+ *
8654
+ * @param request CreateScalingRuleRequest
8655
+ * @param runtime runtime options for this request RuntimeOptions
8656
+ * @return CreateScalingRuleResponse
8391
8657
  */
8392
8658
  createScalingRuleWithOptions(request: CreateScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<CreateScalingRuleResponse>;
8393
8659
  /**
8394
- * ## Description
8395
- * 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:
8396
- * * 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.
8397
- * * 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.
8398
- * Before you call this operation, take note of the following items:
8399
- * * 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.
8400
- * * 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.
8401
- * * 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.
8402
- * * 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.
8403
- * * You can create only a limited number of scaling rules for a scaling group. For more information, see the "Limits" topic.
8404
- * * The unique identifier (ScalingRuleAri) of a scaling rule can be used by the following operations:
8405
- * * 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.
8406
- * * 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.
8407
- *
8408
- * @param request CreateScalingRuleRequest
8409
- * @return CreateScalingRuleResponse
8660
+ * @summary Creates a scaling rule.
8661
+ *
8662
+ * @description ## Description
8663
+ * 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:
8664
+ * * 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.
8665
+ * * 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.
8666
+ * Before you call this operation, take note of the following items:
8667
+ * * 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.
8668
+ * * 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.
8669
+ * * 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.
8670
+ * * 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.
8671
+ * * You can create only a limited number of scaling rules for a scaling group. For more information, see the "Limits" topic.
8672
+ * * The unique identifier (ScalingRuleAri) of a scaling rule can be used by the following operations:
8673
+ * * 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.
8674
+ * * 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.
8675
+ *
8676
+ * @param request CreateScalingRuleRequest
8677
+ * @return CreateScalingRuleResponse
8410
8678
  */
8411
8679
  createScalingRule(request: CreateScalingRuleRequest): Promise<CreateScalingRuleResponse>;
8412
8680
  /**
8413
- * * 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.
8414
- * * 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.``
8415
- * * A scheduled task supports the following scaling methods:
8416
- * * `ScheduledAction`: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
8417
- * * `ScalingGroupId`: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you created the scheduled task.
8418
- * > You cannot specify the `ScheduledAction` and ScalingGroupId parameters at the same time.
8419
- *
8420
- * @param request CreateScheduledTaskRequest
8421
- * @param runtime runtime options for this request RuntimeOptions
8422
- * @return CreateScheduledTaskResponse
8681
+ * @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.
8682
+ *
8683
+ * @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.
8684
+ * * 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.``
8685
+ * * A scheduled task supports the following scaling methods:
8686
+ * * `ScheduledAction`: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
8687
+ * * `ScalingGroupId`: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you created the scheduled task.
8688
+ * > You cannot specify the `ScheduledAction` and ScalingGroupId parameters at the same time.
8689
+ *
8690
+ * @param request CreateScheduledTaskRequest
8691
+ * @param runtime runtime options for this request RuntimeOptions
8692
+ * @return CreateScheduledTaskResponse
8423
8693
  */
8424
8694
  createScheduledTaskWithOptions(request: CreateScheduledTaskRequest, runtime: $Util.RuntimeOptions): Promise<CreateScheduledTaskResponse>;
8425
8695
  /**
8426
- * * 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.
8427
- * * 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.``
8428
- * * A scheduled task supports the following scaling methods:
8429
- * * `ScheduledAction`: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
8430
- * * `ScalingGroupId`: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you created the scheduled task.
8431
- * > You cannot specify the `ScheduledAction` and ScalingGroupId parameters at the same time.
8432
- *
8433
- * @param request CreateScheduledTaskRequest
8434
- * @return CreateScheduledTaskResponse
8696
+ * @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.
8697
+ *
8698
+ * @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.
8699
+ * * 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.``
8700
+ * * A scheduled task supports the following scaling methods:
8701
+ * * `ScheduledAction`: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
8702
+ * * `ScalingGroupId`: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you created the scheduled task.
8703
+ * > You cannot specify the `ScheduledAction` and ScalingGroupId parameters at the same time.
8704
+ *
8705
+ * @param request CreateScheduledTaskRequest
8706
+ * @return CreateScheduledTaskResponse
8435
8707
  */
8436
8708
  createScheduledTask(request: CreateScheduledTaskRequest): Promise<CreateScheduledTaskResponse>;
8709
+ /**
8710
+ * @summary Deactivates a scaling configuration.
8711
+ *
8712
+ * @description * You can call this operation to deactivate a scaling configuration only in a disabled scaling group.
8713
+ *
8714
+ * @param request DeactivateScalingConfigurationRequest
8715
+ * @param runtime runtime options for this request RuntimeOptions
8716
+ * @return DeactivateScalingConfigurationResponse
8717
+ */
8437
8718
  deactivateScalingConfigurationWithOptions(request: DeactivateScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeactivateScalingConfigurationResponse>;
8719
+ /**
8720
+ * @summary Deactivates a scaling configuration.
8721
+ *
8722
+ * @description * You can call this operation to deactivate a scaling configuration only in a disabled scaling group.
8723
+ *
8724
+ * @param request DeactivateScalingConfigurationRequest
8725
+ * @return DeactivateScalingConfigurationResponse
8726
+ */
8438
8727
  deactivateScalingConfiguration(request: DeactivateScalingConfigurationRequest): Promise<DeactivateScalingConfigurationResponse>;
8728
+ /**
8729
+ * @summary Deletes an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you no longer need an event-triggered task, you can call the DeleteAlarm operation to delete it.
8730
+ *
8731
+ * @param request DeleteAlarmRequest
8732
+ * @param runtime runtime options for this request RuntimeOptions
8733
+ * @return DeleteAlarmResponse
8734
+ */
8439
8735
  deleteAlarmWithOptions(request: DeleteAlarmRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAlarmResponse>;
8736
+ /**
8737
+ * @summary Deletes an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you no longer need an event-triggered task, you can call the DeleteAlarm operation to delete it.
8738
+ *
8739
+ * @param request DeleteAlarmRequest
8740
+ * @return DeleteAlarmResponse
8741
+ */
8440
8742
  deleteAlarm(request: DeleteAlarmRequest): Promise<DeleteAlarmResponse>;
8441
8743
  /**
8442
- * You cannot delete a scaling configuration that is used to create elastic container instances in the following scenarios:
8443
- * * The scaling configuration is in the Active state.
8444
- * * The scaling group contains elastic container instances that are created based on the scaling configuration.
8445
- *
8446
- * @param request DeleteEciScalingConfigurationRequest
8447
- * @param runtime runtime options for this request RuntimeOptions
8448
- * @return DeleteEciScalingConfigurationResponse
8744
+ * @summary Deletes a scaling configuration of the Elastic Container Instance type. If the scaling configuration of a scaling group is in the Inactive state and the scaling group contains no elastic container instances created from the scaling configuration, you can call the DeleteEciScalingConfiguration operation to delete the scaling configuration to free up the scaling configuration quota.
8745
+ *
8746
+ * @description You cannot call this operation to delete a scaling configuration in the following scenarios:
8747
+ * * The scaling configuration is in the Active state.
8748
+ * * The scaling group contains elastic container instances created from the scaling configuration.
8749
+ *
8750
+ * @param request DeleteEciScalingConfigurationRequest
8751
+ * @param runtime runtime options for this request RuntimeOptions
8752
+ * @return DeleteEciScalingConfigurationResponse
8449
8753
  */
8450
8754
  deleteEciScalingConfigurationWithOptions(request: DeleteEciScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteEciScalingConfigurationResponse>;
8451
8755
  /**
8452
- * You cannot delete a scaling configuration that is used to create elastic container instances in the following scenarios:
8453
- * * The scaling configuration is in the Active state.
8454
- * * The scaling group contains elastic container instances that are created based on the scaling configuration.
8455
- *
8456
- * @param request DeleteEciScalingConfigurationRequest
8457
- * @return DeleteEciScalingConfigurationResponse
8756
+ * @summary Deletes a scaling configuration of the Elastic Container Instance type. If the scaling configuration of a scaling group is in the Inactive state and the scaling group contains no elastic container instances created from the scaling configuration, you can call the DeleteEciScalingConfiguration operation to delete the scaling configuration to free up the scaling configuration quota.
8757
+ *
8758
+ * @description You cannot call this operation to delete a scaling configuration in the following scenarios:
8759
+ * * The scaling configuration is in the Active state.
8760
+ * * The scaling group contains elastic container instances created from the scaling configuration.
8761
+ *
8762
+ * @param request DeleteEciScalingConfigurationRequest
8763
+ * @return DeleteEciScalingConfigurationResponse
8458
8764
  */
8459
8765
  deleteEciScalingConfiguration(request: DeleteEciScalingConfigurationRequest): Promise<DeleteEciScalingConfigurationResponse>;
8766
+ /**
8767
+ * @summary Deletes a lifecycle hook.
8768
+ *
8769
+ * @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:
8770
+ * * 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.
8771
+ * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. In this case, the ScalingGroupId parameter and the LifecycleHookName parameter are ignored.
8772
+ *
8773
+ * @param request DeleteLifecycleHookRequest
8774
+ * @param runtime runtime options for this request RuntimeOptions
8775
+ * @return DeleteLifecycleHookResponse
8776
+ */
8460
8777
  deleteLifecycleHookWithOptions(request: DeleteLifecycleHookRequest, runtime: $Util.RuntimeOptions): Promise<DeleteLifecycleHookResponse>;
8778
+ /**
8779
+ * @summary Deletes a lifecycle hook.
8780
+ *
8781
+ * @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:
8782
+ * * 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.
8783
+ * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. In this case, the ScalingGroupId parameter and the LifecycleHookName parameter are ignored.
8784
+ *
8785
+ * @param request DeleteLifecycleHookRequest
8786
+ * @return DeleteLifecycleHookResponse
8787
+ */
8461
8788
  deleteLifecycleHook(request: DeleteLifecycleHookRequest): Promise<DeleteLifecycleHookResponse>;
8789
+ /**
8790
+ * @summary Deletes event notification rules. The event notification feature facilitates efficient issue identification and event management by automatically forwarding notifications from Auto Scaling to designated endpoints such as CloudMonitor or Message Service (MNS) topics and queues. If you no longer require an event notification rule, you can call the DeleteNotificationConfiguration operation to delete it.
8791
+ *
8792
+ * @param request DeleteNotificationConfigurationRequest
8793
+ * @param runtime runtime options for this request RuntimeOptions
8794
+ * @return DeleteNotificationConfigurationResponse
8795
+ */
8462
8796
  deleteNotificationConfigurationWithOptions(request: DeleteNotificationConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteNotificationConfigurationResponse>;
8797
+ /**
8798
+ * @summary Deletes event notification rules. The event notification feature facilitates efficient issue identification and event management by automatically forwarding notifications from Auto Scaling to designated endpoints such as CloudMonitor or Message Service (MNS) topics and queues. If you no longer require an event notification rule, you can call the DeleteNotificationConfiguration operation to delete it.
8799
+ *
8800
+ * @param request DeleteNotificationConfigurationRequest
8801
+ * @return DeleteNotificationConfigurationResponse
8802
+ */
8463
8803
  deleteNotificationConfiguration(request: DeleteNotificationConfigurationRequest): Promise<DeleteNotificationConfigurationResponse>;
8464
8804
  /**
8465
- * You cannot delete a scaling configuration in one of the following scenarios:
8466
- * * The scaling configuration in your scaling group is in the Active state.
8467
- * * The scaling group contains ECS instances that were created based on the scaling configuration.
8468
- *
8469
- * @param request DeleteScalingConfigurationRequest
8470
- * @param runtime runtime options for this request RuntimeOptions
8471
- * @return DeleteScalingConfigurationResponse
8805
+ * @summary Deletes a scaling configuration that is used to create Elastic Compute Service (ECS) instances.
8806
+ *
8807
+ * @description You cannot delete a scaling configuration in one of the following scenarios:
8808
+ * * The scaling configuration in your scaling group is in the Active state.
8809
+ * * The scaling group contains ECS instances that were created based on the scaling configuration.
8810
+ *
8811
+ * @param request DeleteScalingConfigurationRequest
8812
+ * @param runtime runtime options for this request RuntimeOptions
8813
+ * @return DeleteScalingConfigurationResponse
8472
8814
  */
8473
8815
  deleteScalingConfigurationWithOptions(request: DeleteScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteScalingConfigurationResponse>;
8474
8816
  /**
8475
- * You cannot delete a scaling configuration in one of the following scenarios:
8476
- * * The scaling configuration in your scaling group is in the Active state.
8477
- * * The scaling group contains ECS instances that were created based on the scaling configuration.
8478
- *
8479
- * @param request DeleteScalingConfigurationRequest
8480
- * @return DeleteScalingConfigurationResponse
8817
+ * @summary Deletes a scaling configuration that is used to create Elastic Compute Service (ECS) instances.
8818
+ *
8819
+ * @description You cannot delete a scaling configuration in one of the following scenarios:
8820
+ * * The scaling configuration in your scaling group is in the Active state.
8821
+ * * The scaling group contains ECS instances that were created based on the scaling configuration.
8822
+ *
8823
+ * @param request DeleteScalingConfigurationRequest
8824
+ * @return DeleteScalingConfigurationResponse
8481
8825
  */
8482
8826
  deleteScalingConfiguration(request: DeleteScalingConfigurationRequest): Promise<DeleteScalingConfigurationResponse>;
8827
+ /**
8828
+ * @summary Deletes a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can create scaling groups to manage your computing power with ease. The computing power refers to the instances that provide the computing capability. If you no longer require a scaling group, you can call the DeleteScalingGroup operation to delete it to free up the scaling group quota.
8829
+ *
8830
+ * @description Before you call the DeleteScalingGroup operation, take note of the following items:
8831
+ * * If you delete a scaling group, the scaling configurations, scaling rules, scaling activities, and scaling requests related to the scaling group are also deleted.
8832
+ * * If you delete a scaling group, the scheduled tasks and event-triggered tasks of the scaling group are not deleted. The Server Load Balancer (SLB) instances and ApsaraDB RDS instances that are attached to the scaling group are also not deleted.
8833
+ * * If the scaling group that you want to delete contains ECS instances or elastic container instances that are in the In Service state, Auto Scaling stops the instances and then removes all manually added instances from the scaling group or releases all automatically created instances in the scaling group before the scaling group is deleted.
8834
+ * **
8835
+ * **Note** Before you delete a scaling group, make sure that the Deletion Protection feature is disabled. If you have enabled the Deletion Protection feature for a scaling group, disable the feature on the Modify Scaling Group page before you delete the scaling group.
8836
+ * * If you do not disable the Deletion Protection feature for a scaling group, you cannot delete the scaling group by using the Auto Scaling console or calling this operation. The Deletion Protection feature is an effective measure to safeguard scaling groups against unintended deletion.
8837
+ * * Prior to deleting a scaling group, make sure that your ECS instances within the scaling group are safeguarded against unintended release. Even if you have already enabled the Release Protection feature for the ECS instances, you must manually put these ECS instances into the Protected state. Doing so guarantees that the ECS instances will not be forcibly released during the deletion process of the scaling group, providing an extra layer of security.
8838
+ * **
8839
+ * **Note** Before you delete a scaling group, we recommend that you enable the Deletion Protection feature for ECS instances that you want to retain. This action guarantees that the ECS instances are not forcibly released after you delete the scaling group. For more information, see [SetInstancesProtection](https://help.aliyun.com/document_detail/459342.html).
8840
+ *
8841
+ * @param request DeleteScalingGroupRequest
8842
+ * @param runtime runtime options for this request RuntimeOptions
8843
+ * @return DeleteScalingGroupResponse
8844
+ */
8483
8845
  deleteScalingGroupWithOptions(request: DeleteScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteScalingGroupResponse>;
8846
+ /**
8847
+ * @summary Deletes a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can create scaling groups to manage your computing power with ease. The computing power refers to the instances that provide the computing capability. If you no longer require a scaling group, you can call the DeleteScalingGroup operation to delete it to free up the scaling group quota.
8848
+ *
8849
+ * @description Before you call the DeleteScalingGroup operation, take note of the following items:
8850
+ * * If you delete a scaling group, the scaling configurations, scaling rules, scaling activities, and scaling requests related to the scaling group are also deleted.
8851
+ * * If you delete a scaling group, the scheduled tasks and event-triggered tasks of the scaling group are not deleted. The Server Load Balancer (SLB) instances and ApsaraDB RDS instances that are attached to the scaling group are also not deleted.
8852
+ * * If the scaling group that you want to delete contains ECS instances or elastic container instances that are in the In Service state, Auto Scaling stops the instances and then removes all manually added instances from the scaling group or releases all automatically created instances in the scaling group before the scaling group is deleted.
8853
+ * **
8854
+ * **Note** Before you delete a scaling group, make sure that the Deletion Protection feature is disabled. If you have enabled the Deletion Protection feature for a scaling group, disable the feature on the Modify Scaling Group page before you delete the scaling group.
8855
+ * * If you do not disable the Deletion Protection feature for a scaling group, you cannot delete the scaling group by using the Auto Scaling console or calling this operation. The Deletion Protection feature is an effective measure to safeguard scaling groups against unintended deletion.
8856
+ * * Prior to deleting a scaling group, make sure that your ECS instances within the scaling group are safeguarded against unintended release. Even if you have already enabled the Release Protection feature for the ECS instances, you must manually put these ECS instances into the Protected state. Doing so guarantees that the ECS instances will not be forcibly released during the deletion process of the scaling group, providing an extra layer of security.
8857
+ * **
8858
+ * **Note** Before you delete a scaling group, we recommend that you enable the Deletion Protection feature for ECS instances that you want to retain. This action guarantees that the ECS instances are not forcibly released after you delete the scaling group. For more information, see [SetInstancesProtection](https://help.aliyun.com/document_detail/459342.html).
8859
+ *
8860
+ * @param request DeleteScalingGroupRequest
8861
+ * @return DeleteScalingGroupResponse
8862
+ */
8484
8863
  deleteScalingGroup(request: DeleteScalingGroupRequest): Promise<DeleteScalingGroupResponse>;
8864
+ /**
8865
+ * @summary Deletes a scaling rule.
8866
+ *
8867
+ * @param request DeleteScalingRuleRequest
8868
+ * @param runtime runtime options for this request RuntimeOptions
8869
+ * @return DeleteScalingRuleResponse
8870
+ */
8485
8871
  deleteScalingRuleWithOptions(request: DeleteScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<DeleteScalingRuleResponse>;
8872
+ /**
8873
+ * @summary Deletes a scaling rule.
8874
+ *
8875
+ * @param request DeleteScalingRuleRequest
8876
+ * @return DeleteScalingRuleResponse
8877
+ */
8486
8878
  deleteScalingRule(request: DeleteScalingRuleRequest): Promise<DeleteScalingRuleResponse>;
8879
+ /**
8880
+ * @summary Deletes scheduled tasks. For workloads with predictable patterns, you can create scheduled tasks to align with your business requirements and optimize resource utilization for cost savings. These tasks automatically ensure that sufficient computing resources are provisioned in anticipation of peak hours and efficiently release unused resources during off-peak hours, thereby streamlining operational efficiency and reducing expenses. If you no longer require a scheduled task, you can call the DeleteScheduledTask operation to delete it.
8881
+ *
8882
+ * @param request DeleteScheduledTaskRequest
8883
+ * @param runtime runtime options for this request RuntimeOptions
8884
+ * @return DeleteScheduledTaskResponse
8885
+ */
8487
8886
  deleteScheduledTaskWithOptions(request: DeleteScheduledTaskRequest, runtime: $Util.RuntimeOptions): Promise<DeleteScheduledTaskResponse>;
8887
+ /**
8888
+ * @summary Deletes scheduled tasks. For workloads with predictable patterns, you can create scheduled tasks to align with your business requirements and optimize resource utilization for cost savings. These tasks automatically ensure that sufficient computing resources are provisioned in anticipation of peak hours and efficiently release unused resources during off-peak hours, thereby streamlining operational efficiency and reducing expenses. If you no longer require a scheduled task, you can call the DeleteScheduledTask operation to delete it.
8889
+ *
8890
+ * @param request DeleteScheduledTaskRequest
8891
+ * @return DeleteScheduledTaskResponse
8892
+ */
8488
8893
  deleteScheduledTask(request: DeleteScheduledTaskRequest): Promise<DeleteScheduledTaskResponse>;
8894
+ /**
8895
+ * @summary Queries event-triggered tasks.
8896
+ *
8897
+ * @param request DescribeAlarmsRequest
8898
+ * @param runtime runtime options for this request RuntimeOptions
8899
+ * @return DescribeAlarmsResponse
8900
+ */
8489
8901
  describeAlarmsWithOptions(request: DescribeAlarmsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAlarmsResponse>;
8902
+ /**
8903
+ * @summary Queries event-triggered tasks.
8904
+ *
8905
+ * @param request DescribeAlarmsRequest
8906
+ * @return DescribeAlarmsResponse
8907
+ */
8490
8908
  describeAlarms(request: DescribeAlarmsRequest): Promise<DescribeAlarmsResponse>;
8909
+ /**
8910
+ * @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.
8911
+ *
8912
+ * @param request DescribeEciScalingConfigurationDetailRequest
8913
+ * @param runtime runtime options for this request RuntimeOptions
8914
+ * @return DescribeEciScalingConfigurationDetailResponse
8915
+ */
8491
8916
  describeEciScalingConfigurationDetailWithOptions(request: DescribeEciScalingConfigurationDetailRequest, runtime: $Util.RuntimeOptions): Promise<DescribeEciScalingConfigurationDetailResponse>;
8917
+ /**
8918
+ * @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.
8919
+ *
8920
+ * @param request DescribeEciScalingConfigurationDetailRequest
8921
+ * @return DescribeEciScalingConfigurationDetailResponse
8922
+ */
8492
8923
  describeEciScalingConfigurationDetail(request: DescribeEciScalingConfigurationDetailRequest): Promise<DescribeEciScalingConfigurationDetailResponse>;
8924
+ /**
8925
+ * @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.
8926
+ *
8927
+ * @param request DescribeEciScalingConfigurationsRequest
8928
+ * @param runtime runtime options for this request RuntimeOptions
8929
+ * @return DescribeEciScalingConfigurationsResponse
8930
+ */
8493
8931
  describeEciScalingConfigurationsWithOptions(request: DescribeEciScalingConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeEciScalingConfigurationsResponse>;
8932
+ /**
8933
+ * @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.
8934
+ *
8935
+ * @param request DescribeEciScalingConfigurationsRequest
8936
+ * @return DescribeEciScalingConfigurationsResponse
8937
+ */
8494
8938
  describeEciScalingConfigurations(request: DescribeEciScalingConfigurationsRequest): Promise<DescribeEciScalingConfigurationsResponse>;
8495
8939
  /**
8496
- * 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:
8497
- * * 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.
8498
- * * If a lifecycle action is in the Timeout state, the lifecycle hook that triggers the lifecycle action expires and ECS instances are added to or removed from a scaling group.
8499
- * * If a lifecycle action is in the Completed state, you manually end the lifecycle hook that triggers the lifecycle action ahead of schedule.
8500
- * If you do not specify the action to perform, such as execute a specific OOS template, after a lifecycle hook ends, you can call this operation to obtain the token of the lifecycle action that corresponds to the lifecycle hook. Then, you can specify a custom action to perform after the lifecycle hook ends.
8501
- *
8502
- * @param request DescribeLifecycleActionsRequest
8503
- * @param runtime runtime options for this request RuntimeOptions
8504
- * @return DescribeLifecycleActionsResponse
8940
+ * @summary Queries lifecycle actions.
8941
+ *
8942
+ * @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:
8943
+ * * 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.
8944
+ * * If a lifecycle action is in the Timeout state, the lifecycle hook that triggers the lifecycle action expires and ECS instances are added to or removed from a scaling group.
8945
+ * * If a lifecycle action is in the Completed state, you manually end the lifecycle hook that triggers the lifecycle action ahead of schedule.
8946
+ * If you do not specify the action to perform, such as execute a specific OOS template, after a lifecycle hook ends, you can call this operation to obtain the token of the lifecycle action that corresponds to the lifecycle hook. Then, you can specify a custom action to perform after the lifecycle hook ends.
8947
+ *
8948
+ * @param request DescribeLifecycleActionsRequest
8949
+ * @param runtime runtime options for this request RuntimeOptions
8950
+ * @return DescribeLifecycleActionsResponse
8505
8951
  */
8506
8952
  describeLifecycleActionsWithOptions(request: DescribeLifecycleActionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLifecycleActionsResponse>;
8507
8953
  /**
8508
- * 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:
8509
- * * 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.
8510
- * * If a lifecycle action is in the Timeout state, the lifecycle hook that triggers the lifecycle action expires and ECS instances are added to or removed from a scaling group.
8511
- * * If a lifecycle action is in the Completed state, you manually end the lifecycle hook that triggers the lifecycle action ahead of schedule.
8512
- * If you do not specify the action to perform, such as execute a specific OOS template, after a lifecycle hook ends, you can call this operation to obtain the token of the lifecycle action that corresponds to the lifecycle hook. Then, you can specify a custom action to perform after the lifecycle hook ends.
8513
- *
8514
- * @param request DescribeLifecycleActionsRequest
8515
- * @return DescribeLifecycleActionsResponse
8954
+ * @summary Queries lifecycle actions.
8955
+ *
8956
+ * @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:
8957
+ * * 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.
8958
+ * * If a lifecycle action is in the Timeout state, the lifecycle hook that triggers the lifecycle action expires and ECS instances are added to or removed from a scaling group.
8959
+ * * If a lifecycle action is in the Completed state, you manually end the lifecycle hook that triggers the lifecycle action ahead of schedule.
8960
+ * If you do not specify the action to perform, such as execute a specific OOS template, after a lifecycle hook ends, you can call this operation to obtain the token of the lifecycle action that corresponds to the lifecycle hook. Then, you can specify a custom action to perform after the lifecycle hook ends.
8961
+ *
8962
+ * @param request DescribeLifecycleActionsRequest
8963
+ * @return DescribeLifecycleActionsResponse
8516
8964
  */
8517
8965
  describeLifecycleActions(request: DescribeLifecycleActionsRequest): Promise<DescribeLifecycleActionsResponse>;
8966
+ /**
8967
+ * @summary Queries lifecycle hooks.
8968
+ *
8969
+ * @description You can use one of the following methods to query lifecycle hooks:
8970
+ * * 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.
8971
+ * * Specify the scaling group ID by using the ScalingGroupId parameter.
8972
+ * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter at the same time.
8973
+ *
8974
+ * @param request DescribeLifecycleHooksRequest
8975
+ * @param runtime runtime options for this request RuntimeOptions
8976
+ * @return DescribeLifecycleHooksResponse
8977
+ */
8518
8978
  describeLifecycleHooksWithOptions(request: DescribeLifecycleHooksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLifecycleHooksResponse>;
8979
+ /**
8980
+ * @summary Queries lifecycle hooks.
8981
+ *
8982
+ * @description You can use one of the following methods to query lifecycle hooks:
8983
+ * * 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.
8984
+ * * Specify the scaling group ID by using the ScalingGroupId parameter.
8985
+ * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter at the same time.
8986
+ *
8987
+ * @param request DescribeLifecycleHooksRequest
8988
+ * @return DescribeLifecycleHooksResponse
8989
+ */
8519
8990
  describeLifecycleHooks(request: DescribeLifecycleHooksRequest): Promise<DescribeLifecycleHooksResponse>;
8991
+ /**
8992
+ * @summary Queries resource quotas. You can call the DescribeLimitation operation to query the upper limits on resources such as scheduled tasks that can be created in a scaling group, load balancers that can be attached to a scaling group, instances that can be contained in a scaling group, and scaling configurations that can be created in a scaling group.
8993
+ *
8994
+ * @param request DescribeLimitationRequest
8995
+ * @param runtime runtime options for this request RuntimeOptions
8996
+ * @return DescribeLimitationResponse
8997
+ */
8520
8998
  describeLimitationWithOptions(request: DescribeLimitationRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLimitationResponse>;
8999
+ /**
9000
+ * @summary Queries resource quotas. You can call the DescribeLimitation operation to query the upper limits on resources such as scheduled tasks that can be created in a scaling group, load balancers that can be attached to a scaling group, instances that can be contained in a scaling group, and scaling configurations that can be created in a scaling group.
9001
+ *
9002
+ * @param request DescribeLimitationRequest
9003
+ * @return DescribeLimitationResponse
9004
+ */
8521
9005
  describeLimitation(request: DescribeLimitationRequest): Promise<DescribeLimitationResponse>;
9006
+ /**
9007
+ * @summary Queries event notifications.
9008
+ *
9009
+ * @param request DescribeNotificationConfigurationsRequest
9010
+ * @param runtime runtime options for this request RuntimeOptions
9011
+ * @return DescribeNotificationConfigurationsResponse
9012
+ */
8522
9013
  describeNotificationConfigurationsWithOptions(request: DescribeNotificationConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeNotificationConfigurationsResponse>;
9014
+ /**
9015
+ * @summary Queries event notifications.
9016
+ *
9017
+ * @param request DescribeNotificationConfigurationsRequest
9018
+ * @return DescribeNotificationConfigurationsResponse
9019
+ */
8523
9020
  describeNotificationConfigurations(request: DescribeNotificationConfigurationsRequest): Promise<DescribeNotificationConfigurationsResponse>;
9021
+ /**
9022
+ * @summary Queries notification types.
9023
+ *
9024
+ * @param request DescribeNotificationTypesRequest
9025
+ * @param runtime runtime options for this request RuntimeOptions
9026
+ * @return DescribeNotificationTypesResponse
9027
+ */
8524
9028
  describeNotificationTypesWithOptions(request: DescribeNotificationTypesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeNotificationTypesResponse>;
9029
+ /**
9030
+ * @summary Queries notification types.
9031
+ *
9032
+ * @param request DescribeNotificationTypesRequest
9033
+ * @return DescribeNotificationTypesResponse
9034
+ */
8525
9035
  describeNotificationTypes(request: DescribeNotificationTypesRequest): Promise<DescribeNotificationTypesResponse>;
9036
+ /**
9037
+ * @summary DescribePatternTypes
9038
+ *
9039
+ * @param request DescribePatternTypesRequest
9040
+ * @param runtime runtime options for this request RuntimeOptions
9041
+ * @return DescribePatternTypesResponse
9042
+ */
9043
+ describePatternTypesWithOptions(request: DescribePatternTypesRequest, runtime: $Util.RuntimeOptions): Promise<DescribePatternTypesResponse>;
9044
+ /**
9045
+ * @summary DescribePatternTypes
9046
+ *
9047
+ * @param request DescribePatternTypesRequest
9048
+ * @return DescribePatternTypesResponse
9049
+ */
9050
+ describePatternTypes(request: DescribePatternTypesRequest): Promise<DescribePatternTypesResponse>;
9051
+ /**
9052
+ * @summary Queries regions. Before you activate Auto Scaling, you can call the DescribeRegions operation to query the regions where Auto Scaling is officially launched. This preliminary step facilitates the strategic selection of both the optimal region and availability zones for activating Auto Scaling, thereby guaranteeing the finest access speeds and operational efficiency within your chosen geographical area.
9053
+ *
9054
+ * @param request DescribeRegionsRequest
9055
+ * @param runtime runtime options for this request RuntimeOptions
9056
+ * @return DescribeRegionsResponse
9057
+ */
8526
9058
  describeRegionsWithOptions(request: DescribeRegionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRegionsResponse>;
9059
+ /**
9060
+ * @summary Queries regions. Before you activate Auto Scaling, you can call the DescribeRegions operation to query the regions where Auto Scaling is officially launched. This preliminary step facilitates the strategic selection of both the optimal region and availability zones for activating Auto Scaling, thereby guaranteeing the finest access speeds and operational efficiency within your chosen geographical area.
9061
+ *
9062
+ * @param request DescribeRegionsRequest
9063
+ * @return DescribeRegionsResponse
9064
+ */
8527
9065
  describeRegions(request: DescribeRegionsRequest): Promise<DescribeRegionsResponse>;
8528
9066
  /**
8529
- * You can specify a scaling group ID to query all scaling activities in the scaling group.
8530
- * You can filter query results based on the status of scaling activities.
8531
- * You can query scaling activities that are executed in the previous 30 days.
8532
- *
8533
- * @param request DescribeScalingActivitiesRequest
8534
- * @param runtime runtime options for this request RuntimeOptions
8535
- * @return DescribeScalingActivitiesResponse
9067
+ * @summary Queries scaling activities.
9068
+ *
9069
+ * @description You can specify a scaling group ID to query all scaling activities in the scaling group.
9070
+ * You can filter query results based on the status of scaling activities.
9071
+ * You can query scaling activities that are executed in the previous 30 days.
9072
+ *
9073
+ * @param request DescribeScalingActivitiesRequest
9074
+ * @param runtime runtime options for this request RuntimeOptions
9075
+ * @return DescribeScalingActivitiesResponse
8536
9076
  */
8537
9077
  describeScalingActivitiesWithOptions(request: DescribeScalingActivitiesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingActivitiesResponse>;
8538
9078
  /**
8539
- * You can specify a scaling group ID to query all scaling activities in the scaling group.
8540
- * You can filter query results based on the status of scaling activities.
8541
- * You can query scaling activities that are executed in the previous 30 days.
8542
- *
8543
- * @param request DescribeScalingActivitiesRequest
8544
- * @return DescribeScalingActivitiesResponse
9079
+ * @summary Queries scaling activities.
9080
+ *
9081
+ * @description You can specify a scaling group ID to query all scaling activities in the scaling group.
9082
+ * You can filter query results based on the status of scaling activities.
9083
+ * You can query scaling activities that are executed in the previous 30 days.
9084
+ *
9085
+ * @param request DescribeScalingActivitiesRequest
9086
+ * @return DescribeScalingActivitiesResponse
8545
9087
  */
8546
9088
  describeScalingActivities(request: DescribeScalingActivitiesRequest): Promise<DescribeScalingActivitiesResponse>;
9089
+ /**
9090
+ * @summary Queries the details about a scaling activity.
9091
+ *
9092
+ * @param request DescribeScalingActivityDetailRequest
9093
+ * @param runtime runtime options for this request RuntimeOptions
9094
+ * @return DescribeScalingActivityDetailResponse
9095
+ */
8547
9096
  describeScalingActivityDetailWithOptions(request: DescribeScalingActivityDetailRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingActivityDetailResponse>;
9097
+ /**
9098
+ * @summary Queries the details about a scaling activity.
9099
+ *
9100
+ * @param request DescribeScalingActivityDetailRequest
9101
+ * @return DescribeScalingActivityDetailResponse
9102
+ */
8548
9103
  describeScalingActivityDetail(request: DescribeScalingActivityDetailRequest): Promise<DescribeScalingActivityDetailResponse>;
9104
+ /**
9105
+ * @summary Queries scaling configurations.
9106
+ *
9107
+ * @param request DescribeScalingConfigurationsRequest
9108
+ * @param runtime runtime options for this request RuntimeOptions
9109
+ * @return DescribeScalingConfigurationsResponse
9110
+ */
8549
9111
  describeScalingConfigurationsWithOptions(request: DescribeScalingConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingConfigurationsResponse>;
9112
+ /**
9113
+ * @summary Queries scaling configurations.
9114
+ *
9115
+ * @param request DescribeScalingConfigurationsRequest
9116
+ * @return DescribeScalingConfigurationsResponse
9117
+ */
8550
9118
  describeScalingConfigurations(request: DescribeScalingConfigurationsRequest): Promise<DescribeScalingConfigurationsResponse>;
9119
+ /**
9120
+ * @summary Queries a scaling group. You can call the DescribeScalingGroupDetail operation to query the basic information, instances, and scaling configurations of a scaling group. If you set OutputFormat to yaml, a Kubernetes Deployment file that is in the YAML format is returned.
9121
+ *
9122
+ * @param request DescribeScalingGroupDetailRequest
9123
+ * @param runtime runtime options for this request RuntimeOptions
9124
+ * @return DescribeScalingGroupDetailResponse
9125
+ */
8551
9126
  describeScalingGroupDetailWithOptions(request: DescribeScalingGroupDetailRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingGroupDetailResponse>;
9127
+ /**
9128
+ * @summary Queries a scaling group. You can call the DescribeScalingGroupDetail operation to query the basic information, instances, and scaling configurations of a scaling group. If you set OutputFormat to yaml, a Kubernetes Deployment file that is in the YAML format is returned.
9129
+ *
9130
+ * @param request DescribeScalingGroupDetailRequest
9131
+ * @return DescribeScalingGroupDetailResponse
9132
+ */
8552
9133
  describeScalingGroupDetail(request: DescribeScalingGroupDetailRequest): Promise<DescribeScalingGroupDetailResponse>;
9134
+ /**
9135
+ * @summary Queries scaling groups. If you want to query the basic information, instances, and scaling configurations of a scaling group, you can call the DescribeScalingGroups operation.
9136
+ *
9137
+ * @param request DescribeScalingGroupsRequest
9138
+ * @param runtime runtime options for this request RuntimeOptions
9139
+ * @return DescribeScalingGroupsResponse
9140
+ */
8553
9141
  describeScalingGroupsWithOptions(request: DescribeScalingGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingGroupsResponse>;
9142
+ /**
9143
+ * @summary Queries scaling groups. If you want to query the basic information, instances, and scaling configurations of a scaling group, you can call the DescribeScalingGroups operation.
9144
+ *
9145
+ * @param request DescribeScalingGroupsRequest
9146
+ * @return DescribeScalingGroupsResponse
9147
+ */
8554
9148
  describeScalingGroups(request: DescribeScalingGroupsRequest): Promise<DescribeScalingGroupsResponse>;
9149
+ /**
9150
+ * @summary Queries the Elastic Compute Service (ECS) instances in a scaling group
9151
+ *
9152
+ * @param request DescribeScalingInstancesRequest
9153
+ * @param runtime runtime options for this request RuntimeOptions
9154
+ * @return DescribeScalingInstancesResponse
9155
+ */
8555
9156
  describeScalingInstancesWithOptions(request: DescribeScalingInstancesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingInstancesResponse>;
9157
+ /**
9158
+ * @summary Queries the Elastic Compute Service (ECS) instances in a scaling group
9159
+ *
9160
+ * @param request DescribeScalingInstancesRequest
9161
+ * @return DescribeScalingInstancesResponse
9162
+ */
8556
9163
  describeScalingInstances(request: DescribeScalingInstancesRequest): Promise<DescribeScalingInstancesResponse>;
8557
9164
  /**
8558
- * You can specify a scaling group ID to query all scaling rules in the scaling group. You can also specify the scaling rule ID, name, unique identifier, and type in the request parameters as filter conditions.
8559
- *
8560
- * @param request DescribeScalingRulesRequest
8561
- * @param runtime runtime options for this request RuntimeOptions
8562
- * @return DescribeScalingRulesResponse
9165
+ * @summary Queries all scaling rules in a scaling group.
9166
+ *
9167
+ * @description You can specify a scaling group ID to query all scaling rules in the scaling group. You can also specify the scaling rule ID, name, unique identifier, and type in the request parameters as filter conditions.
9168
+ *
9169
+ * @param request DescribeScalingRulesRequest
9170
+ * @param runtime runtime options for this request RuntimeOptions
9171
+ * @return DescribeScalingRulesResponse
8563
9172
  */
8564
9173
  describeScalingRulesWithOptions(request: DescribeScalingRulesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingRulesResponse>;
8565
9174
  /**
8566
- * You can specify a scaling group ID to query all scaling rules in the scaling group. You can also specify the scaling rule ID, name, unique identifier, and type in the request parameters as filter conditions.
8567
- *
8568
- * @param request DescribeScalingRulesRequest
8569
- * @return DescribeScalingRulesResponse
9175
+ * @summary Queries all scaling rules in a scaling group.
9176
+ *
9177
+ * @description You can specify a scaling group ID to query all scaling rules in the scaling group. You can also specify the scaling rule ID, name, unique identifier, and type in the request parameters as filter conditions.
9178
+ *
9179
+ * @param request DescribeScalingRulesRequest
9180
+ * @return DescribeScalingRulesResponse
8570
9181
  */
8571
9182
  describeScalingRules(request: DescribeScalingRulesRequest): Promise<DescribeScalingRulesResponse>;
9183
+ /**
9184
+ * @summary Queries scheduled tasks.
9185
+ *
9186
+ * @description You can query scheduled tasks by scaling rule, task ID, or task name.
9187
+ *
9188
+ * @param request DescribeScheduledTasksRequest
9189
+ * @param runtime runtime options for this request RuntimeOptions
9190
+ * @return DescribeScheduledTasksResponse
9191
+ */
8572
9192
  describeScheduledTasksWithOptions(request: DescribeScheduledTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScheduledTasksResponse>;
9193
+ /**
9194
+ * @summary Queries scheduled tasks.
9195
+ *
9196
+ * @description You can query scheduled tasks by scaling rule, task ID, or task name.
9197
+ *
9198
+ * @param request DescribeScheduledTasksRequest
9199
+ * @return DescribeScheduledTasksResponse
9200
+ */
8573
9201
  describeScheduledTasks(request: DescribeScheduledTasksRequest): Promise<DescribeScheduledTasksResponse>;
9202
+ /**
9203
+ * @summary Disassociates one or more Application Load Balancer (ALB) server groups from a scaling group.
9204
+ *
9205
+ * @param request DetachAlbServerGroupsRequest
9206
+ * @param runtime runtime options for this request RuntimeOptions
9207
+ * @return DetachAlbServerGroupsResponse
9208
+ */
8574
9209
  detachAlbServerGroupsWithOptions(request: DetachAlbServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DetachAlbServerGroupsResponse>;
9210
+ /**
9211
+ * @summary Disassociates one or more Application Load Balancer (ALB) server groups from a scaling group.
9212
+ *
9213
+ * @param request DetachAlbServerGroupsRequest
9214
+ * @return DetachAlbServerGroupsResponse
9215
+ */
8575
9216
  detachAlbServerGroups(request: DetachAlbServerGroupsRequest): Promise<DetachAlbServerGroupsResponse>;
9217
+ /**
9218
+ * @summary Disassociates one or more ApsaraDB RDS instances from a scaling group.
9219
+ *
9220
+ * @param request DetachDBInstancesRequest
9221
+ * @param runtime runtime options for this request RuntimeOptions
9222
+ * @return DetachDBInstancesResponse
9223
+ */
8576
9224
  detachDBInstancesWithOptions(request: DetachDBInstancesRequest, runtime: $Util.RuntimeOptions): Promise<DetachDBInstancesResponse>;
9225
+ /**
9226
+ * @summary Disassociates one or more ApsaraDB RDS instances from a scaling group.
9227
+ *
9228
+ * @param request DetachDBInstancesRequest
9229
+ * @return DetachDBInstancesResponse
9230
+ */
8577
9231
  detachDBInstances(request: DetachDBInstancesRequest): Promise<DetachDBInstancesResponse>;
8578
9232
  /**
8579
- * 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.
8580
- * After you remove an ECS instance or elastic container instance by calling the DetachInstances operation, the instance is not stopped or released.
8581
- * Before you call this operation, make sure that the following conditions are met:
8582
- * * The specified scaling group is enabled.
8583
- * * No scaling activities in the specified scaling group are in progress.
8584
- * > If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8585
- * 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.
8586
- * 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.
8587
- *
8588
- * @param request DetachInstancesRequest
8589
- * @param runtime runtime options for this request RuntimeOptions
8590
- * @return DetachInstancesResponse
9233
+ * @summary Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
9234
+ *
9235
+ * @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.
9236
+ * After you remove an ECS instance or elastic container instance by calling the DetachInstances operation, the instance is not stopped or released.
9237
+ * Before you call this operation, make sure that the following conditions are met:
9238
+ * * The specified scaling group is enabled.
9239
+ * * No scaling activities in the specified scaling group are in progress.
9240
+ * > If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9241
+ * 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.
9242
+ * 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.
9243
+ *
9244
+ * @param request DetachInstancesRequest
9245
+ * @param runtime runtime options for this request RuntimeOptions
9246
+ * @return DetachInstancesResponse
8591
9247
  */
8592
9248
  detachInstancesWithOptions(request: DetachInstancesRequest, runtime: $Util.RuntimeOptions): Promise<DetachInstancesResponse>;
8593
9249
  /**
8594
- * 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.
8595
- * After you remove an ECS instance or elastic container instance by calling the DetachInstances operation, the instance is not stopped or released.
8596
- * Before you call this operation, make sure that the following conditions are met:
8597
- * * The specified scaling group is enabled.
8598
- * * No scaling activities in the specified scaling group are in progress.
8599
- * > If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8600
- * 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.
8601
- * 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.
8602
- *
8603
- * @param request DetachInstancesRequest
8604
- * @return DetachInstancesResponse
9250
+ * @summary Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
9251
+ *
9252
+ * @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.
9253
+ * After you remove an ECS instance or elastic container instance by calling the DetachInstances operation, the instance is not stopped or released.
9254
+ * Before you call this operation, make sure that the following conditions are met:
9255
+ * * The specified scaling group is enabled.
9256
+ * * No scaling activities in the specified scaling group are in progress.
9257
+ * > If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9258
+ * 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.
9259
+ * 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.
9260
+ *
9261
+ * @param request DetachInstancesRequest
9262
+ * @return DetachInstancesResponse
8605
9263
  */
8606
9264
  detachInstances(request: DetachInstancesRequest): Promise<DetachInstancesResponse>;
9265
+ /**
9266
+ * @summary Detaches one or more Classic Load Balancer (CLB) instances from a scaling group.
9267
+ *
9268
+ * @param request DetachLoadBalancersRequest
9269
+ * @param runtime runtime options for this request RuntimeOptions
9270
+ * @return DetachLoadBalancersResponse
9271
+ */
8607
9272
  detachLoadBalancersWithOptions(request: DetachLoadBalancersRequest, runtime: $Util.RuntimeOptions): Promise<DetachLoadBalancersResponse>;
9273
+ /**
9274
+ * @summary Detaches one or more Classic Load Balancer (CLB) instances from a scaling group.
9275
+ *
9276
+ * @param request DetachLoadBalancersRequest
9277
+ * @return DetachLoadBalancersResponse
9278
+ */
8608
9279
  detachLoadBalancers(request: DetachLoadBalancersRequest): Promise<DetachLoadBalancersResponse>;
9280
+ /**
9281
+ * @summary Detaches one or more server groups from a scaling group. You can attach and detach the following server groups from a scaling group: Application Load Balancer (ALB) and Network Load Balancer (NLB) server groups.
9282
+ *
9283
+ * @param request DetachServerGroupsRequest
9284
+ * @param runtime runtime options for this request RuntimeOptions
9285
+ * @return DetachServerGroupsResponse
9286
+ */
8609
9287
  detachServerGroupsWithOptions(request: DetachServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DetachServerGroupsResponse>;
9288
+ /**
9289
+ * @summary Detaches one or more server groups from a scaling group. You can attach and detach the following server groups from a scaling group: Application Load Balancer (ALB) and Network Load Balancer (NLB) server groups.
9290
+ *
9291
+ * @param request DetachServerGroupsRequest
9292
+ * @return DetachServerGroupsResponse
9293
+ */
8610
9294
  detachServerGroups(request: DetachServerGroupsRequest): Promise<DetachServerGroupsResponse>;
8611
9295
  /**
8612
- * You can use the following parameters to specify the vServer groups that you want to detach from your scaling group.
8613
- * * LoadBalancerId: the ID of the Classic Load Balancer (CLB) instance.
8614
- * * VServerGroupId: the ID of the vServer group.
8615
- * * Port: the port number of the vServer group.
8616
- * If the vServer group that is specified in this call matches the vServer group associated with your scaling group, the vServer group can be detached. Otherwise, the request for detaching the vServer group is ignored, and no error is reported.
8617
- *
8618
- * @param request DetachVServerGroupsRequest
8619
- * @param runtime runtime options for this request RuntimeOptions
8620
- * @return DetachVServerGroupsResponse
9296
+ * @summary Detaches vServer groups from a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups to improve service performance. If the load balancer currently attached to your scaling group is no longer needed to distribute the access traffic to the instances in your scaling group, you can call the DetachVServerGroups operation to detach one or more vServer groups of this load balancer from the scaling group.
9297
+ *
9298
+ * @description * When you call the DetachVServerGroups operation, you must use the following parameters to specify the vServer groups that you want to detach from your scaling group:
9299
+ * * LoadBalancerId: the ID of the load balancer
9300
+ * * VServerGroupId: the ID of the vServer group
9301
+ * * Port: the port number of the vServer group
9302
+ * * When the vServer group specified by the request parameters matches that attached to your scaling group, this operation yields a favorable result. Otherwise, the request is ignored and no error is reported.
9303
+ * * Before you call this operation, you must make sure that the load balancer has ceased routing the access traffic to the instances in the scaling group. Failure to do so may lead to service requests being dropped or lost during the detachment process.
9304
+ *
9305
+ * @param request DetachVServerGroupsRequest
9306
+ * @param runtime runtime options for this request RuntimeOptions
9307
+ * @return DetachVServerGroupsResponse
8621
9308
  */
8622
9309
  detachVServerGroupsWithOptions(request: DetachVServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DetachVServerGroupsResponse>;
8623
9310
  /**
8624
- * You can use the following parameters to specify the vServer groups that you want to detach from your scaling group.
8625
- * * LoadBalancerId: the ID of the Classic Load Balancer (CLB) instance.
8626
- * * VServerGroupId: the ID of the vServer group.
8627
- * * Port: the port number of the vServer group.
8628
- * If the vServer group that is specified in this call matches the vServer group associated with your scaling group, the vServer group can be detached. Otherwise, the request for detaching the vServer group is ignored, and no error is reported.
8629
- *
8630
- * @param request DetachVServerGroupsRequest
8631
- * @return DetachVServerGroupsResponse
9311
+ * @summary Detaches vServer groups from a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups to improve service performance. If the load balancer currently attached to your scaling group is no longer needed to distribute the access traffic to the instances in your scaling group, you can call the DetachVServerGroups operation to detach one or more vServer groups of this load balancer from the scaling group.
9312
+ *
9313
+ * @description * When you call the DetachVServerGroups operation, you must use the following parameters to specify the vServer groups that you want to detach from your scaling group:
9314
+ * * LoadBalancerId: the ID of the load balancer
9315
+ * * VServerGroupId: the ID of the vServer group
9316
+ * * Port: the port number of the vServer group
9317
+ * * When the vServer group specified by the request parameters matches that attached to your scaling group, this operation yields a favorable result. Otherwise, the request is ignored and no error is reported.
9318
+ * * Before you call this operation, you must make sure that the load balancer has ceased routing the access traffic to the instances in the scaling group. Failure to do so may lead to service requests being dropped or lost during the detachment process.
9319
+ *
9320
+ * @param request DetachVServerGroupsRequest
9321
+ * @return DetachVServerGroupsResponse
8632
9322
  */
8633
9323
  detachVServerGroups(request: DetachVServerGroupsRequest): Promise<DetachVServerGroupsResponse>;
9324
+ /**
9325
+ * @summary Disables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you currently do not need an event-triggered task, you can call the DisableAlarm operation to disable it.
9326
+ *
9327
+ * @description Before you disable an event-triggered task, make sure that the task is in the `Normal`, `Alert`, or `Insufficient Data` state.
9328
+ *
9329
+ * @param request DisableAlarmRequest
9330
+ * @param runtime runtime options for this request RuntimeOptions
9331
+ * @return DisableAlarmResponse
9332
+ */
8634
9333
  disableAlarmWithOptions(request: DisableAlarmRequest, runtime: $Util.RuntimeOptions): Promise<DisableAlarmResponse>;
9334
+ /**
9335
+ * @summary Disables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you currently do not need an event-triggered task, you can call the DisableAlarm operation to disable it.
9336
+ *
9337
+ * @description Before you disable an event-triggered task, make sure that the task is in the `Normal`, `Alert`, or `Insufficient Data` state.
9338
+ *
9339
+ * @param request DisableAlarmRequest
9340
+ * @return DisableAlarmResponse
9341
+ */
8635
9342
  disableAlarm(request: DisableAlarmRequest): Promise<DisableAlarmResponse>;
9343
+ /**
9344
+ * @summary Disables a scaling group.
9345
+ *
9346
+ * @description Before you call this operation to disable a scaling group, take note of the following items:
9347
+ * * When you call this operation, ongoing scaling activities will continue until they are complete, but new activities will be rejected.
9348
+ * * You can disable only scaling groups that are in the Active state.
9349
+ *
9350
+ * @param request DisableScalingGroupRequest
9351
+ * @param runtime runtime options for this request RuntimeOptions
9352
+ * @return DisableScalingGroupResponse
9353
+ */
8636
9354
  disableScalingGroupWithOptions(request: DisableScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<DisableScalingGroupResponse>;
9355
+ /**
9356
+ * @summary Disables a scaling group.
9357
+ *
9358
+ * @description Before you call this operation to disable a scaling group, take note of the following items:
9359
+ * * When you call this operation, ongoing scaling activities will continue until they are complete, but new activities will be rejected.
9360
+ * * You can disable only scaling groups that are in the Active state.
9361
+ *
9362
+ * @param request DisableScalingGroupRequest
9363
+ * @return DisableScalingGroupResponse
9364
+ */
8637
9365
  disableScalingGroup(request: DisableScalingGroupRequest): Promise<DisableScalingGroupResponse>;
9366
+ /**
9367
+ * @summary Enables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you want to reuse an event-triggered task that is in the Disabled state, you can call the EnableAlarm operation to enable it.
9368
+ *
9369
+ * @param request EnableAlarmRequest
9370
+ * @param runtime runtime options for this request RuntimeOptions
9371
+ * @return EnableAlarmResponse
9372
+ */
8638
9373
  enableAlarmWithOptions(request: EnableAlarmRequest, runtime: $Util.RuntimeOptions): Promise<EnableAlarmResponse>;
9374
+ /**
9375
+ * @summary Enables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you want to reuse an event-triggered task that is in the Disabled state, you can call the EnableAlarm operation to enable it.
9376
+ *
9377
+ * @param request EnableAlarmRequest
9378
+ * @return EnableAlarmResponse
9379
+ */
8639
9380
  enableAlarm(request: EnableAlarmRequest): Promise<EnableAlarmResponse>;
8640
9381
  /**
8641
- * You can call this operation to enable a scaling group that is in the Inactive state and has an instance configuration source. The instance configuration source can be a scaling configuration, a launch template, or an Elastic Compute Service (ECS) instance that you specified when you created the scaling group. If a scaling group is not in the Inactive state or does not have an active instance configuration source, you cannot call this operation to enable the scaling group.
8642
- * > A scaling group can have only one active instance configuration source. When you call this operation to enable a scaling group, you can specify a scaling configuration or a launch template for the scaling group. If an instance configuration source has been configured for the scaling group before you call this operation, the scaling configuration or launch template that you specify in the request overwrites the original scaling configuration or launch template.
8643
- * If you specify a value for the InstanceIds parameter when you call the operation, Auto Scaling checks whether the total number of ECS instances is within the range allowed in the scaling group after you call the operation.
8644
- * * If the total number of ECS instances is less than the minimum number of instances required in the scaling group after you call the operation, Auto Scaling automatically creates the required number of pay-as-you-go ECS instances and adds the instances to the scaling group to reach the minimum number. For example, if the minimum number of instances required in your scaling group is five, and you specify the InstanceIds parameter to add two ECS instances to the scaling group, Auto Scaling automatically creates three instances in the scaling group after the two instances are added.
8645
- * * If the value of the TotalCapacity parameter is greater than the value of the MaxSize parameter, the call fails.
8646
- *
8647
- * @param request EnableScalingGroupRequest
8648
- * @param runtime runtime options for this request RuntimeOptions
8649
- * @return EnableScalingGroupResponse
9382
+ * @summary Enables a scaling group.
9383
+ *
9384
+ * @description You can call this operation to enable a scaling group that is in the Inactive state and has an instance configuration source. The instance configuration source can be a scaling configuration, a launch template, or an Elastic Compute Service (ECS) instance that you specified when you created the scaling group. If a scaling group is not in the Inactive state or does not have an active instance configuration source, you cannot call this operation to enable the scaling group.
9385
+ * > A scaling group can have only one active instance configuration source. When you call this operation to enable a scaling group, you can specify a scaling configuration or a launch template for the scaling group. If an instance configuration source has been configured for the scaling group before you call this operation, the scaling configuration or launch template that you specify in the request overwrites the original scaling configuration or launch template.
9386
+ * If you specify a value for the InstanceId parameter when you call the operation, Auto Scaling checks whether the total number of ECS instances is within the range allowed in the scaling group after you call the operation.
9387
+ * * If the total number of ECS instances is less than the minimum number of instances allowed in the scaling group after you call the operation, Auto Scaling automatically creates the required number of pay-as-you-go ECS instances and adds the instances to the scaling group to reach the minimum number. For example, if the minimum number of instances allowed in your scaling group is five, and you specify the InstanceId parameter to add two created ECS instances to the scaling group, Auto Scaling automatically creates three instances in the scaling group after the two instances are added.
9388
+ * * If the value of the TotalCapactiy parameter is greater than the value of the MaxSize parameter, the call fails.
9389
+ *
9390
+ * @param request EnableScalingGroupRequest
9391
+ * @param runtime runtime options for this request RuntimeOptions
9392
+ * @return EnableScalingGroupResponse
8650
9393
  */
8651
9394
  enableScalingGroupWithOptions(request: EnableScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<EnableScalingGroupResponse>;
8652
9395
  /**
8653
- * You can call this operation to enable a scaling group that is in the Inactive state and has an instance configuration source. The instance configuration source can be a scaling configuration, a launch template, or an Elastic Compute Service (ECS) instance that you specified when you created the scaling group. If a scaling group is not in the Inactive state or does not have an active instance configuration source, you cannot call this operation to enable the scaling group.
8654
- * > A scaling group can have only one active instance configuration source. When you call this operation to enable a scaling group, you can specify a scaling configuration or a launch template for the scaling group. If an instance configuration source has been configured for the scaling group before you call this operation, the scaling configuration or launch template that you specify in the request overwrites the original scaling configuration or launch template.
8655
- * If you specify a value for the InstanceIds parameter when you call the operation, Auto Scaling checks whether the total number of ECS instances is within the range allowed in the scaling group after you call the operation.
8656
- * * If the total number of ECS instances is less than the minimum number of instances required in the scaling group after you call the operation, Auto Scaling automatically creates the required number of pay-as-you-go ECS instances and adds the instances to the scaling group to reach the minimum number. For example, if the minimum number of instances required in your scaling group is five, and you specify the InstanceIds parameter to add two ECS instances to the scaling group, Auto Scaling automatically creates three instances in the scaling group after the two instances are added.
8657
- * * If the value of the TotalCapacity parameter is greater than the value of the MaxSize parameter, the call fails.
8658
- *
8659
- * @param request EnableScalingGroupRequest
8660
- * @return EnableScalingGroupResponse
9396
+ * @summary Enables a scaling group.
9397
+ *
9398
+ * @description You can call this operation to enable a scaling group that is in the Inactive state and has an instance configuration source. The instance configuration source can be a scaling configuration, a launch template, or an Elastic Compute Service (ECS) instance that you specified when you created the scaling group. If a scaling group is not in the Inactive state or does not have an active instance configuration source, you cannot call this operation to enable the scaling group.
9399
+ * > A scaling group can have only one active instance configuration source. When you call this operation to enable a scaling group, you can specify a scaling configuration or a launch template for the scaling group. If an instance configuration source has been configured for the scaling group before you call this operation, the scaling configuration or launch template that you specify in the request overwrites the original scaling configuration or launch template.
9400
+ * If you specify a value for the InstanceId parameter when you call the operation, Auto Scaling checks whether the total number of ECS instances is within the range allowed in the scaling group after you call the operation.
9401
+ * * If the total number of ECS instances is less than the minimum number of instances allowed in the scaling group after you call the operation, Auto Scaling automatically creates the required number of pay-as-you-go ECS instances and adds the instances to the scaling group to reach the minimum number. For example, if the minimum number of instances allowed in your scaling group is five, and you specify the InstanceId parameter to add two created ECS instances to the scaling group, Auto Scaling automatically creates three instances in the scaling group after the two instances are added.
9402
+ * * If the value of the TotalCapactiy parameter is greater than the value of the MaxSize parameter, the call fails.
9403
+ *
9404
+ * @param request EnableScalingGroupRequest
9405
+ * @return EnableScalingGroupResponse
8661
9406
  */
8662
9407
  enableScalingGroup(request: EnableScalingGroupRequest): Promise<EnableScalingGroupResponse>;
9408
+ /**
9409
+ * @summary Puts an Elastic Compute Service (ECS) instance into the Standby state.
9410
+ *
9411
+ * @description ## Description
9412
+ * * If you call the operation to put an ECS instance in a scaling group that is associated with a Classic Load Balancer (CLB) instance into the Standby state, the weight of the ECS instance as a backend server of the CLB instance is set to 0.
9413
+ * * You can remove an instance that is in the Standby state from a scaling group, and then release the instance.
9414
+ * * ECS instances that are in the Standby state are not removed from the scaling group during scale-in activities triggered by event-triggered tasks.
9415
+ * * If Auto Scaling considers an ECS instance that is in the Standby state unhealthy, for example, the ECS instance is being stopped or being restarted, Auto Scaling does not update the health status of the ECS instance or trigger scale-in activities to remove the ECS instance from the scaling group. Auto Scaling updates the health status of the ECS instance only when the ECS instance is no longer in the Standby state.
9416
+ *
9417
+ * @param request EnterStandbyRequest
9418
+ * @param runtime runtime options for this request RuntimeOptions
9419
+ * @return EnterStandbyResponse
9420
+ */
8663
9421
  enterStandbyWithOptions(request: EnterStandbyRequest, runtime: $Util.RuntimeOptions): Promise<EnterStandbyResponse>;
9422
+ /**
9423
+ * @summary Puts an Elastic Compute Service (ECS) instance into the Standby state.
9424
+ *
9425
+ * @description ## Description
9426
+ * * If you call the operation to put an ECS instance in a scaling group that is associated with a Classic Load Balancer (CLB) instance into the Standby state, the weight of the ECS instance as a backend server of the CLB instance is set to 0.
9427
+ * * You can remove an instance that is in the Standby state from a scaling group, and then release the instance.
9428
+ * * ECS instances that are in the Standby state are not removed from the scaling group during scale-in activities triggered by event-triggered tasks.
9429
+ * * If Auto Scaling considers an ECS instance that is in the Standby state unhealthy, for example, the ECS instance is being stopped or being restarted, Auto Scaling does not update the health status of the ECS instance or trigger scale-in activities to remove the ECS instance from the scaling group. Auto Scaling updates the health status of the ECS instance only when the ECS instance is no longer in the Standby state.
9430
+ *
9431
+ * @param request EnterStandbyRequest
9432
+ * @return EnterStandbyResponse
9433
+ */
8664
9434
  enterStandby(request: EnterStandbyRequest): Promise<EnterStandbyResponse>;
8665
9435
  /**
8666
- * Before you call this operation, take note of the following items:
8667
- * * The scaling group is in the Active state.
8668
- * * No scaling activities in the scaling group are in progress.
8669
- * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8670
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
8671
- * If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.
8672
- * If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.
8673
- * You can specify only a limited number of ECS instances in each adjustment. For more information, see the description of the AdjustmentValue parameter in the CreateScalingRule topic.
8674
- *
8675
- * @param request ExecuteScalingRuleRequest
8676
- * @param runtime runtime options for this request RuntimeOptions
8677
- * @return ExecuteScalingRuleResponse
9436
+ * @summary Executes a scaling rule.
9437
+ *
9438
+ * @description Before you call this operation, take note of the following items:
9439
+ * * The scaling group is in the Active state.
9440
+ * * No scaling activities in the scaling group are in progress.
9441
+ * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9442
+ * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
9443
+ * If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.
9444
+ * If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.
9445
+ * You can specify only a limited number of ECS instances in each adjustment. For more information, see the description of the AdjustmentValue parameter in the CreateScalingRule topic.
9446
+ *
9447
+ * @param request ExecuteScalingRuleRequest
9448
+ * @param runtime runtime options for this request RuntimeOptions
9449
+ * @return ExecuteScalingRuleResponse
8678
9450
  */
8679
9451
  executeScalingRuleWithOptions(request: ExecuteScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<ExecuteScalingRuleResponse>;
8680
9452
  /**
8681
- * Before you call this operation, take note of the following items:
8682
- * * The scaling group is in the Active state.
8683
- * * No scaling activities in the scaling group are in progress.
8684
- * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8685
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
8686
- * If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.
8687
- * If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.
8688
- * You can specify only a limited number of ECS instances in each adjustment. For more information, see the description of the AdjustmentValue parameter in the CreateScalingRule topic.
8689
- *
8690
- * @param request ExecuteScalingRuleRequest
8691
- * @return ExecuteScalingRuleResponse
9453
+ * @summary Executes a scaling rule.
9454
+ *
9455
+ * @description Before you call this operation, take note of the following items:
9456
+ * * The scaling group is in the Active state.
9457
+ * * No scaling activities in the scaling group are in progress.
9458
+ * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9459
+ * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the ScalingActivityId parameter in the response.
9460
+ * If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.
9461
+ * If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.
9462
+ * You can specify only a limited number of ECS instances in each adjustment. For more information, see the description of the AdjustmentValue parameter in the CreateScalingRule topic.
9463
+ *
9464
+ * @param request ExecuteScalingRuleRequest
9465
+ * @return ExecuteScalingRuleResponse
8692
9466
  */
8693
9467
  executeScalingRule(request: ExecuteScalingRuleRequest): Promise<ExecuteScalingRuleResponse>;
9468
+ /**
9469
+ * @summary Moves an Elastic Compute Service (ECS) instance out of the Standby state.
9470
+ *
9471
+ * @description ## Description
9472
+ * 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.
9473
+ *
9474
+ * @param request ExitStandbyRequest
9475
+ * @param runtime runtime options for this request RuntimeOptions
9476
+ * @return ExitStandbyResponse
9477
+ */
8694
9478
  exitStandbyWithOptions(request: ExitStandbyRequest, runtime: $Util.RuntimeOptions): Promise<ExitStandbyResponse>;
9479
+ /**
9480
+ * @summary Moves an Elastic Compute Service (ECS) instance out of the Standby state.
9481
+ *
9482
+ * @description ## Description
9483
+ * 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.
9484
+ *
9485
+ * @param request ExitStandbyRequest
9486
+ * @return ExitStandbyResponse
9487
+ */
8695
9488
  exitStandby(request: ExitStandbyRequest): Promise<ExitStandbyResponse>;
9489
+ /**
9490
+ * @summary Queries the tag keys added to Auto Scaling resources. Querying tag keys facilitates easier classification, identification, and monitoring of your Auto Scaling resources, thereby enhancing the flexibility and convenience of your resource management processes.
9491
+ *
9492
+ * @param request ListTagKeysRequest
9493
+ * @param runtime runtime options for this request RuntimeOptions
9494
+ * @return ListTagKeysResponse
9495
+ */
8696
9496
  listTagKeysWithOptions(request: ListTagKeysRequest, runtime: $Util.RuntimeOptions): Promise<ListTagKeysResponse>;
9497
+ /**
9498
+ * @summary Queries the tag keys added to Auto Scaling resources. Querying tag keys facilitates easier classification, identification, and monitoring of your Auto Scaling resources, thereby enhancing the flexibility and convenience of your resource management processes.
9499
+ *
9500
+ * @param request ListTagKeysRequest
9501
+ * @return ListTagKeysResponse
9502
+ */
8697
9503
  listTagKeys(request: ListTagKeysRequest): Promise<ListTagKeysResponse>;
9504
+ /**
9505
+ * @summary Queries tags that are added to one or more Auto Scaling resources.
9506
+ *
9507
+ * @param request ListTagResourcesRequest
9508
+ * @param runtime runtime options for this request RuntimeOptions
9509
+ * @return ListTagResourcesResponse
9510
+ */
8698
9511
  listTagResourcesWithOptions(request: ListTagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<ListTagResourcesResponse>;
9512
+ /**
9513
+ * @summary Queries tags that are added to one or more Auto Scaling resources.
9514
+ *
9515
+ * @param request ListTagResourcesRequest
9516
+ * @return ListTagResourcesResponse
9517
+ */
8699
9518
  listTagResources(request: ListTagResourcesRequest): Promise<ListTagResourcesResponse>;
9519
+ /**
9520
+ * @summary Queries the tag keys associated with Auto Scaling resources to facilitate a deeper comprehension of those resources. By doing so, you can categorize and manage your Auto Scaling resources more efficiently.
9521
+ *
9522
+ * @param request ListTagValuesRequest
9523
+ * @param runtime runtime options for this request RuntimeOptions
9524
+ * @return ListTagValuesResponse
9525
+ */
8700
9526
  listTagValuesWithOptions(request: ListTagValuesRequest, runtime: $Util.RuntimeOptions): Promise<ListTagValuesResponse>;
9527
+ /**
9528
+ * @summary Queries the tag keys associated with Auto Scaling resources to facilitate a deeper comprehension of those resources. By doing so, you can categorize and manage your Auto Scaling resources more efficiently.
9529
+ *
9530
+ * @param request ListTagValuesRequest
9531
+ * @return ListTagValuesResponse
9532
+ */
8701
9533
  listTagValues(request: ListTagValuesRequest): Promise<ListTagValuesResponse>;
8702
9534
  /**
8703
- * * If you set the MetricType parameter to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using the custom metrics. For more information, see [Custom monitoring event-triggered tasks](~~74861~~).
8704
- * * When you create an event-triggered task, you must specify the MetricName, DimensionKey, and DimensionValue parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the user_id and scaling_group dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances or elastic container instances in a scaling group within an Alibaba Cloud account.
8705
- * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
8706
- * * For information about the metrics that are supported if you set the MetricType parameter to system, see[ Event-triggered task for system monitoring](~~74854~~).
8707
- * > The user_id and scaling_group dimensions are automatically populated. You need to only specify the device and state dimensions. For more information, see the `DimensionKey` and `DimensionValue` parameters in the "Request parameters" section of this topic.
8708
- *
8709
- * @param request ModifyAlarmRequest
8710
- * @param runtime runtime options for this request RuntimeOptions
8711
- * @return ModifyAlarmResponse
9535
+ * @summary Modifies an event-triggered task.
9536
+ *
9537
+ * @description * If you set the MetricType parameter to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using the custom metrics. For more information, see [Custom monitoring event-triggered tasks](https://help.aliyun.com/document_detail/74861.html).
9538
+ * * When you create an event-triggered task, you must specify the MetricName, DimensionKey, and DimensionValue parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the user_id and scaling_group dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances or elastic container instances in a scaling group within an Alibaba Cloud account.
9539
+ * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
9540
+ * * For information about the metrics that are supported if you set the MetricType parameter to system, see[ Event-triggered task for system monitoring](https://help.aliyun.com/document_detail/74854.html).
9541
+ * > The user_id and scaling_group dimensions are automatically populated. You need to only specify the device and state dimensions. For more information, see the `DimensionKey` and `DimensionValue` parameters in the "Request parameters" section of this topic.
9542
+ *
9543
+ * @param request ModifyAlarmRequest
9544
+ * @param runtime runtime options for this request RuntimeOptions
9545
+ * @return ModifyAlarmResponse
8712
9546
  */
8713
9547
  modifyAlarmWithOptions(request: ModifyAlarmRequest, runtime: $Util.RuntimeOptions): Promise<ModifyAlarmResponse>;
8714
9548
  /**
8715
- * * If you set the MetricType parameter to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using the custom metrics. For more information, see [Custom monitoring event-triggered tasks](~~74861~~).
8716
- * * When you create an event-triggered task, you must specify the MetricName, DimensionKey, and DimensionValue parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the user_id and scaling_group dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances or elastic container instances in a scaling group within an Alibaba Cloud account.
8717
- * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
8718
- * * For information about the metrics that are supported if you set the MetricType parameter to system, see[ Event-triggered task for system monitoring](~~74854~~).
8719
- * > The user_id and scaling_group dimensions are automatically populated. You need to only specify the device and state dimensions. For more information, see the `DimensionKey` and `DimensionValue` parameters in the "Request parameters" section of this topic.
8720
- *
8721
- * @param request ModifyAlarmRequest
8722
- * @return ModifyAlarmResponse
9549
+ * @summary Modifies an event-triggered task.
9550
+ *
9551
+ * @description * If you set the MetricType parameter to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using the custom metrics. For more information, see [Custom monitoring event-triggered tasks](https://help.aliyun.com/document_detail/74861.html).
9552
+ * * When you create an event-triggered task, you must specify the MetricName, DimensionKey, and DimensionValue parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the user_id and scaling_group dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances or elastic container instances in a scaling group within an Alibaba Cloud account.
9553
+ * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
9554
+ * * For information about the metrics that are supported if you set the MetricType parameter to system, see[ Event-triggered task for system monitoring](https://help.aliyun.com/document_detail/74854.html).
9555
+ * > The user_id and scaling_group dimensions are automatically populated. You need to only specify the device and state dimensions. For more information, see the `DimensionKey` and `DimensionValue` parameters in the "Request parameters" section of this topic.
9556
+ *
9557
+ * @param request ModifyAlarmRequest
9558
+ * @return ModifyAlarmResponse
8723
9559
  */
8724
9560
  modifyAlarm(request: ModifyAlarmRequest): Promise<ModifyAlarmResponse>;
8725
9561
  /**
8726
- * If you want to change the name of a scaling configuration in a scaling group, make sure that the new name is unique within the scaling group.
8727
- *
8728
- * @param request ModifyEciScalingConfigurationRequest
8729
- * @param runtime runtime options for this request RuntimeOptions
8730
- * @return ModifyEciScalingConfigurationResponse
9562
+ * @summary Modifies a scaling configuration for a scaling group that contains elastic container instances.
9563
+ *
9564
+ * @description If you want to change the name of a scaling configuration in a scaling group, make sure that the new name is unique within the scaling group.
9565
+ *
9566
+ * @param request ModifyEciScalingConfigurationRequest
9567
+ * @param runtime runtime options for this request RuntimeOptions
9568
+ * @return ModifyEciScalingConfigurationResponse
8731
9569
  */
8732
9570
  modifyEciScalingConfigurationWithOptions(request: ModifyEciScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyEciScalingConfigurationResponse>;
8733
9571
  /**
8734
- * If you want to change the name of a scaling configuration in a scaling group, make sure that the new name is unique within the scaling group.
8735
- *
8736
- * @param request ModifyEciScalingConfigurationRequest
8737
- * @return ModifyEciScalingConfigurationResponse
9572
+ * @summary Modifies a scaling configuration for a scaling group that contains elastic container instances.
9573
+ *
9574
+ * @description If you want to change the name of a scaling configuration in a scaling group, make sure that the new name is unique within the scaling group.
9575
+ *
9576
+ * @param request ModifyEciScalingConfigurationRequest
9577
+ * @return ModifyEciScalingConfigurationResponse
8738
9578
  */
8739
9579
  modifyEciScalingConfiguration(request: ModifyEciScalingConfigurationRequest): Promise<ModifyEciScalingConfigurationResponse>;
9580
+ /**
9581
+ * @summary Modifies the attributes of an Elastic Compute Service (ECS) instance in a scaling group. You can call the ModifyInstanceAttribute operation to modify the lifecycle management attribute of a manually added ECS instance in a scaling group.
9582
+ *
9583
+ * @param request ModifyInstanceAttributeRequest
9584
+ * @param runtime runtime options for this request RuntimeOptions
9585
+ * @return ModifyInstanceAttributeResponse
9586
+ */
8740
9587
  modifyInstanceAttributeWithOptions(request: ModifyInstanceAttributeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyInstanceAttributeResponse>;
9588
+ /**
9589
+ * @summary Modifies the attributes of an Elastic Compute Service (ECS) instance in a scaling group. You can call the ModifyInstanceAttribute operation to modify the lifecycle management attribute of a manually added ECS instance in a scaling group.
9590
+ *
9591
+ * @param request ModifyInstanceAttributeRequest
9592
+ * @return ModifyInstanceAttributeResponse
9593
+ */
8741
9594
  modifyInstanceAttribute(request: ModifyInstanceAttributeRequest): Promise<ModifyInstanceAttributeResponse>;
8742
9595
  /**
8743
- * You can use one of the following methods to specify the lifecycle hook that you want to modify:
8744
- * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. When you use this method, the ScalingGroupId and LifecycleHookName parameters are ignored.
8745
- * * Specify the scaling group ID by using the ScalingGroupId parameter and specify the lifecycle hook name by using the LifecycleHookName parameter.
8746
- *
8747
- * @param request ModifyLifecycleHookRequest
8748
- * @param runtime runtime options for this request RuntimeOptions
8749
- * @return ModifyLifecycleHookResponse
9596
+ * @summary Modifies a lifecycle hook.
9597
+ *
9598
+ * @description You can use one of the following methods to specify the lifecycle hook that you want to modify:
9599
+ * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. When you use this method, the ScalingGroupId and LifecycleHookName parameters are ignored.
9600
+ * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter.
9601
+ *
9602
+ * @param request ModifyLifecycleHookRequest
9603
+ * @param runtime runtime options for this request RuntimeOptions
9604
+ * @return ModifyLifecycleHookResponse
8750
9605
  */
8751
9606
  modifyLifecycleHookWithOptions(request: ModifyLifecycleHookRequest, runtime: $Util.RuntimeOptions): Promise<ModifyLifecycleHookResponse>;
8752
9607
  /**
8753
- * You can use one of the following methods to specify the lifecycle hook that you want to modify:
8754
- * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. When you use this method, the ScalingGroupId and LifecycleHookName parameters are ignored.
8755
- * * Specify the scaling group ID by using the ScalingGroupId parameter and specify the lifecycle hook name by using the LifecycleHookName parameter.
8756
- *
8757
- * @param request ModifyLifecycleHookRequest
8758
- * @return ModifyLifecycleHookResponse
9608
+ * @summary Modifies a lifecycle hook.
9609
+ *
9610
+ * @description You can use one of the following methods to specify the lifecycle hook that you want to modify:
9611
+ * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. When you use this method, the ScalingGroupId and LifecycleHookName parameters are ignored.
9612
+ * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter.
9613
+ *
9614
+ * @param request ModifyLifecycleHookRequest
9615
+ * @return ModifyLifecycleHookResponse
8759
9616
  */
8760
9617
  modifyLifecycleHook(request: ModifyLifecycleHookRequest): Promise<ModifyLifecycleHookResponse>;
9618
+ /**
9619
+ * @summary Modifies a notification.
9620
+ *
9621
+ * @param request ModifyNotificationConfigurationRequest
9622
+ * @param runtime runtime options for this request RuntimeOptions
9623
+ * @return ModifyNotificationConfigurationResponse
9624
+ */
8761
9625
  modifyNotificationConfigurationWithOptions(request: ModifyNotificationConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyNotificationConfigurationResponse>;
9626
+ /**
9627
+ * @summary Modifies a notification.
9628
+ *
9629
+ * @param request ModifyNotificationConfigurationRequest
9630
+ * @return ModifyNotificationConfigurationResponse
9631
+ */
8762
9632
  modifyNotificationConfiguration(request: ModifyNotificationConfigurationRequest): Promise<ModifyNotificationConfigurationResponse>;
8763
9633
  /**
8764
- * You can change the name of a scaling configuration in a scaling group. The name must be unique within the scaling group.
8765
- *
8766
- * @param tmpReq ModifyScalingConfigurationRequest
8767
- * @param runtime runtime options for this request RuntimeOptions
8768
- * @return ModifyScalingConfigurationResponse
9634
+ * @summary Modifies a scaling configuration.
9635
+ *
9636
+ * @description You can change the name of a scaling configuration in a scaling group. The name must be unique within the scaling group.
9637
+ *
9638
+ * @param tmpReq ModifyScalingConfigurationRequest
9639
+ * @param runtime runtime options for this request RuntimeOptions
9640
+ * @return ModifyScalingConfigurationResponse
8769
9641
  */
8770
9642
  modifyScalingConfigurationWithOptions(tmpReq: ModifyScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScalingConfigurationResponse>;
8771
9643
  /**
8772
- * You can change the name of a scaling configuration in a scaling group. The name must be unique within the scaling group.
8773
- *
8774
- * @param request ModifyScalingConfigurationRequest
8775
- * @return ModifyScalingConfigurationResponse
9644
+ * @summary Modifies a scaling configuration.
9645
+ *
9646
+ * @description You can change the name of a scaling configuration in a scaling group. The name must be unique within the scaling group.
9647
+ *
9648
+ * @param request ModifyScalingConfigurationRequest
9649
+ * @return ModifyScalingConfigurationResponse
8776
9650
  */
8777
9651
  modifyScalingConfiguration(request: ModifyScalingConfigurationRequest): Promise<ModifyScalingConfigurationResponse>;
8778
9652
  /**
8779
- * * You cannot call this operation to modify the settings of the following parameters:
8780
- * * RegionId
8781
- * * LoadBalancerId
8782
- * > If you want to change the CLB instances that are associated with your scaling group, call the AttachLoadBalancers and DetachLoadBalancers operations.
8783
- * * DBInstanceId
8784
- * > If you want to change the ApsaraDB RDS instances that are associated with your scaling group, call the AttachDBInstances and DetachDBInstances operations.
8785
- * * You can modify only scaling groups that are in the Active or Inactive state.
8786
- * * If you enable a new scaling configuration, Elastic Compute Service (ECS) instances that are created based on the previous scaling configuration still run as expected in the scaling group.
8787
- * * If the total number of instances in the scaling group is greater than the allowed maximum number after you change the value of the MaxSize parameter, Auto Scaling automatically removes instances from the scaling group to ensure that the number of instances is within the new range.
8788
- * * If the total number of instances in the scaling group is less than the allowed minimum number after you change the value of the MinSize parameter, Auto Scaling automatically adds instances to the scaling group to ensure that the number of instances is within the new range.
8789
- * * If the total number of instances in the scaling group does not match the expected number of instances after you change the value of the DesiredCapacity parameter, Auto Scaling automatically adds instances to or removes instances from the scaling group to ensure that the number of instances matches the value of the DesiredCapacity parameter.
8790
- *
8791
- * @param request ModifyScalingGroupRequest
8792
- * @param runtime runtime options for this request RuntimeOptions
8793
- * @return ModifyScalingGroupResponse
9653
+ * @summary Modifies a scaling group.
9654
+ *
9655
+ * @description * You cannot call this operation to modify the settings of the following parameters:
9656
+ * * RegionId
9657
+ * * LoadBalancerId
9658
+ * > If you want to change the CLB instances that are associated with your scaling group, call the AttachLoadBalancers and DetachLoadBalancers operations.
9659
+ * * DBInstanceId
9660
+ * > If you want to change the ApsaraDB RDS instances that are associated with your scaling group, call the AttachDBInstances and DetachDBInstances operations.
9661
+ * * You can modify only scaling groups that are in the Active or Inactive state.
9662
+ * * If you enable a new scaling configuration, Elastic Compute Service (ECS) instances that are created based on the previous scaling configuration still run as expected in the scaling group.
9663
+ * * If the total number of instances in the scaling group is greater than the allowed maximum number after you change the value of the MaxSize parameter, Auto Scaling automatically removes instances from the scaling group to ensure that the number of instances is within the new range.
9664
+ * * If the total number of instances in the scaling group is less than the allowed minimum number after you change the value of the MinSize parameter, Auto Scaling automatically adds instances to the scaling group to ensure that the number of instances is within the new range.
9665
+ * * If the total number of instances in the scaling group does not match the expected number of instances after you change the value of the DesiredCapacity parameter, Auto Scaling automatically adds instances to or removes instances from the scaling group to ensure that the number of instances matches the value of the DesiredCapacity parameter.
9666
+ *
9667
+ * @param request ModifyScalingGroupRequest
9668
+ * @param runtime runtime options for this request RuntimeOptions
9669
+ * @return ModifyScalingGroupResponse
8794
9670
  */
8795
9671
  modifyScalingGroupWithOptions(request: ModifyScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScalingGroupResponse>;
8796
9672
  /**
8797
- * * You cannot call this operation to modify the settings of the following parameters:
8798
- * * RegionId
8799
- * * LoadBalancerId
8800
- * > If you want to change the CLB instances that are associated with your scaling group, call the AttachLoadBalancers and DetachLoadBalancers operations.
8801
- * * DBInstanceId
8802
- * > If you want to change the ApsaraDB RDS instances that are associated with your scaling group, call the AttachDBInstances and DetachDBInstances operations.
8803
- * * You can modify only scaling groups that are in the Active or Inactive state.
8804
- * * If you enable a new scaling configuration, Elastic Compute Service (ECS) instances that are created based on the previous scaling configuration still run as expected in the scaling group.
8805
- * * If the total number of instances in the scaling group is greater than the allowed maximum number after you change the value of the MaxSize parameter, Auto Scaling automatically removes instances from the scaling group to ensure that the number of instances is within the new range.
8806
- * * If the total number of instances in the scaling group is less than the allowed minimum number after you change the value of the MinSize parameter, Auto Scaling automatically adds instances to the scaling group to ensure that the number of instances is within the new range.
8807
- * * If the total number of instances in the scaling group does not match the expected number of instances after you change the value of the DesiredCapacity parameter, Auto Scaling automatically adds instances to or removes instances from the scaling group to ensure that the number of instances matches the value of the DesiredCapacity parameter.
8808
- *
8809
- * @param request ModifyScalingGroupRequest
8810
- * @return ModifyScalingGroupResponse
9673
+ * @summary Modifies a scaling group.
9674
+ *
9675
+ * @description * You cannot call this operation to modify the settings of the following parameters:
9676
+ * * RegionId
9677
+ * * LoadBalancerId
9678
+ * > If you want to change the CLB instances that are associated with your scaling group, call the AttachLoadBalancers and DetachLoadBalancers operations.
9679
+ * * DBInstanceId
9680
+ * > If you want to change the ApsaraDB RDS instances that are associated with your scaling group, call the AttachDBInstances and DetachDBInstances operations.
9681
+ * * You can modify only scaling groups that are in the Active or Inactive state.
9682
+ * * If you enable a new scaling configuration, Elastic Compute Service (ECS) instances that are created based on the previous scaling configuration still run as expected in the scaling group.
9683
+ * * If the total number of instances in the scaling group is greater than the allowed maximum number after you change the value of the MaxSize parameter, Auto Scaling automatically removes instances from the scaling group to ensure that the number of instances is within the new range.
9684
+ * * If the total number of instances in the scaling group is less than the allowed minimum number after you change the value of the MinSize parameter, Auto Scaling automatically adds instances to the scaling group to ensure that the number of instances is within the new range.
9685
+ * * If the total number of instances in the scaling group does not match the expected number of instances after you change the value of the DesiredCapacity parameter, Auto Scaling automatically adds instances to or removes instances from the scaling group to ensure that the number of instances matches the value of the DesiredCapacity parameter.
9686
+ *
9687
+ * @param request ModifyScalingGroupRequest
9688
+ * @return ModifyScalingGroupResponse
8811
9689
  */
8812
9690
  modifyScalingGroup(request: ModifyScalingGroupRequest): Promise<ModifyScalingGroupResponse>;
9691
+ /**
9692
+ * @summary Modifies a scaling rule.
9693
+ *
9694
+ * @param request ModifyScalingRuleRequest
9695
+ * @param runtime runtime options for this request RuntimeOptions
9696
+ * @return ModifyScalingRuleResponse
9697
+ */
8813
9698
  modifyScalingRuleWithOptions(request: ModifyScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScalingRuleResponse>;
9699
+ /**
9700
+ * @summary Modifies a scaling rule.
9701
+ *
9702
+ * @param request ModifyScalingRuleRequest
9703
+ * @return ModifyScalingRuleResponse
9704
+ */
8814
9705
  modifyScalingRule(request: ModifyScalingRuleRequest): Promise<ModifyScalingRuleResponse>;
8815
9706
  /**
8816
- * You can use the following parameters to specify the scaling method of a scheduled task:
8817
- * * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
8818
- * * If you use the `ScalingGroupId` parameter, you must specify the minimum number, maximum number, or expected number of instances in the scheduled task.
8819
- * > You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.
8820
- *
8821
- * @param request ModifyScheduledTaskRequest
8822
- * @param runtime runtime options for this request RuntimeOptions
8823
- * @return ModifyScheduledTaskResponse
9707
+ * @summary Modifies a scheduled task.
9708
+ *
9709
+ * @description You can use the following parameters to specify the scaling method of a scheduled task:
9710
+ * * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
9711
+ * * If you use the `ScalingGroupId` parameter, you must specify the minimum number, maximum number, or expected number of instances in the scheduled task.
9712
+ * > You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.
9713
+ *
9714
+ * @param request ModifyScheduledTaskRequest
9715
+ * @param runtime runtime options for this request RuntimeOptions
9716
+ * @return ModifyScheduledTaskResponse
8824
9717
  */
8825
9718
  modifyScheduledTaskWithOptions(request: ModifyScheduledTaskRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScheduledTaskResponse>;
8826
9719
  /**
8827
- * You can use the following parameters to specify the scaling method of a scheduled task:
8828
- * * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
8829
- * * If you use the `ScalingGroupId` parameter, you must specify the minimum number, maximum number, or expected number of instances in the scheduled task.
8830
- * > You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.
8831
- *
8832
- * @param request ModifyScheduledTaskRequest
8833
- * @return ModifyScheduledTaskResponse
9720
+ * @summary Modifies a scheduled task.
9721
+ *
9722
+ * @description You can use the following parameters to specify the scaling method of a scheduled task:
9723
+ * * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
9724
+ * * If you use the `ScalingGroupId` parameter, you must specify the minimum number, maximum number, or expected number of instances in the scheduled task.
9725
+ * > You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.
9726
+ *
9727
+ * @param request ModifyScheduledTaskRequest
9728
+ * @return ModifyScheduledTaskResponse
8834
9729
  */
8835
9730
  modifyScheduledTask(request: ModifyScheduledTaskRequest): Promise<ModifyScheduledTaskResponse>;
9731
+ /**
9732
+ * @summary Rebalances the distribution of Elastic Compute Service (ECS) instances across zones. If ECS instances are unevenly distributed across multiple zones, you can call the RebalanceInstances operation to rebalance the distribution of the ECS instances across the zones.
9733
+ *
9734
+ * @description ## [](#)Usage notes
9735
+ * Auto Scaling creates new ECS instances to replace the existing ECS instances to fulfill the rebalancing purpose. Auto Scaling starts the new ECS instances before stopping the existing ECS instances. The rebalancing operation does not affect the performance or service availability of your application.
9736
+ * * This operation is supported by only multi-zone scaling groups whose `MultiAZPolicy` is set to `BALANCE`.
9737
+ * * A rebalancing operation is required only when the distribution of the instances of a multi-zone scaling group is significantly unbalanced. In a rebalancing activity, Auto Scaling replaces up to 20 ECS instances to rectify the unbalanced distribution.
9738
+ * * During the execution of a rebalancing operation, if the number of instances in the scaling group approaches or hits the value of MaxSize but the rebalancing operation needs to continue, Auto Scaling allows the total number of ECS instances to momentarily exceed the value of MaxSize by 10%. This temporary surplus condition persists for a duration until equilibrium in the distribution of ECS instances is achieved. Typically, it takes 1 to 6 minutes.
9739
+ * **
9740
+ * **Note** If the 10% increment of the maximum number of instances in a scaling group yield a non-integer value, the decimal portion is always rounded up to ensure an additional instance is accounted for. For example, you have a scaling group that holds a maximum of 15 ECS instances. During a rebalancing operation, Auto Scaling would permit the total number of instances to momentarily surpass this limit by 2, instead of the calculated 10% (which is 1.5).
9741
+ *
9742
+ * @param request RebalanceInstancesRequest
9743
+ * @param runtime runtime options for this request RuntimeOptions
9744
+ * @return RebalanceInstancesResponse
9745
+ */
8836
9746
  rebalanceInstancesWithOptions(request: RebalanceInstancesRequest, runtime: $Util.RuntimeOptions): Promise<RebalanceInstancesResponse>;
9747
+ /**
9748
+ * @summary Rebalances the distribution of Elastic Compute Service (ECS) instances across zones. If ECS instances are unevenly distributed across multiple zones, you can call the RebalanceInstances operation to rebalance the distribution of the ECS instances across the zones.
9749
+ *
9750
+ * @description ## [](#)Usage notes
9751
+ * Auto Scaling creates new ECS instances to replace the existing ECS instances to fulfill the rebalancing purpose. Auto Scaling starts the new ECS instances before stopping the existing ECS instances. The rebalancing operation does not affect the performance or service availability of your application.
9752
+ * * This operation is supported by only multi-zone scaling groups whose `MultiAZPolicy` is set to `BALANCE`.
9753
+ * * A rebalancing operation is required only when the distribution of the instances of a multi-zone scaling group is significantly unbalanced. In a rebalancing activity, Auto Scaling replaces up to 20 ECS instances to rectify the unbalanced distribution.
9754
+ * * During the execution of a rebalancing operation, if the number of instances in the scaling group approaches or hits the value of MaxSize but the rebalancing operation needs to continue, Auto Scaling allows the total number of ECS instances to momentarily exceed the value of MaxSize by 10%. This temporary surplus condition persists for a duration until equilibrium in the distribution of ECS instances is achieved. Typically, it takes 1 to 6 minutes.
9755
+ * **
9756
+ * **Note** If the 10% increment of the maximum number of instances in a scaling group yield a non-integer value, the decimal portion is always rounded up to ensure an additional instance is accounted for. For example, you have a scaling group that holds a maximum of 15 ECS instances. During a rebalancing operation, Auto Scaling would permit the total number of instances to momentarily surpass this limit by 2, instead of the calculated 10% (which is 1.5).
9757
+ *
9758
+ * @param request RebalanceInstancesRequest
9759
+ * @return RebalanceInstancesResponse
9760
+ */
8837
9761
  rebalanceInstances(request: RebalanceInstancesRequest): Promise<RebalanceInstancesResponse>;
8838
9762
  /**
8839
- * 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.
8840
- *
8841
- * @param request RecordLifecycleActionHeartbeatRequest
8842
- * @param runtime runtime options for this request RuntimeOptions
8843
- * @return RecordLifecycleActionHeartbeatResponse
9763
+ * @summary Prolongs a lifecycle hook for Elastic Compute Service (ECS) instances.
9764
+ *
9765
+ * @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.
9766
+ *
9767
+ * @param request RecordLifecycleActionHeartbeatRequest
9768
+ * @param runtime runtime options for this request RuntimeOptions
9769
+ * @return RecordLifecycleActionHeartbeatResponse
8844
9770
  */
8845
9771
  recordLifecycleActionHeartbeatWithOptions(request: RecordLifecycleActionHeartbeatRequest, runtime: $Util.RuntimeOptions): Promise<RecordLifecycleActionHeartbeatResponse>;
8846
9772
  /**
8847
- * 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.
8848
- *
8849
- * @param request RecordLifecycleActionHeartbeatRequest
8850
- * @return RecordLifecycleActionHeartbeatResponse
9773
+ * @summary Prolongs a lifecycle hook for Elastic Compute Service (ECS) instances.
9774
+ *
9775
+ * @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.
9776
+ *
9777
+ * @param request RecordLifecycleActionHeartbeatRequest
9778
+ * @return RecordLifecycleActionHeartbeatResponse
8851
9779
  */
8852
9780
  recordLifecycleActionHeartbeat(request: RecordLifecycleActionHeartbeatRequest): Promise<RecordLifecycleActionHeartbeatResponse>;
8853
9781
  /**
8854
- * * Before you call this operation, make sure that the following requirements are met:
8855
- * * The scaling group is in the Active state.
8856
- * * No scaling activity is in progress within the scaling group.
8857
- * > If no scaling activity is in progress within the scaling group, you can call the operation even within the cooldown period.
8858
- * * If an ECS instance is automatically created by Auto Scaling, or if an ECS instance is manually added to a scaling group and managed by the scaling group, the ECS instance is stopped in economical mode or is released after the instance is removed from the scaling group.
8859
- * * If an ECS instance is manually added to a scaling group and is not managed by the scaling group, the ECS instance is not stopped or released after the instance is removed from the scaling group.
8860
- * * If the difference between the number of existing ECS instances specified by the TotalCapacity parameter and the number of ECS instances that you call this operation to remove is less than the value of the MinSize parameter, the call fails.
8861
- * A successful call only means that Auto Scaling accepts the request. The scaling activity may still fail. You can obtain the status of a scaling activity based on the value of the ScalingActivityId parameter in the response.
8862
- *
8863
- * @param request RemoveInstancesRequest
8864
- * @param runtime runtime options for this request RuntimeOptions
8865
- * @return RemoveInstancesResponse
9782
+ * @summary Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
9783
+ *
9784
+ * @description * Before you call this operation, make sure that the following requirements are met:
9785
+ * * The scaling group is in the Active state.
9786
+ * * No scaling activity is in progress within the scaling group.
9787
+ * > If no scaling activity is in progress within the scaling group, you can call the operation even within the cooldown period.
9788
+ * * If an ECS instance is automatically created by Auto Scaling, or if an ECS instance is manually added to a scaling group and managed by the scaling group, the ECS instance is stopped in economical mode or is released after the instance is removed from the scaling group.
9789
+ * * If an ECS instance is manually added to a scaling group and is not managed by the scaling group, the ECS instance is not stopped or released after the instance is removed from the scaling group.
9790
+ * * If the difference between the number of existing ECS instances specified by the TotalCapacity parameter and the number of ECS instances that you call this operation to remove is less than the value of the MinSize parameter, the call fails.
9791
+ * A successful call only means that Auto Scaling accepts the request. The scaling activity may still fail. You can obtain the status of a scaling activity based on the value of the ScalingActivityId parameter in the response.
9792
+ *
9793
+ * @param request RemoveInstancesRequest
9794
+ * @param runtime runtime options for this request RuntimeOptions
9795
+ * @return RemoveInstancesResponse
8866
9796
  */
8867
9797
  removeInstancesWithOptions(request: RemoveInstancesRequest, runtime: $Util.RuntimeOptions): Promise<RemoveInstancesResponse>;
8868
9798
  /**
8869
- * * Before you call this operation, make sure that the following requirements are met:
8870
- * * The scaling group is in the Active state.
8871
- * * No scaling activity is in progress within the scaling group.
8872
- * > If no scaling activity is in progress within the scaling group, you can call the operation even within the cooldown period.
8873
- * * If an ECS instance is automatically created by Auto Scaling, or if an ECS instance is manually added to a scaling group and managed by the scaling group, the ECS instance is stopped in economical mode or is released after the instance is removed from the scaling group.
8874
- * * If an ECS instance is manually added to a scaling group and is not managed by the scaling group, the ECS instance is not stopped or released after the instance is removed from the scaling group.
8875
- * * If the difference between the number of existing ECS instances specified by the TotalCapacity parameter and the number of ECS instances that you call this operation to remove is less than the value of the MinSize parameter, the call fails.
8876
- * A successful call only means that Auto Scaling accepts the request. The scaling activity may still fail. You can obtain the status of a scaling activity based on the value of the ScalingActivityId parameter in the response.
8877
- *
8878
- * @param request RemoveInstancesRequest
8879
- * @return RemoveInstancesResponse
9799
+ * @summary Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
9800
+ *
9801
+ * @description * Before you call this operation, make sure that the following requirements are met:
9802
+ * * The scaling group is in the Active state.
9803
+ * * No scaling activity is in progress within the scaling group.
9804
+ * > If no scaling activity is in progress within the scaling group, you can call the operation even within the cooldown period.
9805
+ * * If an ECS instance is automatically created by Auto Scaling, or if an ECS instance is manually added to a scaling group and managed by the scaling group, the ECS instance is stopped in economical mode or is released after the instance is removed from the scaling group.
9806
+ * * If an ECS instance is manually added to a scaling group and is not managed by the scaling group, the ECS instance is not stopped or released after the instance is removed from the scaling group.
9807
+ * * If the difference between the number of existing ECS instances specified by the TotalCapacity parameter and the number of ECS instances that you call this operation to remove is less than the value of the MinSize parameter, the call fails.
9808
+ * A successful call only means that Auto Scaling accepts the request. The scaling activity may still fail. You can obtain the status of a scaling activity based on the value of the ScalingActivityId parameter in the response.
9809
+ *
9810
+ * @param request RemoveInstancesRequest
9811
+ * @return RemoveInstancesResponse
8880
9812
  */
8881
9813
  removeInstances(request: RemoveInstancesRequest): Promise<RemoveInstancesResponse>;
9814
+ /**
9815
+ * @summary Resumes suspended processes in a scaling group.
9816
+ *
9817
+ * @param request ResumeProcessesRequest
9818
+ * @param runtime runtime options for this request RuntimeOptions
9819
+ * @return ResumeProcessesResponse
9820
+ */
8882
9821
  resumeProcessesWithOptions(request: ResumeProcessesRequest, runtime: $Util.RuntimeOptions): Promise<ResumeProcessesResponse>;
9822
+ /**
9823
+ * @summary Resumes suspended processes in a scaling group.
9824
+ *
9825
+ * @param request ResumeProcessesRequest
9826
+ * @return ResumeProcessesResponse
9827
+ */
8883
9828
  resumeProcesses(request: ResumeProcessesRequest): Promise<ResumeProcessesResponse>;
8884
9829
  /**
8885
- * Compared with the ExecuteScalingRule operation, the ScaleWithAdjustment operation does not require a scaling rule to be created in advance. Before you call the ScaleWithAdjustment operation, take note of the following items:
8886
- * * The following conditions must be met:
8887
- * * The scaling group is in the Active state.
8888
- * * No scaling activities in the scaling group are in progress.
8889
- * * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8890
- * * If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.
8891
- * * If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.
8892
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the `ScalingActivityId` parameter in the response.
8893
- *
8894
- * @param tmpReq ScaleWithAdjustmentRequest
8895
- * @param runtime runtime options for this request RuntimeOptions
8896
- * @return ScaleWithAdjustmentResponse
9830
+ * @summary Scales instances in a scaling group based on the specified scaling policy.
9831
+ *
9832
+ * @description Compared with the ExecuteScalingRule operation, the ScaleWithAdjustment operation does not require a scaling rule to be created in advance. Before you call the ScaleWithAdjustment operation, take note of the following items:
9833
+ * * The following conditions must be met:
9834
+ * * The scaling group is in the Active state.
9835
+ * * No scaling activities in the scaling group are in progress.
9836
+ * * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9837
+ * * If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.
9838
+ * * If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.
9839
+ * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the `ScalingActivityId` parameter in the response.
9840
+ *
9841
+ * @param tmpReq ScaleWithAdjustmentRequest
9842
+ * @param runtime runtime options for this request RuntimeOptions
9843
+ * @return ScaleWithAdjustmentResponse
8897
9844
  */
8898
9845
  scaleWithAdjustmentWithOptions(tmpReq: ScaleWithAdjustmentRequest, runtime: $Util.RuntimeOptions): Promise<ScaleWithAdjustmentResponse>;
8899
9846
  /**
8900
- * Compared with the ExecuteScalingRule operation, the ScaleWithAdjustment operation does not require a scaling rule to be created in advance. Before you call the ScaleWithAdjustment operation, take note of the following items:
8901
- * * The following conditions must be met:
8902
- * * The scaling group is in the Active state.
8903
- * * No scaling activities in the scaling group are in progress.
8904
- * * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8905
- * * If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.
8906
- * * If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.
8907
- * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the `ScalingActivityId` parameter in the response.
8908
- *
8909
- * @param request ScaleWithAdjustmentRequest
8910
- * @return ScaleWithAdjustmentResponse
9847
+ * @summary Scales instances in a scaling group based on the specified scaling policy.
9848
+ *
9849
+ * @description Compared with the ExecuteScalingRule operation, the ScaleWithAdjustment operation does not require a scaling rule to be created in advance. Before you call the ScaleWithAdjustment operation, take note of the following items:
9850
+ * * The following conditions must be met:
9851
+ * * The scaling group is in the Active state.
9852
+ * * No scaling activities in the scaling group are in progress.
9853
+ * * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9854
+ * * If the addition of a specified number of Elastic Compute Service (ECS) instances to a scaling group causes the total number of ECS instances in the scaling group to exceed the maximum number of instances allowed, Auto Scaling adds only a specific number of ECS instances to ensure that the total number of instances is equal to the maximum number of instances.
9855
+ * * If the removal of a specified number of ECS instances from a scaling group causes the total number of ECS instances in the scaling group to drop below the minimum number of instances allowed, Auto Scaling removes only a specific number of ECS instances to ensure that the total number of instances is equal to the minimum number of instances.
9856
+ * A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity by using the value of the `ScalingActivityId` parameter in the response.
9857
+ *
9858
+ * @param request ScaleWithAdjustmentRequest
9859
+ * @return ScaleWithAdjustmentResponse
8911
9860
  */
8912
9861
  scaleWithAdjustment(request: ScaleWithAdjustmentRequest): Promise<ScaleWithAdjustmentResponse>;
9862
+ /**
9863
+ * @summary Sets deletion protection for a scaling group. If you enable deletion protection for a scaling group, you cannot delete the scaling group. If you disable deletion protection for a scaling group, you can directly delete the scaling group. You can call the SetGroupDeletionProtection operation to enable or disable deletion protection.
9864
+ *
9865
+ * @param request SetGroupDeletionProtectionRequest
9866
+ * @param runtime runtime options for this request RuntimeOptions
9867
+ * @return SetGroupDeletionProtectionResponse
9868
+ */
8913
9869
  setGroupDeletionProtectionWithOptions(request: SetGroupDeletionProtectionRequest, runtime: $Util.RuntimeOptions): Promise<SetGroupDeletionProtectionResponse>;
9870
+ /**
9871
+ * @summary Sets deletion protection for a scaling group. If you enable deletion protection for a scaling group, you cannot delete the scaling group. If you disable deletion protection for a scaling group, you can directly delete the scaling group. You can call the SetGroupDeletionProtection operation to enable or disable deletion protection.
9872
+ *
9873
+ * @param request SetGroupDeletionProtectionRequest
9874
+ * @return SetGroupDeletionProtectionResponse
9875
+ */
8914
9876
  setGroupDeletionProtection(request: SetGroupDeletionProtectionRequest): Promise<SetGroupDeletionProtectionResponse>;
8915
9877
  /**
8916
- * Configures the health check feature for Elastic Compute Service (ECS) instances.
8917
- *
8918
- * @param request SetInstanceHealthRequest
8919
- * @param runtime runtime options for this request RuntimeOptions
8920
- * @return SetInstanceHealthResponse
9878
+ * @summary Sets instance health. At times, the automatic health check system might not sufficiently determine the precise health status of your Elastic Compute Service (ECS) instances or elastic container instances. To overcome this, you can call the SetInstanceHealth operation to swiftly pinpoint problematic instances and resolve issues. This operation is designed to more precisely align with real-world business requirements and tackle O\\&M hurdles efficiently.
9879
+ *
9880
+ * @description Auto Scaling detects and removes unhealthy ECS instances or elastic container instances from the corresponding scaling groups. If you want to retain a specific instance in the corresponding scaling group, you can put the instance into the Standby or Protected state. For more information, see [EnterStandby](~~EnterStandby~~) and [SetInstancesProtection](~~SetInstancesProtection~~).
9881
+ *
9882
+ * @param request SetInstanceHealthRequest
9883
+ * @param runtime runtime options for this request RuntimeOptions
9884
+ * @return SetInstanceHealthResponse
8921
9885
  */
8922
9886
  setInstanceHealthWithOptions(request: SetInstanceHealthRequest, runtime: $Util.RuntimeOptions): Promise<SetInstanceHealthResponse>;
8923
9887
  /**
8924
- * Configures the health check feature for Elastic Compute Service (ECS) instances.
8925
- *
8926
- * @param request SetInstanceHealthRequest
8927
- * @return SetInstanceHealthResponse
9888
+ * @summary Sets instance health. At times, the automatic health check system might not sufficiently determine the precise health status of your Elastic Compute Service (ECS) instances or elastic container instances. To overcome this, you can call the SetInstanceHealth operation to swiftly pinpoint problematic instances and resolve issues. This operation is designed to more precisely align with real-world business requirements and tackle O\\&M hurdles efficiently.
9889
+ *
9890
+ * @description Auto Scaling detects and removes unhealthy ECS instances or elastic container instances from the corresponding scaling groups. If you want to retain a specific instance in the corresponding scaling group, you can put the instance into the Standby or Protected state. For more information, see [EnterStandby](~~EnterStandby~~) and [SetInstancesProtection](~~SetInstancesProtection~~).
9891
+ *
9892
+ * @param request SetInstanceHealthRequest
9893
+ * @return SetInstanceHealthResponse
8928
9894
  */
8929
9895
  setInstanceHealth(request: SetInstanceHealthRequest): Promise<SetInstanceHealthResponse>;
8930
9896
  /**
8931
- * Puts one or more Elastic Compute Service (ECS) instances into the Protected state.
8932
- *
8933
- * @param request SetInstancesProtectionRequest
8934
- * @param runtime runtime options for this request RuntimeOptions
8935
- * @return SetInstancesProtectionResponse
9897
+ * @summary Puts Elastic Compute Service (ECS) instances into the Protected state. When ECS instances are put into the Protected state, they become immune to manual deletion attempts by using the Auto Scaling console or API operations. This operation serves as a robust safeguard, efficiently preventing any inadvertent instance release that could lead to irreversible consequences.
9898
+ *
9899
+ * @description Once ECS instances enter the Protected state, they become subject to the following restrictions:
9900
+ * * ECS instances will persist in the Protected state, unless you deliberately remove them from this state.
9901
+ * * Even in scenarios where automatic scale-in actions are initiated due to fluctuations in the number of ECS instances or the execution of event-triggered tasks, Auto Scaling does not remove ECS instances that are in the Protected state from their respective scaling groups. Only after being manually removed from their respective scaling groups can ECS instances that are in the Protected state be released. For more information, see [Remove an ECS instance](https://help.aliyun.com/document_detail/25955.html).
9902
+ * * ECS instances in the Protected state maintain their existing health status even when they undergo stopping or restarting processes.
9903
+ *
9904
+ * @param request SetInstancesProtectionRequest
9905
+ * @param runtime runtime options for this request RuntimeOptions
9906
+ * @return SetInstancesProtectionResponse
8936
9907
  */
8937
9908
  setInstancesProtectionWithOptions(request: SetInstancesProtectionRequest, runtime: $Util.RuntimeOptions): Promise<SetInstancesProtectionResponse>;
8938
9909
  /**
8939
- * Puts one or more Elastic Compute Service (ECS) instances into the Protected state.
8940
- *
8941
- * @param request SetInstancesProtectionRequest
8942
- * @return SetInstancesProtectionResponse
9910
+ * @summary Puts Elastic Compute Service (ECS) instances into the Protected state. When ECS instances are put into the Protected state, they become immune to manual deletion attempts by using the Auto Scaling console or API operations. This operation serves as a robust safeguard, efficiently preventing any inadvertent instance release that could lead to irreversible consequences.
9911
+ *
9912
+ * @description Once ECS instances enter the Protected state, they become subject to the following restrictions:
9913
+ * * ECS instances will persist in the Protected state, unless you deliberately remove them from this state.
9914
+ * * Even in scenarios where automatic scale-in actions are initiated due to fluctuations in the number of ECS instances or the execution of event-triggered tasks, Auto Scaling does not remove ECS instances that are in the Protected state from their respective scaling groups. Only after being manually removed from their respective scaling groups can ECS instances that are in the Protected state be released. For more information, see [Remove an ECS instance](https://help.aliyun.com/document_detail/25955.html).
9915
+ * * ECS instances in the Protected state maintain their existing health status even when they undergo stopping or restarting processes.
9916
+ *
9917
+ * @param request SetInstancesProtectionRequest
9918
+ * @return SetInstancesProtectionResponse
8943
9919
  */
8944
9920
  setInstancesProtection(request: SetInstancesProtectionRequest): Promise<SetInstancesProtectionResponse>;
9921
+ /**
9922
+ * @summary Suspends scaling processes. This operation empowers you to selectively pause distinct scaling processes within a particular scaling group, enabling you to carry out alternative tasks and achieve more granular management over your scaling operations.
9923
+ *
9924
+ * @param request SuspendProcessesRequest
9925
+ * @param runtime runtime options for this request RuntimeOptions
9926
+ * @return SuspendProcessesResponse
9927
+ */
8945
9928
  suspendProcessesWithOptions(request: SuspendProcessesRequest, runtime: $Util.RuntimeOptions): Promise<SuspendProcessesResponse>;
9929
+ /**
9930
+ * @summary Suspends scaling processes. This operation empowers you to selectively pause distinct scaling processes within a particular scaling group, enabling you to carry out alternative tasks and achieve more granular management over your scaling operations.
9931
+ *
9932
+ * @param request SuspendProcessesRequest
9933
+ * @return SuspendProcessesResponse
9934
+ */
8946
9935
  suspendProcesses(request: SuspendProcessesRequest): Promise<SuspendProcessesResponse>;
9936
+ /**
9937
+ * @summary Adds tags to specified Auto Scaling resources.
9938
+ *
9939
+ * @param request TagResourcesRequest
9940
+ * @param runtime runtime options for this request RuntimeOptions
9941
+ * @return TagResourcesResponse
9942
+ */
8947
9943
  tagResourcesWithOptions(request: TagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<TagResourcesResponse>;
9944
+ /**
9945
+ * @summary Adds tags to specified Auto Scaling resources.
9946
+ *
9947
+ * @param request TagResourcesRequest
9948
+ * @return TagResourcesResponse
9949
+ */
8948
9950
  tagResources(request: TagResourcesRequest): Promise<TagResourcesResponse>;
9951
+ /**
9952
+ * @summary Removes tags from Auto Scaling resources simultaneously. This operation streamlines resource management activities, enhances system efficiency, and mitigates potential security vulnerabilities. Once a tag is removed from a particular resource, and if it is not re-added to any other resource, the system will automatically delete the unused tag.
9953
+ *
9954
+ * @param request UntagResourcesRequest
9955
+ * @param runtime runtime options for this request RuntimeOptions
9956
+ * @return UntagResourcesResponse
9957
+ */
8949
9958
  untagResourcesWithOptions(request: UntagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<UntagResourcesResponse>;
9959
+ /**
9960
+ * @summary Removes tags from Auto Scaling resources simultaneously. This operation streamlines resource management activities, enhances system efficiency, and mitigates potential security vulnerabilities. Once a tag is removed from a particular resource, and if it is not re-added to any other resource, the system will automatically delete the unused tag.
9961
+ *
9962
+ * @param request UntagResourcesRequest
9963
+ * @return UntagResourcesResponse
9964
+ */
8950
9965
  untagResources(request: UntagResourcesRequest): Promise<UntagResourcesResponse>;
9966
+ /**
9967
+ * @summary Checks whether Auto Scaling is authorized to access Elastic Compute Service (ECS) and Elastic Container Instance resources.
9968
+ *
9969
+ * @param request VerifyAuthenticationRequest
9970
+ * @param runtime runtime options for this request RuntimeOptions
9971
+ * @return VerifyAuthenticationResponse
9972
+ */
8951
9973
  verifyAuthenticationWithOptions(request: VerifyAuthenticationRequest, runtime: $Util.RuntimeOptions): Promise<VerifyAuthenticationResponse>;
9974
+ /**
9975
+ * @summary Checks whether Auto Scaling is authorized to access Elastic Compute Service (ECS) and Elastic Container Instance resources.
9976
+ *
9977
+ * @param request VerifyAuthenticationRequest
9978
+ * @return VerifyAuthenticationResponse
9979
+ */
8952
9980
  verifyAuthentication(request: VerifyAuthenticationRequest): Promise<VerifyAuthenticationResponse>;
9981
+ /**
9982
+ * @summary Verifies whether Auto Scaling is activated. This operation guarantees that in response to shifts in business workloads or variations in incoming traffic, the system will automatically adjust resource provisioning. This auto-scaling capability enhances the overall system performance, ensuring high availability and improved flexibility to accommodate dynamic demands.
9983
+ *
9984
+ * @param request VerifyUserRequest
9985
+ * @param runtime runtime options for this request RuntimeOptions
9986
+ * @return VerifyUserResponse
9987
+ */
8953
9988
  verifyUserWithOptions(request: VerifyUserRequest, runtime: $Util.RuntimeOptions): Promise<VerifyUserResponse>;
9989
+ /**
9990
+ * @summary Verifies whether Auto Scaling is activated. This operation guarantees that in response to shifts in business workloads or variations in incoming traffic, the system will automatically adjust resource provisioning. This auto-scaling capability enhances the overall system performance, ensuring high availability and improved flexibility to accommodate dynamic demands.
9991
+ *
9992
+ * @param request VerifyUserRequest
9993
+ * @return VerifyUserResponse
9994
+ */
8954
9995
  verifyUser(request: VerifyUserRequest): Promise<VerifyUserResponse>;
8955
9996
  }