@alicloud/ess20220222 1.3.2 → 1.4.0

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;
@@ -6227,6 +6280,22 @@ export declare class DescribeNotificationConfigurationsResponseBodyNotificationC
6227
6280
  [key: string]: any;
6228
6281
  });
6229
6282
  }
6283
+ export declare class DescribePatternTypesResponseBodyPatternTypes extends $tea.Model {
6284
+ cores?: number;
6285
+ instanceFamilyLevel?: string;
6286
+ instanceType?: string;
6287
+ instanceTypeFamily?: string;
6288
+ memory?: number;
6289
+ static names(): {
6290
+ [key: string]: string;
6291
+ };
6292
+ static types(): {
6293
+ [key: string]: any;
6294
+ };
6295
+ constructor(map?: {
6296
+ [key: string]: any;
6297
+ });
6298
+ }
6230
6299
  export declare class DescribeRegionsResponseBodyRegions extends $tea.Model {
6231
6300
  classicUnavailable?: boolean;
6232
6301
  localName?: string;
@@ -8051,905 +8120,1859 @@ export default class Client extends OpenApi {
8051
8120
  getEndpoint(productId: string, regionId: string, endpointRule: string, network: string, suffix: string, endpointMap: {
8052
8121
  [key: string]: string;
8053
8122
  }, endpoint: string): string;
8123
+ /**
8124
+ * @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.
8125
+ *
8126
+ * @description You can manage scaling configurations of the Elastic Container Instance type by using a YAML configuration file based on the following logic:
8127
+ * 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.
8128
+ *
8129
+ * @param request ApplyEciScalingConfigurationRequest
8130
+ * @param runtime runtime options for this request RuntimeOptions
8131
+ * @return ApplyEciScalingConfigurationResponse
8132
+ */
8054
8133
  applyEciScalingConfigurationWithOptions(request: ApplyEciScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ApplyEciScalingConfigurationResponse>;
8134
+ /**
8135
+ * @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.
8136
+ *
8137
+ * @description You can manage scaling configurations of the Elastic Container Instance type by using a YAML configuration file based on the following logic:
8138
+ * 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.
8139
+ *
8140
+ * @param request ApplyEciScalingConfigurationRequest
8141
+ * @return ApplyEciScalingConfigurationResponse
8142
+ */
8055
8143
  applyEciScalingConfiguration(request: ApplyEciScalingConfigurationRequest): Promise<ApplyEciScalingConfigurationResponse>;
8144
+ /**
8145
+ * @summary 基于yaml配置进行弹性伸缩管理
8146
+ *
8147
+ * @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.
8148
+ * 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.
8149
+ * You can use a Kubernetes Deployment YAML file to manage a scaling group based on the following logic:
8150
+ * * 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.
8151
+ * * 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.
8152
+ * ### Precautions
8153
+ * 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.
8154
+ * 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.
8155
+ * 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.
8156
+ * ### Supported annotations
8157
+ * For more information about annotations, see [ECI Pod Annotation](https://help.aliyun.com/document_detail/186939.html).
8158
+ * |Annotation|Example|Description|
8159
+ * |---|---|---|
8160
+ * |k8s.aliyun.com/ess-scaling-group-min-size|1|The minimum size of the scaling group that you want to create. Default value: 0.|
8161
+ * |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.|
8162
+ * |k8s.aliyun.com/eci-ntp-server|100.100.*.*|The IP address of the Network Time Protocol (NTP) server.|
8163
+ * |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).|
8164
+ * |k8s.aliyun.com/eci-vswitch|vsw-bp1xpiowfm5vo8o3c\\*\\*\\*\\*|The ID of the vSwitch. You can specify multiple vSwitches to specify multiple zones.|
8165
+ * |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>|
8166
+ * |k8s.aliyun.com/eci-sls-enable|"false"|If you set the value to false, the log collection feature is disabled.
8167
+ * 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.|
8168
+ * |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>|
8169
+ * |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.
8170
+ * This annotation takes effect only when you set the k8s.aliyun.com/eci-spot-strategy annotation to SpotWithPriceLimit.|
8171
+ * |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.|
8172
+ * |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.|
8173
+ * |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.
8174
+ * By default, enhanced SSDs (ESSDs) are created. Default value: PL1.|
8175
+ * |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).
8176
+ * If you configure this annotation, the cloud disk that is created by using the specified DataCache is of the ESSD AutoPL type.|
8177
+ * |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).
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-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 (,).|
8180
+ *
8181
+ * @param request ApplyScalingGroupRequest
8182
+ * @param runtime runtime options for this request RuntimeOptions
8183
+ * @return ApplyScalingGroupResponse
8184
+ */
8056
8185
  applyScalingGroupWithOptions(request: ApplyScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<ApplyScalingGroupResponse>;
8186
+ /**
8187
+ * @summary 基于yaml配置进行弹性伸缩管理
8188
+ *
8189
+ * @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.
8190
+ * 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.
8191
+ * You can use a Kubernetes Deployment YAML file to manage a scaling group based on the following logic:
8192
+ * * 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.
8193
+ * * 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.
8194
+ * ### Precautions
8195
+ * 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.
8196
+ * 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.
8197
+ * 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.
8198
+ * ### Supported annotations
8199
+ * For more information about annotations, see [ECI Pod Annotation](https://help.aliyun.com/document_detail/186939.html).
8200
+ * |Annotation|Example|Description|
8201
+ * |---|---|---|
8202
+ * |k8s.aliyun.com/ess-scaling-group-min-size|1|The minimum size of the scaling group that you want to create. Default value: 0.|
8203
+ * |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.|
8204
+ * |k8s.aliyun.com/eci-ntp-server|100.100.*.*|The IP address of the Network Time Protocol (NTP) server.|
8205
+ * |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).|
8206
+ * |k8s.aliyun.com/eci-vswitch|vsw-bp1xpiowfm5vo8o3c\\*\\*\\*\\*|The ID of the vSwitch. You can specify multiple vSwitches to specify multiple zones.|
8207
+ * |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>|
8208
+ * |k8s.aliyun.com/eci-sls-enable|"false"|If you set the value to false, the log collection feature is disabled.
8209
+ * 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.|
8210
+ * |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>|
8211
+ * |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.
8212
+ * This annotation takes effect only when you set the k8s.aliyun.com/eci-spot-strategy annotation to SpotWithPriceLimit.|
8213
+ * |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.|
8214
+ * |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.|
8215
+ * |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.
8216
+ * By default, enhanced SSDs (ESSDs) are created. Default value: PL1.|
8217
+ * |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).
8218
+ * If you configure this annotation, the cloud disk that is created by using the specified DataCache is of the ESSD AutoPL type.|
8219
+ * |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).
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-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 (,).|
8222
+ *
8223
+ * @param request ApplyScalingGroupRequest
8224
+ * @return ApplyScalingGroupResponse
8225
+ */
8057
8226
  applyScalingGroup(request: ApplyScalingGroupRequest): Promise<ApplyScalingGroupResponse>;
8058
8227
  /**
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
8228
+ * @summary Associates Application Load Balancer (ALB) server groups with a scaling group.
8229
+ *
8230
+ * @description Before you associate an ALB server group with a scaling group, make sure that the following requirements are met:
8231
+ * * The scaling group resides in a virtual private cloud (VPC). The scaling group and the ALB server group must reside in the same VPC.
8232
+ * * The ALB server group is in the Available state.
8233
+ * * 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).
8234
+ *
8235
+ * @param request AttachAlbServerGroupsRequest
8236
+ * @param runtime runtime options for this request RuntimeOptions
8237
+ * @return AttachAlbServerGroupsResponse
8067
8238
  */
8068
8239
  attachAlbServerGroupsWithOptions(request: AttachAlbServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<AttachAlbServerGroupsResponse>;
8069
8240
  /**
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
8241
+ * @summary Associates Application Load Balancer (ALB) server groups with a scaling group.
8242
+ *
8243
+ * @description Before you associate an ALB server group with a scaling group, make sure that the following requirements are met:
8244
+ * * The scaling group resides in a virtual private cloud (VPC). The scaling group and the ALB server group must reside in the same VPC.
8245
+ * * The ALB server group is in the Available state.
8246
+ * * 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).
8247
+ *
8248
+ * @param request AttachAlbServerGroupsRequest
8249
+ * @return AttachAlbServerGroupsResponse
8077
8250
  */
8078
8251
  attachAlbServerGroups(request: AttachAlbServerGroupsRequest): Promise<AttachAlbServerGroupsResponse>;
8079
8252
  /**
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
8253
+ * @summary Associates one or more ApsaraDB RDS instances with a scaling group.
8254
+ *
8255
+ * @description Before you associate an ApsaraDB RDS instance with a scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
8256
+ * * The ApsaraDB RDS instance and the scaling group must belong to the same Alibaba Cloud account.
8257
+ * * 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).
8258
+ * * The ApsaraDB RDS instance must be in the Running state.
8259
+ * 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).
8260
+ *
8261
+ * @param request AttachDBInstancesRequest
8262
+ * @param runtime runtime options for this request RuntimeOptions
8263
+ * @return AttachDBInstancesResponse
8089
8264
  */
8090
8265
  attachDBInstancesWithOptions(request: AttachDBInstancesRequest, runtime: $Util.RuntimeOptions): Promise<AttachDBInstancesResponse>;
8091
8266
  /**
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
8267
+ * @summary Associates one or more ApsaraDB RDS instances with a scaling group.
8268
+ *
8269
+ * @description Before you associate an ApsaraDB RDS instance with a scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
8270
+ * * The ApsaraDB RDS instance and the scaling group must belong to the same Alibaba Cloud account.
8271
+ * * 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).
8272
+ * * The ApsaraDB RDS instance must be in the Running state.
8273
+ * 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).
8274
+ *
8275
+ * @param request AttachDBInstancesRequest
8276
+ * @return AttachDBInstancesResponse
8100
8277
  */
8101
8278
  attachDBInstances(request: AttachDBInstancesRequest): Promise<AttachDBInstancesResponse>;
8102
8279
  /**
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
8280
+ * @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.
8281
+ *
8282
+ * @description Before you call this operation, take note of the following items:
8283
+ * * The scaling group is in the Active state.
8284
+ * * No scaling activities in the scaling group are in progress.
8285
+ * The ECS instances or the elastic container instances that you want to add to a scaling group must meet the following requirements:
8286
+ * * The instances reside in the same region as the scaling group.
8287
+ * * The instances must be in the Running state.
8288
+ * * The instances are not added to other scaling groups.
8289
+ * * The instances use the subscription or pay-as-you-go billing method, or are preemptible instances.
8290
+ * * 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.
8291
+ * * If the VswitchID parameter is not specified for a scaling group, the instances that are in VPCs cannot be added to the scaling group.
8292
+ * If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8293
+ * 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.
8294
+ * 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.
8295
+ * Instances that are manually added by calling the AttachInstances operation are not associated with the active scaling configuration of the scaling group.
8296
+ *
8297
+ * @param request AttachInstancesRequest
8298
+ * @param runtime runtime options for this request RuntimeOptions
8299
+ * @return AttachInstancesResponse
8121
8300
  */
8122
8301
  attachInstancesWithOptions(request: AttachInstancesRequest, runtime: $Util.RuntimeOptions): Promise<AttachInstancesResponse>;
8123
8302
  /**
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
8303
+ * @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.
8304
+ *
8305
+ * @description Before you call this operation, take note of the following items:
8306
+ * * The scaling group is in the Active state.
8307
+ * * No scaling activities in the scaling group are in progress.
8308
+ * The ECS instances or the elastic container instances that you want to add to a scaling group must meet the following requirements:
8309
+ * * The instances reside in the same region as the scaling group.
8310
+ * * The instances must be in the Running state.
8311
+ * * The instances are not added to other scaling groups.
8312
+ * * The instances use the subscription or pay-as-you-go billing method, or are preemptible instances.
8313
+ * * 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.
8314
+ * * If the VswitchID parameter is not specified for a scaling group, the instances that are in VPCs cannot be added to the scaling group.
8315
+ * If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
8316
+ * 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.
8317
+ * 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.
8318
+ * Instances that are manually added by calling the AttachInstances operation are not associated with the active scaling configuration of the scaling group.
8319
+ *
8320
+ * @param request AttachInstancesRequest
8321
+ * @return AttachInstancesResponse
8141
8322
  */
8142
8323
  attachInstances(request: AttachInstancesRequest): Promise<AttachInstancesResponse>;
8143
8324
  /**
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
8325
+ * @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.
8326
+ *
8327
+ * @description Before you call this operation, make sure that the following requirements are met:
8328
+ * * The load balancer and the scaling group belong to the same Alibaba Cloud account and region.
8329
+ * * The load balancer is in the `Running` state.
8330
+ * * At least one listener is configured for the load balancer, and the health check feature is enabled for the load balancer.
8331
+ * * If the network type of the load balancer and the scaling group is virtual private cloud (VPC), they use the same VPC.
8332
+ * * 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.
8333
+ * * 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).
8334
+ *
8335
+ * @param request AttachLoadBalancersRequest
8336
+ * @param runtime runtime options for this request RuntimeOptions
8337
+ * @return AttachLoadBalancersResponse
8156
8338
  */
8157
8339
  attachLoadBalancersWithOptions(request: AttachLoadBalancersRequest, runtime: $Util.RuntimeOptions): Promise<AttachLoadBalancersResponse>;
8158
8340
  /**
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
8341
+ * @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.
8342
+ *
8343
+ * @description Before you call this operation, make sure that the following requirements are met:
8344
+ * * The load balancer and the scaling group belong to the same Alibaba Cloud account and region.
8345
+ * * The load balancer is in the `Running` state.
8346
+ * * At least one listener is configured for the load balancer, and the health check feature is enabled for the load balancer.
8347
+ * * If the network type of the load balancer and the scaling group is virtual private cloud (VPC), they use the same VPC.
8348
+ * * 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.
8349
+ * * 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).
8350
+ *
8351
+ * @param request AttachLoadBalancersRequest
8352
+ * @return AttachLoadBalancersResponse
8170
8353
  */
8171
8354
  attachLoadBalancers(request: AttachLoadBalancersRequest): Promise<AttachLoadBalancersResponse>;
8355
+ /**
8356
+ * @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.
8357
+ *
8358
+ * @param request AttachServerGroupsRequest
8359
+ * @param runtime runtime options for this request RuntimeOptions
8360
+ * @return AttachServerGroupsResponse
8361
+ */
8172
8362
  attachServerGroupsWithOptions(request: AttachServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<AttachServerGroupsResponse>;
8363
+ /**
8364
+ * @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.
8365
+ *
8366
+ * @param request AttachServerGroupsRequest
8367
+ * @return AttachServerGroupsResponse
8368
+ */
8173
8369
  attachServerGroups(request: AttachServerGroupsRequest): Promise<AttachServerGroupsResponse>;
8174
8370
  /**
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
8371
+ * @summary Associates Sever Load Balancer (SLB) vServer groups with a scaling group.
8372
+ *
8373
+ * @description Before you call this operation to attach a vServer group to your scaling group, take note of the following items:
8374
+ * * The CLB instance and the scaling group must belong to the same Alibaba Cloud account.
8375
+ * * The CLB instance and the scaling group must reside in the same region.
8376
+ * * The CLB instance must be in the Running state.
8377
+ * * The CLB instance must be configured with at least one listener. Health check is enabled for the CLB instance.
8378
+ * * The CLB instance and the scaling group must be in the same VPC if their network type is VPC.
8379
+ * * 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.
8380
+ * * The vServer group that you want to attach to your scaling group must belong to the CLB instance.
8381
+ * * 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).
8382
+ * When you call this operation, you must specify the following parameters:
8383
+ * * LoadBalancerId: the ID of the CLB instance.
8384
+ * * VServerGroupId: the ID of the vServer group.
8385
+ * * Port: the port number of the vServer group.
8386
+ * 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.
8387
+ *
8388
+ * @param request AttachVServerGroupsRequest
8389
+ * @param runtime runtime options for this request RuntimeOptions
8390
+ * @return AttachVServerGroupsResponse
8193
8391
  */
8194
8392
  attachVServerGroupsWithOptions(request: AttachVServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<AttachVServerGroupsResponse>;
8195
8393
  /**
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
8394
+ * @summary Associates Sever Load Balancer (SLB) vServer groups with a scaling group.
8395
+ *
8396
+ * @description Before you call this operation to attach a vServer group to your scaling group, take note of the following items:
8397
+ * * The CLB instance and the scaling group must belong to the same Alibaba Cloud account.
8398
+ * * The CLB instance and the scaling group must reside in the same region.
8399
+ * * The CLB instance must be in the Running state.
8400
+ * * The CLB instance must be configured with at least one listener. Health check is enabled for the CLB instance.
8401
+ * * The CLB instance and the scaling group must be in the same VPC if their network type is VPC.
8402
+ * * 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.
8403
+ * * The vServer group that you want to attach to your scaling group must belong to the CLB instance.
8404
+ * * 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).
8405
+ * When you call this operation, you must specify the following parameters:
8406
+ * * LoadBalancerId: the ID of the CLB instance.
8407
+ * * VServerGroupId: the ID of the vServer group.
8408
+ * * Port: the port number of the vServer group.
8409
+ * 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.
8410
+ *
8411
+ * @param request AttachVServerGroupsRequest
8412
+ * @return AttachVServerGroupsResponse
8213
8413
  */
8214
8414
  attachVServerGroups(request: AttachVServerGroupsRequest): Promise<AttachVServerGroupsResponse>;
8415
+ /**
8416
+ * @summary Adds a scaling group to a resource group.
8417
+ *
8418
+ * @param request ChangeResourceGroupRequest
8419
+ * @param runtime runtime options for this request RuntimeOptions
8420
+ * @return ChangeResourceGroupResponse
8421
+ */
8215
8422
  changeResourceGroupWithOptions(request: ChangeResourceGroupRequest, runtime: $Util.RuntimeOptions): Promise<ChangeResourceGroupResponse>;
8423
+ /**
8424
+ * @summary Adds a scaling group to a resource group.
8425
+ *
8426
+ * @param request ChangeResourceGroupRequest
8427
+ * @return ChangeResourceGroupResponse
8428
+ */
8216
8429
  changeResourceGroup(request: ChangeResourceGroupRequest): Promise<ChangeResourceGroupResponse>;
8217
8430
  /**
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
8431
+ * @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.
8432
+ *
8433
+ * @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.
8434
+ *
8435
+ * @param request CompleteLifecycleActionRequest
8436
+ * @param runtime runtime options for this request RuntimeOptions
8437
+ * @return CompleteLifecycleActionResponse
8223
8438
  */
8224
8439
  completeLifecycleActionWithOptions(request: CompleteLifecycleActionRequest, runtime: $Util.RuntimeOptions): Promise<CompleteLifecycleActionResponse>;
8225
8440
  /**
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
8441
+ * @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.
8442
+ *
8443
+ * @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.
8444
+ *
8445
+ * @param request CompleteLifecycleActionRequest
8446
+ * @return CompleteLifecycleActionResponse
8230
8447
  */
8231
8448
  completeLifecycleAction(request: CompleteLifecycleActionRequest): Promise<CompleteLifecycleActionResponse>;
8449
+ /**
8450
+ * @summary Creates an event-triggered task.
8451
+ *
8452
+ * @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).
8453
+ * * 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.
8454
+ * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
8455
+ * * 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).
8456
+ * > 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.
8457
+ *
8458
+ * @param request CreateAlarmRequest
8459
+ * @param runtime runtime options for this request RuntimeOptions
8460
+ * @return CreateAlarmResponse
8461
+ */
8232
8462
  createAlarmWithOptions(request: CreateAlarmRequest, runtime: $Util.RuntimeOptions): Promise<CreateAlarmResponse>;
8463
+ /**
8464
+ * @summary Creates an event-triggered task.
8465
+ *
8466
+ * @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).
8467
+ * * 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.
8468
+ * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
8469
+ * * 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).
8470
+ * > 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.
8471
+ *
8472
+ * @param request CreateAlarmRequest
8473
+ * @return CreateAlarmResponse
8474
+ */
8233
8475
  createAlarm(request: CreateAlarmRequest): Promise<CreateAlarmResponse>;
8234
8476
  /**
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
8477
+ * @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.
8478
+ *
8479
+ * @description A scaling configuration is a template that is used to create elastic container instances during scale-out activities.
8480
+ * 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.
8481
+ *
8482
+ * @param request CreateEciScalingConfigurationRequest
8483
+ * @param runtime runtime options for this request RuntimeOptions
8484
+ * @return CreateEciScalingConfigurationResponse
8241
8485
  */
8242
8486
  createEciScalingConfigurationWithOptions(request: CreateEciScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateEciScalingConfigurationResponse>;
8243
8487
  /**
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
8488
+ * @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.
8489
+ *
8490
+ * @description A scaling configuration is a template that is used to create elastic container instances during scale-out activities.
8491
+ * 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.
8492
+ *
8493
+ * @param request CreateEciScalingConfigurationRequest
8494
+ * @return CreateEciScalingConfigurationResponse
8249
8495
  */
8250
8496
  createEciScalingConfiguration(request: CreateEciScalingConfigurationRequest): Promise<CreateEciScalingConfigurationResponse>;
8251
8497
  /**
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
8498
+ * @summary Creates one or more lifecycle hooks.
8499
+ *
8500
+ * @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.
8501
+ * 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.
8502
+ * 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).
8503
+ * > 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.
8504
+ *
8505
+ * @param request CreateLifecycleHookRequest
8506
+ * @param runtime runtime options for this request RuntimeOptions
8507
+ * @return CreateLifecycleHookResponse
8260
8508
  */
8261
8509
  createLifecycleHookWithOptions(request: CreateLifecycleHookRequest, runtime: $Util.RuntimeOptions): Promise<CreateLifecycleHookResponse>;
8262
8510
  /**
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
8511
+ * @summary Creates one or more lifecycle hooks.
8512
+ *
8513
+ * @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.
8514
+ * 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.
8515
+ * 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).
8516
+ * > 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.
8517
+ *
8518
+ * @param request CreateLifecycleHookRequest
8519
+ * @return CreateLifecycleHookResponse
8270
8520
  */
8271
8521
  createLifecycleHook(request: CreateLifecycleHookRequest): Promise<CreateLifecycleHookResponse>;
8272
8522
  /**
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
8523
+ * @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.
8524
+ *
8525
+ * @description ## Description
8526
+ * 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.
8527
+ *
8528
+ * @param request CreateNotificationConfigurationRequest
8529
+ * @param runtime runtime options for this request RuntimeOptions
8530
+ * @return CreateNotificationConfigurationResponse
8279
8531
  */
8280
8532
  createNotificationConfigurationWithOptions(request: CreateNotificationConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateNotificationConfigurationResponse>;
8281
8533
  /**
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
8534
+ * @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.
8535
+ *
8536
+ * @description ## Description
8537
+ * 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.
8538
+ *
8539
+ * @param request CreateNotificationConfigurationRequest
8540
+ * @return CreateNotificationConfigurationResponse
8287
8541
  */
8288
8542
  createNotificationConfiguration(request: CreateNotificationConfigurationRequest): Promise<CreateNotificationConfigurationResponse>;
8289
8543
  /**
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
8544
+ * @summary Creates a scaling configuration.
8545
+ *
8546
+ * @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:
8547
+ * * 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.
8548
+ * * InstanceType: In this mode, you must specify one instance type.
8549
+ * * InstanceTypes: In this mode, you can specify more than one instance type.
8550
+ * * InstanceTypeOverrides: In this mode, you can specify multiple instance types and weights for the instance types.
8551
+ * * 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.
8552
+ * > 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.
8553
+ *
8554
+ * @param tmpReq CreateScalingConfigurationRequest
8555
+ * @param runtime runtime options for this request RuntimeOptions
8556
+ * @return CreateScalingConfigurationResponse
8301
8557
  */
8302
8558
  createScalingConfigurationWithOptions(tmpReq: CreateScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateScalingConfigurationResponse>;
8303
8559
  /**
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
8560
+ * @summary Creates a scaling configuration.
8561
+ *
8562
+ * @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:
8563
+ * * 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.
8564
+ * * InstanceType: In this mode, you must specify one instance type.
8565
+ * * InstanceTypes: In this mode, you can specify more than one instance type.
8566
+ * * InstanceTypeOverrides: In this mode, you can specify multiple instance types and weights for the instance types.
8567
+ * * 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.
8568
+ * > 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.
8569
+ *
8570
+ * @param request CreateScalingConfigurationRequest
8571
+ * @return CreateScalingConfigurationResponse
8314
8572
  */
8315
8573
  createScalingConfiguration(request: CreateScalingConfigurationRequest): Promise<CreateScalingConfigurationResponse>;
8316
8574
  /**
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
8575
+ * @summary Creates a scaling group.
8576
+ *
8577
+ * @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used in similar business scenarios.
8578
+ * 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.
8579
+ * 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.
8580
+ * 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.
8581
+ * 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:
8582
+ * * 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.
8583
+ * * 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.
8584
+ * > If you specify the default server group and multiple vServer groups at the same time, ECS instances are added to all specified server groups.
8585
+ * 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:
8586
+ * * The CLB instance must be in the Active state. You can call the DescribeLoadBalancers operation to query the state of the CLB instance.
8587
+ * * 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.
8588
+ * 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.
8589
+ * 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:
8590
+ * * 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.
8591
+ * * 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.
8592
+ * If you set the MultiAZPolicy parameter of the scaling group to COST_OPTIMIZED, take note of the following items:
8593
+ * * 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.
8594
+ * * 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.
8595
+ * If you set the `Tags.Propagate` parameter of the scaling group to true, the following rules apply:
8596
+ * * 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.
8597
+ * * 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.
8598
+ * * 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.
8599
+ *
8600
+ * @param request CreateScalingGroupRequest
8601
+ * @param runtime runtime options for this request RuntimeOptions
8602
+ * @return CreateScalingGroupResponse
8343
8603
  */
8344
8604
  createScalingGroupWithOptions(request: CreateScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateScalingGroupResponse>;
8345
8605
  /**
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
8606
+ * @summary Creates a scaling group.
8607
+ *
8608
+ * @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used in similar business scenarios.
8609
+ * 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.
8610
+ * 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.
8611
+ * 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.
8612
+ * 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:
8613
+ * * 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.
8614
+ * * 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.
8615
+ * > If you specify the default server group and multiple vServer groups at the same time, ECS instances are added to all specified server groups.
8616
+ * 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:
8617
+ * * The CLB instance must be in the Active state. You can call the DescribeLoadBalancers operation to query the state of the CLB instance.
8618
+ * * 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.
8619
+ * 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.
8620
+ * 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:
8621
+ * * 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.
8622
+ * * 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.
8623
+ * If you set the MultiAZPolicy parameter of the scaling group to COST_OPTIMIZED, take note of the following items:
8624
+ * * 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.
8625
+ * * 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.
8626
+ * If you set the `Tags.Propagate` parameter of the scaling group to true, the following rules apply:
8627
+ * * 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.
8628
+ * * 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.
8629
+ * * 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.
8630
+ *
8631
+ * @param request CreateScalingGroupRequest
8632
+ * @return CreateScalingGroupResponse
8371
8633
  */
8372
8634
  createScalingGroup(request: CreateScalingGroupRequest): Promise<CreateScalingGroupResponse>;
8373
8635
  /**
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
8636
+ * @summary Creates a scaling rule.
8637
+ *
8638
+ * @description ## Description
8639
+ * 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:
8640
+ * * 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.
8641
+ * * 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.
8642
+ * Before you call this operation, take note of the following items:
8643
+ * * 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.
8644
+ * * 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.
8645
+ * * 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.
8646
+ * * 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.
8647
+ * * You can create only a limited number of scaling rules for a scaling group. For more information, see the "Limits" topic.
8648
+ * * The unique identifier (ScalingRuleAri) of a scaling rule can be used by the following operations:
8649
+ * * 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.
8650
+ * * 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.
8651
+ *
8652
+ * @param request CreateScalingRuleRequest
8653
+ * @param runtime runtime options for this request RuntimeOptions
8654
+ * @return CreateScalingRuleResponse
8391
8655
  */
8392
8656
  createScalingRuleWithOptions(request: CreateScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<CreateScalingRuleResponse>;
8393
8657
  /**
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
8658
+ * @summary Creates a scaling rule.
8659
+ *
8660
+ * @description ## Description
8661
+ * 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:
8662
+ * * 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.
8663
+ * * 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.
8664
+ * Before you call this operation, take note of the following items:
8665
+ * * 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.
8666
+ * * 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.
8667
+ * * 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.
8668
+ * * 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.
8669
+ * * You can create only a limited number of scaling rules for a scaling group. For more information, see the "Limits" topic.
8670
+ * * The unique identifier (ScalingRuleAri) of a scaling rule can be used by the following operations:
8671
+ * * 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.
8672
+ * * 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.
8673
+ *
8674
+ * @param request CreateScalingRuleRequest
8675
+ * @return CreateScalingRuleResponse
8410
8676
  */
8411
8677
  createScalingRule(request: CreateScalingRuleRequest): Promise<CreateScalingRuleResponse>;
8412
8678
  /**
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
8679
+ * @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.
8680
+ *
8681
+ * @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.
8682
+ * * 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.``
8683
+ * * A scheduled task supports the following scaling methods:
8684
+ * * `ScheduledAction`: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
8685
+ * * `ScalingGroupId`: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you created the scheduled task.
8686
+ * > You cannot specify the `ScheduledAction` and ScalingGroupId parameters at the same time.
8687
+ *
8688
+ * @param request CreateScheduledTaskRequest
8689
+ * @param runtime runtime options for this request RuntimeOptions
8690
+ * @return CreateScheduledTaskResponse
8423
8691
  */
8424
8692
  createScheduledTaskWithOptions(request: CreateScheduledTaskRequest, runtime: $Util.RuntimeOptions): Promise<CreateScheduledTaskResponse>;
8425
8693
  /**
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
8694
+ * @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.
8695
+ *
8696
+ * @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.
8697
+ * * 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.``
8698
+ * * A scheduled task supports the following scaling methods:
8699
+ * * `ScheduledAction`: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
8700
+ * * `ScalingGroupId`: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you created the scheduled task.
8701
+ * > You cannot specify the `ScheduledAction` and ScalingGroupId parameters at the same time.
8702
+ *
8703
+ * @param request CreateScheduledTaskRequest
8704
+ * @return CreateScheduledTaskResponse
8435
8705
  */
8436
8706
  createScheduledTask(request: CreateScheduledTaskRequest): Promise<CreateScheduledTaskResponse>;
8707
+ /**
8708
+ * @summary Deactivates a scaling configuration.
8709
+ *
8710
+ * @description * You can call this operation to deactivate a scaling configuration only in a disabled scaling group.
8711
+ *
8712
+ * @param request DeactivateScalingConfigurationRequest
8713
+ * @param runtime runtime options for this request RuntimeOptions
8714
+ * @return DeactivateScalingConfigurationResponse
8715
+ */
8437
8716
  deactivateScalingConfigurationWithOptions(request: DeactivateScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeactivateScalingConfigurationResponse>;
8717
+ /**
8718
+ * @summary Deactivates a scaling configuration.
8719
+ *
8720
+ * @description * You can call this operation to deactivate a scaling configuration only in a disabled scaling group.
8721
+ *
8722
+ * @param request DeactivateScalingConfigurationRequest
8723
+ * @return DeactivateScalingConfigurationResponse
8724
+ */
8438
8725
  deactivateScalingConfiguration(request: DeactivateScalingConfigurationRequest): Promise<DeactivateScalingConfigurationResponse>;
8726
+ /**
8727
+ * @summary Deletes an event-triggered task.
8728
+ *
8729
+ * @param request DeleteAlarmRequest
8730
+ * @param runtime runtime options for this request RuntimeOptions
8731
+ * @return DeleteAlarmResponse
8732
+ */
8439
8733
  deleteAlarmWithOptions(request: DeleteAlarmRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAlarmResponse>;
8734
+ /**
8735
+ * @summary Deletes an event-triggered task.
8736
+ *
8737
+ * @param request DeleteAlarmRequest
8738
+ * @return DeleteAlarmResponse
8739
+ */
8440
8740
  deleteAlarm(request: DeleteAlarmRequest): Promise<DeleteAlarmResponse>;
8441
8741
  /**
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
8742
+ * @summary Deletes a scaling configuration that is used to create elastic container instances.
8743
+ *
8744
+ * @description You cannot delete a scaling configuration that is used to create elastic container instances in the following scenarios:
8745
+ * * The scaling configuration is in the Active state.
8746
+ * * The scaling group contains elastic container instances that are created based on the scaling configuration.
8747
+ *
8748
+ * @param request DeleteEciScalingConfigurationRequest
8749
+ * @param runtime runtime options for this request RuntimeOptions
8750
+ * @return DeleteEciScalingConfigurationResponse
8449
8751
  */
8450
8752
  deleteEciScalingConfigurationWithOptions(request: DeleteEciScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteEciScalingConfigurationResponse>;
8451
8753
  /**
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
8754
+ * @summary Deletes a scaling configuration that is used to create elastic container instances.
8755
+ *
8756
+ * @description You cannot delete a scaling configuration that is used to create elastic container instances in the following scenarios:
8757
+ * * The scaling configuration is in the Active state.
8758
+ * * The scaling group contains elastic container instances that are created based on the scaling configuration.
8759
+ *
8760
+ * @param request DeleteEciScalingConfigurationRequest
8761
+ * @return DeleteEciScalingConfigurationResponse
8458
8762
  */
8459
8763
  deleteEciScalingConfiguration(request: DeleteEciScalingConfigurationRequest): Promise<DeleteEciScalingConfigurationResponse>;
8764
+ /**
8765
+ * @summary Deletes a lifecycle hook.
8766
+ *
8767
+ * @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:
8768
+ * * 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.
8769
+ * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. In this case, the ScalingGroupId parameter and the LifecycleHookName parameter are ignored.
8770
+ *
8771
+ * @param request DeleteLifecycleHookRequest
8772
+ * @param runtime runtime options for this request RuntimeOptions
8773
+ * @return DeleteLifecycleHookResponse
8774
+ */
8460
8775
  deleteLifecycleHookWithOptions(request: DeleteLifecycleHookRequest, runtime: $Util.RuntimeOptions): Promise<DeleteLifecycleHookResponse>;
8776
+ /**
8777
+ * @summary Deletes a lifecycle hook.
8778
+ *
8779
+ * @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:
8780
+ * * 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.
8781
+ * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. In this case, the ScalingGroupId parameter and the LifecycleHookName parameter are ignored.
8782
+ *
8783
+ * @param request DeleteLifecycleHookRequest
8784
+ * @return DeleteLifecycleHookResponse
8785
+ */
8461
8786
  deleteLifecycleHook(request: DeleteLifecycleHookRequest): Promise<DeleteLifecycleHookResponse>;
8787
+ /**
8788
+ * @summary Deletes a notification.
8789
+ *
8790
+ * @param request DeleteNotificationConfigurationRequest
8791
+ * @param runtime runtime options for this request RuntimeOptions
8792
+ * @return DeleteNotificationConfigurationResponse
8793
+ */
8462
8794
  deleteNotificationConfigurationWithOptions(request: DeleteNotificationConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteNotificationConfigurationResponse>;
8795
+ /**
8796
+ * @summary Deletes a notification.
8797
+ *
8798
+ * @param request DeleteNotificationConfigurationRequest
8799
+ * @return DeleteNotificationConfigurationResponse
8800
+ */
8463
8801
  deleteNotificationConfiguration(request: DeleteNotificationConfigurationRequest): Promise<DeleteNotificationConfigurationResponse>;
8464
8802
  /**
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
8803
+ * @summary Deletes a scaling configuration that is used to create Elastic Compute Service (ECS) instances.
8804
+ *
8805
+ * @description You cannot delete a scaling configuration in one of the following scenarios:
8806
+ * * The scaling configuration in your scaling group is in the Active state.
8807
+ * * The scaling group contains ECS instances that were created based on the scaling configuration.
8808
+ *
8809
+ * @param request DeleteScalingConfigurationRequest
8810
+ * @param runtime runtime options for this request RuntimeOptions
8811
+ * @return DeleteScalingConfigurationResponse
8472
8812
  */
8473
8813
  deleteScalingConfigurationWithOptions(request: DeleteScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteScalingConfigurationResponse>;
8474
8814
  /**
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
8815
+ * @summary Deletes a scaling configuration that is used to create Elastic Compute Service (ECS) instances.
8816
+ *
8817
+ * @description You cannot delete a scaling configuration in one of the following scenarios:
8818
+ * * The scaling configuration in your scaling group is in the Active state.
8819
+ * * The scaling group contains ECS instances that were created based on the scaling configuration.
8820
+ *
8821
+ * @param request DeleteScalingConfigurationRequest
8822
+ * @return DeleteScalingConfigurationResponse
8481
8823
  */
8482
8824
  deleteScalingConfiguration(request: DeleteScalingConfigurationRequest): Promise<DeleteScalingConfigurationResponse>;
8825
+ /**
8826
+ * @summary Deletes a scaling group.
8827
+ *
8828
+ * @description Before you delete a scaling group, take note of the following items:
8829
+ * * After you delete a scaling group, the scaling configuration, scaling rules, scaling activities, and scaling requests related to the scaling group are also deleted.
8830
+ * * After you delete a scaling group, the scheduled tasks and event-triggered tasks of the scaling group are not deleted. The Classic Load Balancer (CLB) instances and ApsaraDB RDS instances with which the scaling group is associated are also not deleted.
8831
+ *
8832
+ * @param request DeleteScalingGroupRequest
8833
+ * @param runtime runtime options for this request RuntimeOptions
8834
+ * @return DeleteScalingGroupResponse
8835
+ */
8483
8836
  deleteScalingGroupWithOptions(request: DeleteScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteScalingGroupResponse>;
8837
+ /**
8838
+ * @summary Deletes a scaling group.
8839
+ *
8840
+ * @description Before you delete a scaling group, take note of the following items:
8841
+ * * After you delete a scaling group, the scaling configuration, scaling rules, scaling activities, and scaling requests related to the scaling group are also deleted.
8842
+ * * After you delete a scaling group, the scheduled tasks and event-triggered tasks of the scaling group are not deleted. The Classic Load Balancer (CLB) instances and ApsaraDB RDS instances with which the scaling group is associated are also not deleted.
8843
+ *
8844
+ * @param request DeleteScalingGroupRequest
8845
+ * @return DeleteScalingGroupResponse
8846
+ */
8484
8847
  deleteScalingGroup(request: DeleteScalingGroupRequest): Promise<DeleteScalingGroupResponse>;
8848
+ /**
8849
+ * @summary Deletes a scaling rule.
8850
+ *
8851
+ * @param request DeleteScalingRuleRequest
8852
+ * @param runtime runtime options for this request RuntimeOptions
8853
+ * @return DeleteScalingRuleResponse
8854
+ */
8485
8855
  deleteScalingRuleWithOptions(request: DeleteScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<DeleteScalingRuleResponse>;
8856
+ /**
8857
+ * @summary Deletes a scaling rule.
8858
+ *
8859
+ * @param request DeleteScalingRuleRequest
8860
+ * @return DeleteScalingRuleResponse
8861
+ */
8486
8862
  deleteScalingRule(request: DeleteScalingRuleRequest): Promise<DeleteScalingRuleResponse>;
8863
+ /**
8864
+ * @summary Deletes a scheduled task.
8865
+ *
8866
+ * @param request DeleteScheduledTaskRequest
8867
+ * @param runtime runtime options for this request RuntimeOptions
8868
+ * @return DeleteScheduledTaskResponse
8869
+ */
8487
8870
  deleteScheduledTaskWithOptions(request: DeleteScheduledTaskRequest, runtime: $Util.RuntimeOptions): Promise<DeleteScheduledTaskResponse>;
8871
+ /**
8872
+ * @summary Deletes a scheduled task.
8873
+ *
8874
+ * @param request DeleteScheduledTaskRequest
8875
+ * @return DeleteScheduledTaskResponse
8876
+ */
8488
8877
  deleteScheduledTask(request: DeleteScheduledTaskRequest): Promise<DeleteScheduledTaskResponse>;
8878
+ /**
8879
+ * @summary Queries event-triggered tasks.
8880
+ *
8881
+ * @param request DescribeAlarmsRequest
8882
+ * @param runtime runtime options for this request RuntimeOptions
8883
+ * @return DescribeAlarmsResponse
8884
+ */
8489
8885
  describeAlarmsWithOptions(request: DescribeAlarmsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAlarmsResponse>;
8886
+ /**
8887
+ * @summary Queries event-triggered tasks.
8888
+ *
8889
+ * @param request DescribeAlarmsRequest
8890
+ * @return DescribeAlarmsResponse
8891
+ */
8490
8892
  describeAlarms(request: DescribeAlarmsRequest): Promise<DescribeAlarmsResponse>;
8893
+ /**
8894
+ * @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.
8895
+ *
8896
+ * @param request DescribeEciScalingConfigurationDetailRequest
8897
+ * @param runtime runtime options for this request RuntimeOptions
8898
+ * @return DescribeEciScalingConfigurationDetailResponse
8899
+ */
8491
8900
  describeEciScalingConfigurationDetailWithOptions(request: DescribeEciScalingConfigurationDetailRequest, runtime: $Util.RuntimeOptions): Promise<DescribeEciScalingConfigurationDetailResponse>;
8901
+ /**
8902
+ * @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.
8903
+ *
8904
+ * @param request DescribeEciScalingConfigurationDetailRequest
8905
+ * @return DescribeEciScalingConfigurationDetailResponse
8906
+ */
8492
8907
  describeEciScalingConfigurationDetail(request: DescribeEciScalingConfigurationDetailRequest): Promise<DescribeEciScalingConfigurationDetailResponse>;
8908
+ /**
8909
+ * @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.
8910
+ *
8911
+ * @param request DescribeEciScalingConfigurationsRequest
8912
+ * @param runtime runtime options for this request RuntimeOptions
8913
+ * @return DescribeEciScalingConfigurationsResponse
8914
+ */
8493
8915
  describeEciScalingConfigurationsWithOptions(request: DescribeEciScalingConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeEciScalingConfigurationsResponse>;
8916
+ /**
8917
+ * @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.
8918
+ *
8919
+ * @param request DescribeEciScalingConfigurationsRequest
8920
+ * @return DescribeEciScalingConfigurationsResponse
8921
+ */
8494
8922
  describeEciScalingConfigurations(request: DescribeEciScalingConfigurationsRequest): Promise<DescribeEciScalingConfigurationsResponse>;
8495
8923
  /**
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
8924
+ * @summary Queries lifecycle actions.
8925
+ *
8926
+ * @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:
8927
+ * * 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.
8928
+ * * 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.
8929
+ * * If a lifecycle action is in the Completed state, you manually end the lifecycle hook that triggers the lifecycle action ahead of schedule.
8930
+ * 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.
8931
+ *
8932
+ * @param request DescribeLifecycleActionsRequest
8933
+ * @param runtime runtime options for this request RuntimeOptions
8934
+ * @return DescribeLifecycleActionsResponse
8505
8935
  */
8506
8936
  describeLifecycleActionsWithOptions(request: DescribeLifecycleActionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLifecycleActionsResponse>;
8507
8937
  /**
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
8938
+ * @summary Queries lifecycle actions.
8939
+ *
8940
+ * @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:
8941
+ * * 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.
8942
+ * * 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.
8943
+ * * If a lifecycle action is in the Completed state, you manually end the lifecycle hook that triggers the lifecycle action ahead of schedule.
8944
+ * 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.
8945
+ *
8946
+ * @param request DescribeLifecycleActionsRequest
8947
+ * @return DescribeLifecycleActionsResponse
8516
8948
  */
8517
8949
  describeLifecycleActions(request: DescribeLifecycleActionsRequest): Promise<DescribeLifecycleActionsResponse>;
8950
+ /**
8951
+ * @summary Queries lifecycle hooks.
8952
+ *
8953
+ * @description You can use one of the following methods to query lifecycle hooks:
8954
+ * * 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.
8955
+ * * Specify the scaling group ID by using the ScalingGroupId parameter.
8956
+ * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter at the same time.
8957
+ *
8958
+ * @param request DescribeLifecycleHooksRequest
8959
+ * @param runtime runtime options for this request RuntimeOptions
8960
+ * @return DescribeLifecycleHooksResponse
8961
+ */
8518
8962
  describeLifecycleHooksWithOptions(request: DescribeLifecycleHooksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLifecycleHooksResponse>;
8963
+ /**
8964
+ * @summary Queries lifecycle hooks.
8965
+ *
8966
+ * @description You can use one of the following methods to query lifecycle hooks:
8967
+ * * 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.
8968
+ * * Specify the scaling group ID by using the ScalingGroupId parameter.
8969
+ * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter at the same time.
8970
+ *
8971
+ * @param request DescribeLifecycleHooksRequest
8972
+ * @return DescribeLifecycleHooksResponse
8973
+ */
8519
8974
  describeLifecycleHooks(request: DescribeLifecycleHooksRequest): Promise<DescribeLifecycleHooksResponse>;
8975
+ /**
8976
+ * @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.
8977
+ *
8978
+ * @param request DescribeLimitationRequest
8979
+ * @param runtime runtime options for this request RuntimeOptions
8980
+ * @return DescribeLimitationResponse
8981
+ */
8520
8982
  describeLimitationWithOptions(request: DescribeLimitationRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLimitationResponse>;
8983
+ /**
8984
+ * @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.
8985
+ *
8986
+ * @param request DescribeLimitationRequest
8987
+ * @return DescribeLimitationResponse
8988
+ */
8521
8989
  describeLimitation(request: DescribeLimitationRequest): Promise<DescribeLimitationResponse>;
8990
+ /**
8991
+ * @summary Queries event notifications.
8992
+ *
8993
+ * @param request DescribeNotificationConfigurationsRequest
8994
+ * @param runtime runtime options for this request RuntimeOptions
8995
+ * @return DescribeNotificationConfigurationsResponse
8996
+ */
8522
8997
  describeNotificationConfigurationsWithOptions(request: DescribeNotificationConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeNotificationConfigurationsResponse>;
8998
+ /**
8999
+ * @summary Queries event notifications.
9000
+ *
9001
+ * @param request DescribeNotificationConfigurationsRequest
9002
+ * @return DescribeNotificationConfigurationsResponse
9003
+ */
8523
9004
  describeNotificationConfigurations(request: DescribeNotificationConfigurationsRequest): Promise<DescribeNotificationConfigurationsResponse>;
9005
+ /**
9006
+ * @summary Queries notification types.
9007
+ *
9008
+ * @param request DescribeNotificationTypesRequest
9009
+ * @param runtime runtime options for this request RuntimeOptions
9010
+ * @return DescribeNotificationTypesResponse
9011
+ */
8524
9012
  describeNotificationTypesWithOptions(request: DescribeNotificationTypesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeNotificationTypesResponse>;
9013
+ /**
9014
+ * @summary Queries notification types.
9015
+ *
9016
+ * @param request DescribeNotificationTypesRequest
9017
+ * @return DescribeNotificationTypesResponse
9018
+ */
8525
9019
  describeNotificationTypes(request: DescribeNotificationTypesRequest): Promise<DescribeNotificationTypesResponse>;
9020
+ /**
9021
+ * @summary DescribePatternTypes
9022
+ *
9023
+ * @param request DescribePatternTypesRequest
9024
+ * @param runtime runtime options for this request RuntimeOptions
9025
+ * @return DescribePatternTypesResponse
9026
+ */
9027
+ describePatternTypesWithOptions(request: DescribePatternTypesRequest, runtime: $Util.RuntimeOptions): Promise<DescribePatternTypesResponse>;
9028
+ /**
9029
+ * @summary DescribePatternTypes
9030
+ *
9031
+ * @param request DescribePatternTypesRequest
9032
+ * @return DescribePatternTypesResponse
9033
+ */
9034
+ describePatternTypes(request: DescribePatternTypesRequest): Promise<DescribePatternTypesResponse>;
9035
+ /**
9036
+ * @summary Queries the regions in which Auto Scaling is available.
9037
+ *
9038
+ * @param request DescribeRegionsRequest
9039
+ * @param runtime runtime options for this request RuntimeOptions
9040
+ * @return DescribeRegionsResponse
9041
+ */
8526
9042
  describeRegionsWithOptions(request: DescribeRegionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRegionsResponse>;
9043
+ /**
9044
+ * @summary Queries the regions in which Auto Scaling is available.
9045
+ *
9046
+ * @param request DescribeRegionsRequest
9047
+ * @return DescribeRegionsResponse
9048
+ */
8527
9049
  describeRegions(request: DescribeRegionsRequest): Promise<DescribeRegionsResponse>;
8528
9050
  /**
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
9051
+ * @summary Queries scaling activities.
9052
+ *
9053
+ * @description You can specify a scaling group ID to query all scaling activities in the scaling group.
9054
+ * You can filter query results based on the status of scaling activities.
9055
+ * You can query scaling activities that are executed in the previous 30 days.
9056
+ *
9057
+ * @param request DescribeScalingActivitiesRequest
9058
+ * @param runtime runtime options for this request RuntimeOptions
9059
+ * @return DescribeScalingActivitiesResponse
8536
9060
  */
8537
9061
  describeScalingActivitiesWithOptions(request: DescribeScalingActivitiesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingActivitiesResponse>;
8538
9062
  /**
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
9063
+ * @summary Queries scaling activities.
9064
+ *
9065
+ * @description You can specify a scaling group ID to query all scaling activities in the scaling group.
9066
+ * You can filter query results based on the status of scaling activities.
9067
+ * You can query scaling activities that are executed in the previous 30 days.
9068
+ *
9069
+ * @param request DescribeScalingActivitiesRequest
9070
+ * @return DescribeScalingActivitiesResponse
8545
9071
  */
8546
9072
  describeScalingActivities(request: DescribeScalingActivitiesRequest): Promise<DescribeScalingActivitiesResponse>;
9073
+ /**
9074
+ * @summary Queries the details about a scaling activity.
9075
+ *
9076
+ * @param request DescribeScalingActivityDetailRequest
9077
+ * @param runtime runtime options for this request RuntimeOptions
9078
+ * @return DescribeScalingActivityDetailResponse
9079
+ */
8547
9080
  describeScalingActivityDetailWithOptions(request: DescribeScalingActivityDetailRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingActivityDetailResponse>;
9081
+ /**
9082
+ * @summary Queries the details about a scaling activity.
9083
+ *
9084
+ * @param request DescribeScalingActivityDetailRequest
9085
+ * @return DescribeScalingActivityDetailResponse
9086
+ */
8548
9087
  describeScalingActivityDetail(request: DescribeScalingActivityDetailRequest): Promise<DescribeScalingActivityDetailResponse>;
9088
+ /**
9089
+ * @summary Queries scaling configurations.
9090
+ *
9091
+ * @param request DescribeScalingConfigurationsRequest
9092
+ * @param runtime runtime options for this request RuntimeOptions
9093
+ * @return DescribeScalingConfigurationsResponse
9094
+ */
8549
9095
  describeScalingConfigurationsWithOptions(request: DescribeScalingConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingConfigurationsResponse>;
9096
+ /**
9097
+ * @summary Queries scaling configurations.
9098
+ *
9099
+ * @param request DescribeScalingConfigurationsRequest
9100
+ * @return DescribeScalingConfigurationsResponse
9101
+ */
8550
9102
  describeScalingConfigurations(request: DescribeScalingConfigurationsRequest): Promise<DescribeScalingConfigurationsResponse>;
9103
+ /**
9104
+ * @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.
9105
+ *
9106
+ * @param request DescribeScalingGroupDetailRequest
9107
+ * @param runtime runtime options for this request RuntimeOptions
9108
+ * @return DescribeScalingGroupDetailResponse
9109
+ */
8551
9110
  describeScalingGroupDetailWithOptions(request: DescribeScalingGroupDetailRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingGroupDetailResponse>;
9111
+ /**
9112
+ * @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.
9113
+ *
9114
+ * @param request DescribeScalingGroupDetailRequest
9115
+ * @return DescribeScalingGroupDetailResponse
9116
+ */
8552
9117
  describeScalingGroupDetail(request: DescribeScalingGroupDetailRequest): Promise<DescribeScalingGroupDetailResponse>;
9118
+ /**
9119
+ * @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.
9120
+ *
9121
+ * @param request DescribeScalingGroupsRequest
9122
+ * @param runtime runtime options for this request RuntimeOptions
9123
+ * @return DescribeScalingGroupsResponse
9124
+ */
8553
9125
  describeScalingGroupsWithOptions(request: DescribeScalingGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingGroupsResponse>;
9126
+ /**
9127
+ * @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.
9128
+ *
9129
+ * @param request DescribeScalingGroupsRequest
9130
+ * @return DescribeScalingGroupsResponse
9131
+ */
8554
9132
  describeScalingGroups(request: DescribeScalingGroupsRequest): Promise<DescribeScalingGroupsResponse>;
9133
+ /**
9134
+ * @summary Queries the Elastic Compute Service (ECS) instances in a scaling group
9135
+ *
9136
+ * @param request DescribeScalingInstancesRequest
9137
+ * @param runtime runtime options for this request RuntimeOptions
9138
+ * @return DescribeScalingInstancesResponse
9139
+ */
8555
9140
  describeScalingInstancesWithOptions(request: DescribeScalingInstancesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingInstancesResponse>;
9141
+ /**
9142
+ * @summary Queries the Elastic Compute Service (ECS) instances in a scaling group
9143
+ *
9144
+ * @param request DescribeScalingInstancesRequest
9145
+ * @return DescribeScalingInstancesResponse
9146
+ */
8556
9147
  describeScalingInstances(request: DescribeScalingInstancesRequest): Promise<DescribeScalingInstancesResponse>;
8557
9148
  /**
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
9149
+ * @summary Queries all scaling rules in a scaling group.
9150
+ *
9151
+ * @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.
9152
+ *
9153
+ * @param request DescribeScalingRulesRequest
9154
+ * @param runtime runtime options for this request RuntimeOptions
9155
+ * @return DescribeScalingRulesResponse
8563
9156
  */
8564
9157
  describeScalingRulesWithOptions(request: DescribeScalingRulesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingRulesResponse>;
8565
9158
  /**
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
9159
+ * @summary Queries all scaling rules in a scaling group.
9160
+ *
9161
+ * @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.
9162
+ *
9163
+ * @param request DescribeScalingRulesRequest
9164
+ * @return DescribeScalingRulesResponse
8570
9165
  */
8571
9166
  describeScalingRules(request: DescribeScalingRulesRequest): Promise<DescribeScalingRulesResponse>;
9167
+ /**
9168
+ * @summary Queries scheduled tasks.
9169
+ *
9170
+ * @description You can query scheduled tasks by scaling rule, task ID, or task name.
9171
+ *
9172
+ * @param request DescribeScheduledTasksRequest
9173
+ * @param runtime runtime options for this request RuntimeOptions
9174
+ * @return DescribeScheduledTasksResponse
9175
+ */
8572
9176
  describeScheduledTasksWithOptions(request: DescribeScheduledTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScheduledTasksResponse>;
9177
+ /**
9178
+ * @summary Queries scheduled tasks.
9179
+ *
9180
+ * @description You can query scheduled tasks by scaling rule, task ID, or task name.
9181
+ *
9182
+ * @param request DescribeScheduledTasksRequest
9183
+ * @return DescribeScheduledTasksResponse
9184
+ */
8573
9185
  describeScheduledTasks(request: DescribeScheduledTasksRequest): Promise<DescribeScheduledTasksResponse>;
9186
+ /**
9187
+ * @summary Disassociates one or more Application Load Balancer (ALB) server groups from a scaling group.
9188
+ *
9189
+ * @param request DetachAlbServerGroupsRequest
9190
+ * @param runtime runtime options for this request RuntimeOptions
9191
+ * @return DetachAlbServerGroupsResponse
9192
+ */
8574
9193
  detachAlbServerGroupsWithOptions(request: DetachAlbServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DetachAlbServerGroupsResponse>;
9194
+ /**
9195
+ * @summary Disassociates one or more Application Load Balancer (ALB) server groups from a scaling group.
9196
+ *
9197
+ * @param request DetachAlbServerGroupsRequest
9198
+ * @return DetachAlbServerGroupsResponse
9199
+ */
8575
9200
  detachAlbServerGroups(request: DetachAlbServerGroupsRequest): Promise<DetachAlbServerGroupsResponse>;
9201
+ /**
9202
+ * @summary Disassociates one or more ApsaraDB RDS instances from a scaling group.
9203
+ *
9204
+ * @param request DetachDBInstancesRequest
9205
+ * @param runtime runtime options for this request RuntimeOptions
9206
+ * @return DetachDBInstancesResponse
9207
+ */
8576
9208
  detachDBInstancesWithOptions(request: DetachDBInstancesRequest, runtime: $Util.RuntimeOptions): Promise<DetachDBInstancesResponse>;
9209
+ /**
9210
+ * @summary Disassociates one or more ApsaraDB RDS instances from a scaling group.
9211
+ *
9212
+ * @param request DetachDBInstancesRequest
9213
+ * @return DetachDBInstancesResponse
9214
+ */
8577
9215
  detachDBInstances(request: DetachDBInstancesRequest): Promise<DetachDBInstancesResponse>;
8578
9216
  /**
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
9217
+ * @summary Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
9218
+ *
9219
+ * @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.
9220
+ * After you remove an ECS instance or elastic container instance by calling the DetachInstances operation, the instance is not stopped or released.
9221
+ * Before you call this operation, make sure that the following conditions are met:
9222
+ * * The specified scaling group is enabled.
9223
+ * * No scaling activities in the specified scaling group are in progress.
9224
+ * > If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9225
+ * 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.
9226
+ * 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.
9227
+ *
9228
+ * @param request DetachInstancesRequest
9229
+ * @param runtime runtime options for this request RuntimeOptions
9230
+ * @return DetachInstancesResponse
8591
9231
  */
8592
9232
  detachInstancesWithOptions(request: DetachInstancesRequest, runtime: $Util.RuntimeOptions): Promise<DetachInstancesResponse>;
8593
9233
  /**
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
9234
+ * @summary Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
9235
+ *
9236
+ * @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.
9237
+ * After you remove an ECS instance or elastic container instance by calling the DetachInstances operation, the instance is not stopped or released.
9238
+ * Before you call this operation, make sure that the following conditions are met:
9239
+ * * The specified scaling group is enabled.
9240
+ * * No scaling activities in the specified scaling group are in progress.
9241
+ * > If no scaling activities in the specified scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9242
+ * 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.
9243
+ * 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.
9244
+ *
9245
+ * @param request DetachInstancesRequest
9246
+ * @return DetachInstancesResponse
8605
9247
  */
8606
9248
  detachInstances(request: DetachInstancesRequest): Promise<DetachInstancesResponse>;
9249
+ /**
9250
+ * @summary Detaches one or more Classic Load Balancer (CLB) instances from a scaling group.
9251
+ *
9252
+ * @param request DetachLoadBalancersRequest
9253
+ * @param runtime runtime options for this request RuntimeOptions
9254
+ * @return DetachLoadBalancersResponse
9255
+ */
8607
9256
  detachLoadBalancersWithOptions(request: DetachLoadBalancersRequest, runtime: $Util.RuntimeOptions): Promise<DetachLoadBalancersResponse>;
9257
+ /**
9258
+ * @summary Detaches one or more Classic Load Balancer (CLB) instances from a scaling group.
9259
+ *
9260
+ * @param request DetachLoadBalancersRequest
9261
+ * @return DetachLoadBalancersResponse
9262
+ */
8608
9263
  detachLoadBalancers(request: DetachLoadBalancersRequest): Promise<DetachLoadBalancersResponse>;
9264
+ /**
9265
+ * @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.
9266
+ *
9267
+ * @param request DetachServerGroupsRequest
9268
+ * @param runtime runtime options for this request RuntimeOptions
9269
+ * @return DetachServerGroupsResponse
9270
+ */
8609
9271
  detachServerGroupsWithOptions(request: DetachServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DetachServerGroupsResponse>;
9272
+ /**
9273
+ * @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.
9274
+ *
9275
+ * @param request DetachServerGroupsRequest
9276
+ * @return DetachServerGroupsResponse
9277
+ */
8610
9278
  detachServerGroups(request: DetachServerGroupsRequest): Promise<DetachServerGroupsResponse>;
8611
9279
  /**
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
9280
+ * @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.
9281
+ *
9282
+ * @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:
9283
+ * * LoadBalancerId: the ID of the load balancer
9284
+ * * VServerGroupId: the ID of the vServer group
9285
+ * * Port: the port number of the vServer group
9286
+ * * 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.
9287
+ * * 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.
9288
+ *
9289
+ * @param request DetachVServerGroupsRequest
9290
+ * @param runtime runtime options for this request RuntimeOptions
9291
+ * @return DetachVServerGroupsResponse
8621
9292
  */
8622
9293
  detachVServerGroupsWithOptions(request: DetachVServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DetachVServerGroupsResponse>;
8623
9294
  /**
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
9295
+ * @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.
9296
+ *
9297
+ * @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:
9298
+ * * LoadBalancerId: the ID of the load balancer
9299
+ * * VServerGroupId: the ID of the vServer group
9300
+ * * Port: the port number of the vServer group
9301
+ * * 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.
9302
+ * * 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.
9303
+ *
9304
+ * @param request DetachVServerGroupsRequest
9305
+ * @return DetachVServerGroupsResponse
8632
9306
  */
8633
9307
  detachVServerGroups(request: DetachVServerGroupsRequest): Promise<DetachVServerGroupsResponse>;
9308
+ /**
9309
+ * @summary Disables an event-triggered task.
9310
+ *
9311
+ * @param request DisableAlarmRequest
9312
+ * @param runtime runtime options for this request RuntimeOptions
9313
+ * @return DisableAlarmResponse
9314
+ */
8634
9315
  disableAlarmWithOptions(request: DisableAlarmRequest, runtime: $Util.RuntimeOptions): Promise<DisableAlarmResponse>;
9316
+ /**
9317
+ * @summary Disables an event-triggered task.
9318
+ *
9319
+ * @param request DisableAlarmRequest
9320
+ * @return DisableAlarmResponse
9321
+ */
8635
9322
  disableAlarm(request: DisableAlarmRequest): Promise<DisableAlarmResponse>;
9323
+ /**
9324
+ * @summary Disables a scaling group.
9325
+ *
9326
+ * @description Before you call this operation to disable a scaling group, take note of the following items:
9327
+ * * When you call this operation, ongoing scaling activities will continue until they are complete, but new activities will be rejected.
9328
+ * * You can disable only scaling groups that are in the Active state.
9329
+ *
9330
+ * @param request DisableScalingGroupRequest
9331
+ * @param runtime runtime options for this request RuntimeOptions
9332
+ * @return DisableScalingGroupResponse
9333
+ */
8636
9334
  disableScalingGroupWithOptions(request: DisableScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<DisableScalingGroupResponse>;
9335
+ /**
9336
+ * @summary Disables a scaling group.
9337
+ *
9338
+ * @description Before you call this operation to disable a scaling group, take note of the following items:
9339
+ * * When you call this operation, ongoing scaling activities will continue until they are complete, but new activities will be rejected.
9340
+ * * You can disable only scaling groups that are in the Active state.
9341
+ *
9342
+ * @param request DisableScalingGroupRequest
9343
+ * @return DisableScalingGroupResponse
9344
+ */
8637
9345
  disableScalingGroup(request: DisableScalingGroupRequest): Promise<DisableScalingGroupResponse>;
9346
+ /**
9347
+ * @summary Enables an event-triggered task.
9348
+ *
9349
+ * @param request EnableAlarmRequest
9350
+ * @param runtime runtime options for this request RuntimeOptions
9351
+ * @return EnableAlarmResponse
9352
+ */
8638
9353
  enableAlarmWithOptions(request: EnableAlarmRequest, runtime: $Util.RuntimeOptions): Promise<EnableAlarmResponse>;
9354
+ /**
9355
+ * @summary Enables an event-triggered task.
9356
+ *
9357
+ * @param request EnableAlarmRequest
9358
+ * @return EnableAlarmResponse
9359
+ */
8639
9360
  enableAlarm(request: EnableAlarmRequest): Promise<EnableAlarmResponse>;
8640
9361
  /**
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
9362
+ * @summary Enables a scaling group.
9363
+ *
9364
+ * @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.
9365
+ * > 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.
9366
+ * 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.
9367
+ * * 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.
9368
+ * * If the value of the TotalCapactiy parameter is greater than the value of the MaxSize parameter, the call fails.
9369
+ *
9370
+ * @param request EnableScalingGroupRequest
9371
+ * @param runtime runtime options for this request RuntimeOptions
9372
+ * @return EnableScalingGroupResponse
8650
9373
  */
8651
9374
  enableScalingGroupWithOptions(request: EnableScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<EnableScalingGroupResponse>;
8652
9375
  /**
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
9376
+ * @summary Enables a scaling group.
9377
+ *
9378
+ * @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.
9379
+ * > 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.
9380
+ * 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.
9381
+ * * 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.
9382
+ * * If the value of the TotalCapactiy parameter is greater than the value of the MaxSize parameter, the call fails.
9383
+ *
9384
+ * @param request EnableScalingGroupRequest
9385
+ * @return EnableScalingGroupResponse
8661
9386
  */
8662
9387
  enableScalingGroup(request: EnableScalingGroupRequest): Promise<EnableScalingGroupResponse>;
9388
+ /**
9389
+ * @summary Puts an Elastic Compute Service (ECS) instance into the Standby state.
9390
+ *
9391
+ * @description ## Description
9392
+ * * 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.
9393
+ * * You can remove an instance that is in the Standby state from a scaling group, and then release the instance.
9394
+ * * ECS instances that are in the Standby state are not removed from the scaling group during scale-in activities triggered by event-triggered tasks.
9395
+ * * 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.
9396
+ *
9397
+ * @param request EnterStandbyRequest
9398
+ * @param runtime runtime options for this request RuntimeOptions
9399
+ * @return EnterStandbyResponse
9400
+ */
8663
9401
  enterStandbyWithOptions(request: EnterStandbyRequest, runtime: $Util.RuntimeOptions): Promise<EnterStandbyResponse>;
9402
+ /**
9403
+ * @summary Puts an Elastic Compute Service (ECS) instance into the Standby state.
9404
+ *
9405
+ * @description ## Description
9406
+ * * 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.
9407
+ * * You can remove an instance that is in the Standby state from a scaling group, and then release the instance.
9408
+ * * ECS instances that are in the Standby state are not removed from the scaling group during scale-in activities triggered by event-triggered tasks.
9409
+ * * 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.
9410
+ *
9411
+ * @param request EnterStandbyRequest
9412
+ * @return EnterStandbyResponse
9413
+ */
8664
9414
  enterStandby(request: EnterStandbyRequest): Promise<EnterStandbyResponse>;
8665
9415
  /**
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
9416
+ * @summary Executes a scaling rule.
9417
+ *
9418
+ * @description Before you call this operation, take note of the following items:
9419
+ * * The scaling group is in the Active state.
9420
+ * * No scaling activities in the scaling group are in progress.
9421
+ * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9422
+ * 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.
9423
+ * 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.
9424
+ * 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.
9425
+ * 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.
9426
+ *
9427
+ * @param request ExecuteScalingRuleRequest
9428
+ * @param runtime runtime options for this request RuntimeOptions
9429
+ * @return ExecuteScalingRuleResponse
8678
9430
  */
8679
9431
  executeScalingRuleWithOptions(request: ExecuteScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<ExecuteScalingRuleResponse>;
8680
9432
  /**
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
9433
+ * @summary Executes a scaling rule.
9434
+ *
9435
+ * @description Before you call this operation, take note of the following items:
9436
+ * * The scaling group is in the Active state.
9437
+ * * No scaling activities in the scaling group are in progress.
9438
+ * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9439
+ * 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.
9440
+ * 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.
9441
+ * 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.
9442
+ * 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.
9443
+ *
9444
+ * @param request ExecuteScalingRuleRequest
9445
+ * @return ExecuteScalingRuleResponse
8692
9446
  */
8693
9447
  executeScalingRule(request: ExecuteScalingRuleRequest): Promise<ExecuteScalingRuleResponse>;
9448
+ /**
9449
+ * @summary Moves an Elastic Compute Service (ECS) instance out of the Standby state.
9450
+ *
9451
+ * @description ## Description
9452
+ * 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.
9453
+ *
9454
+ * @param request ExitStandbyRequest
9455
+ * @param runtime runtime options for this request RuntimeOptions
9456
+ * @return ExitStandbyResponse
9457
+ */
8694
9458
  exitStandbyWithOptions(request: ExitStandbyRequest, runtime: $Util.RuntimeOptions): Promise<ExitStandbyResponse>;
9459
+ /**
9460
+ * @summary Moves an Elastic Compute Service (ECS) instance out of the Standby state.
9461
+ *
9462
+ * @description ## Description
9463
+ * 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.
9464
+ *
9465
+ * @param request ExitStandbyRequest
9466
+ * @return ExitStandbyResponse
9467
+ */
8695
9468
  exitStandby(request: ExitStandbyRequest): Promise<ExitStandbyResponse>;
9469
+ /**
9470
+ * @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.
9471
+ *
9472
+ * @param request ListTagKeysRequest
9473
+ * @param runtime runtime options for this request RuntimeOptions
9474
+ * @return ListTagKeysResponse
9475
+ */
8696
9476
  listTagKeysWithOptions(request: ListTagKeysRequest, runtime: $Util.RuntimeOptions): Promise<ListTagKeysResponse>;
9477
+ /**
9478
+ * @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.
9479
+ *
9480
+ * @param request ListTagKeysRequest
9481
+ * @return ListTagKeysResponse
9482
+ */
8697
9483
  listTagKeys(request: ListTagKeysRequest): Promise<ListTagKeysResponse>;
9484
+ /**
9485
+ * @summary Queries tags that are added to one or more Auto Scaling resources.
9486
+ *
9487
+ * @param request ListTagResourcesRequest
9488
+ * @param runtime runtime options for this request RuntimeOptions
9489
+ * @return ListTagResourcesResponse
9490
+ */
8698
9491
  listTagResourcesWithOptions(request: ListTagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<ListTagResourcesResponse>;
9492
+ /**
9493
+ * @summary Queries tags that are added to one or more Auto Scaling resources.
9494
+ *
9495
+ * @param request ListTagResourcesRequest
9496
+ * @return ListTagResourcesResponse
9497
+ */
8699
9498
  listTagResources(request: ListTagResourcesRequest): Promise<ListTagResourcesResponse>;
9499
+ /**
9500
+ * @summary Queries tag values.
9501
+ *
9502
+ * @param request ListTagValuesRequest
9503
+ * @param runtime runtime options for this request RuntimeOptions
9504
+ * @return ListTagValuesResponse
9505
+ */
8700
9506
  listTagValuesWithOptions(request: ListTagValuesRequest, runtime: $Util.RuntimeOptions): Promise<ListTagValuesResponse>;
9507
+ /**
9508
+ * @summary Queries tag values.
9509
+ *
9510
+ * @param request ListTagValuesRequest
9511
+ * @return ListTagValuesResponse
9512
+ */
8701
9513
  listTagValues(request: ListTagValuesRequest): Promise<ListTagValuesResponse>;
8702
9514
  /**
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
9515
+ * @summary Modifies an event-triggered task.
9516
+ *
9517
+ * @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).
9518
+ * * 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.
9519
+ * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
9520
+ * * 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).
9521
+ * > 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.
9522
+ *
9523
+ * @param request ModifyAlarmRequest
9524
+ * @param runtime runtime options for this request RuntimeOptions
9525
+ * @return ModifyAlarmResponse
8712
9526
  */
8713
9527
  modifyAlarmWithOptions(request: ModifyAlarmRequest, runtime: $Util.RuntimeOptions): Promise<ModifyAlarmResponse>;
8714
9528
  /**
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
9529
+ * @summary Modifies an event-triggered task.
9530
+ *
9531
+ * @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).
9532
+ * * 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.
9533
+ * * If you set the MetricType parameter to custom, the valid values are your custom metrics.
9534
+ * * 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).
9535
+ * > 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.
9536
+ *
9537
+ * @param request ModifyAlarmRequest
9538
+ * @return ModifyAlarmResponse
8723
9539
  */
8724
9540
  modifyAlarm(request: ModifyAlarmRequest): Promise<ModifyAlarmResponse>;
8725
9541
  /**
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
9542
+ * @summary Modifies a scaling configuration for a scaling group that contains elastic container instances.
9543
+ *
9544
+ * @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.
9545
+ *
9546
+ * @param request ModifyEciScalingConfigurationRequest
9547
+ * @param runtime runtime options for this request RuntimeOptions
9548
+ * @return ModifyEciScalingConfigurationResponse
8731
9549
  */
8732
9550
  modifyEciScalingConfigurationWithOptions(request: ModifyEciScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyEciScalingConfigurationResponse>;
8733
9551
  /**
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
9552
+ * @summary Modifies a scaling configuration for a scaling group that contains elastic container instances.
9553
+ *
9554
+ * @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.
9555
+ *
9556
+ * @param request ModifyEciScalingConfigurationRequest
9557
+ * @return ModifyEciScalingConfigurationResponse
8738
9558
  */
8739
9559
  modifyEciScalingConfiguration(request: ModifyEciScalingConfigurationRequest): Promise<ModifyEciScalingConfigurationResponse>;
9560
+ /**
9561
+ * @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.
9562
+ *
9563
+ * @param request ModifyInstanceAttributeRequest
9564
+ * @param runtime runtime options for this request RuntimeOptions
9565
+ * @return ModifyInstanceAttributeResponse
9566
+ */
8740
9567
  modifyInstanceAttributeWithOptions(request: ModifyInstanceAttributeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyInstanceAttributeResponse>;
9568
+ /**
9569
+ * @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.
9570
+ *
9571
+ * @param request ModifyInstanceAttributeRequest
9572
+ * @return ModifyInstanceAttributeResponse
9573
+ */
8741
9574
  modifyInstanceAttribute(request: ModifyInstanceAttributeRequest): Promise<ModifyInstanceAttributeResponse>;
8742
9575
  /**
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
9576
+ * @summary Modifies a lifecycle hook.
9577
+ *
9578
+ * @description You can use one of the following methods to specify the lifecycle hook that you want to modify:
9579
+ * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. When you use this method, the ScalingGroupId and LifecycleHookName parameters are ignored.
9580
+ * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter.
9581
+ *
9582
+ * @param request ModifyLifecycleHookRequest
9583
+ * @param runtime runtime options for this request RuntimeOptions
9584
+ * @return ModifyLifecycleHookResponse
8750
9585
  */
8751
9586
  modifyLifecycleHookWithOptions(request: ModifyLifecycleHookRequest, runtime: $Util.RuntimeOptions): Promise<ModifyLifecycleHookResponse>;
8752
9587
  /**
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
9588
+ * @summary Modifies a lifecycle hook.
9589
+ *
9590
+ * @description You can use one of the following methods to specify the lifecycle hook that you want to modify:
9591
+ * * Specify the lifecycle hook ID by using the LifecycleHookId parameter. When you use this method, the ScalingGroupId and LifecycleHookName parameters are ignored.
9592
+ * * Specify the scaling group ID by using the ScalingGroupId parameter and the lifecycle hook name by using the LifecycleHookName parameter.
9593
+ *
9594
+ * @param request ModifyLifecycleHookRequest
9595
+ * @return ModifyLifecycleHookResponse
8759
9596
  */
8760
9597
  modifyLifecycleHook(request: ModifyLifecycleHookRequest): Promise<ModifyLifecycleHookResponse>;
9598
+ /**
9599
+ * @summary Modifies a notification.
9600
+ *
9601
+ * @param request ModifyNotificationConfigurationRequest
9602
+ * @param runtime runtime options for this request RuntimeOptions
9603
+ * @return ModifyNotificationConfigurationResponse
9604
+ */
8761
9605
  modifyNotificationConfigurationWithOptions(request: ModifyNotificationConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyNotificationConfigurationResponse>;
9606
+ /**
9607
+ * @summary Modifies a notification.
9608
+ *
9609
+ * @param request ModifyNotificationConfigurationRequest
9610
+ * @return ModifyNotificationConfigurationResponse
9611
+ */
8762
9612
  modifyNotificationConfiguration(request: ModifyNotificationConfigurationRequest): Promise<ModifyNotificationConfigurationResponse>;
8763
9613
  /**
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
9614
+ * @summary Modifies a scaling configuration.
9615
+ *
9616
+ * @description You can change the name of a scaling configuration in a scaling group. The name must be unique within the scaling group.
9617
+ *
9618
+ * @param tmpReq ModifyScalingConfigurationRequest
9619
+ * @param runtime runtime options for this request RuntimeOptions
9620
+ * @return ModifyScalingConfigurationResponse
8769
9621
  */
8770
9622
  modifyScalingConfigurationWithOptions(tmpReq: ModifyScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScalingConfigurationResponse>;
8771
9623
  /**
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
9624
+ * @summary Modifies a scaling configuration.
9625
+ *
9626
+ * @description You can change the name of a scaling configuration in a scaling group. The name must be unique within the scaling group.
9627
+ *
9628
+ * @param request ModifyScalingConfigurationRequest
9629
+ * @return ModifyScalingConfigurationResponse
8776
9630
  */
8777
9631
  modifyScalingConfiguration(request: ModifyScalingConfigurationRequest): Promise<ModifyScalingConfigurationResponse>;
8778
9632
  /**
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
9633
+ * @summary Modifies a scaling group.
9634
+ *
9635
+ * @description * You cannot call this operation to modify the settings of the following parameters:
9636
+ * * RegionId
9637
+ * * LoadBalancerId
9638
+ * > If you want to change the CLB instances that are associated with your scaling group, call the AttachLoadBalancers and DetachLoadBalancers operations.
9639
+ * * DBInstanceId
9640
+ * > If you want to change the ApsaraDB RDS instances that are associated with your scaling group, call the AttachDBInstances and DetachDBInstances operations.
9641
+ * * You can modify only scaling groups that are in the Active or Inactive state.
9642
+ * * 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.
9643
+ * * 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.
9644
+ * * 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.
9645
+ * * 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.
9646
+ *
9647
+ * @param request ModifyScalingGroupRequest
9648
+ * @param runtime runtime options for this request RuntimeOptions
9649
+ * @return ModifyScalingGroupResponse
8794
9650
  */
8795
9651
  modifyScalingGroupWithOptions(request: ModifyScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScalingGroupResponse>;
8796
9652
  /**
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
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
+ * @return ModifyScalingGroupResponse
8811
9669
  */
8812
9670
  modifyScalingGroup(request: ModifyScalingGroupRequest): Promise<ModifyScalingGroupResponse>;
9671
+ /**
9672
+ * @summary Modifies a scaling rule.
9673
+ *
9674
+ * @param request ModifyScalingRuleRequest
9675
+ * @param runtime runtime options for this request RuntimeOptions
9676
+ * @return ModifyScalingRuleResponse
9677
+ */
8813
9678
  modifyScalingRuleWithOptions(request: ModifyScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScalingRuleResponse>;
9679
+ /**
9680
+ * @summary Modifies a scaling rule.
9681
+ *
9682
+ * @param request ModifyScalingRuleRequest
9683
+ * @return ModifyScalingRuleResponse
9684
+ */
8814
9685
  modifyScalingRule(request: ModifyScalingRuleRequest): Promise<ModifyScalingRuleResponse>;
8815
9686
  /**
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
9687
+ * @summary Modifies a scheduled task.
9688
+ *
9689
+ * @description You can use the following parameters to specify the scaling method of a scheduled task:
9690
+ * * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
9691
+ * * If you use the `ScalingGroupId` parameter, you must specify the minimum number, maximum number, or expected number of instances in the scheduled task.
9692
+ * > You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.
9693
+ *
9694
+ * @param request ModifyScheduledTaskRequest
9695
+ * @param runtime runtime options for this request RuntimeOptions
9696
+ * @return ModifyScheduledTaskResponse
8824
9697
  */
8825
9698
  modifyScheduledTaskWithOptions(request: ModifyScheduledTaskRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScheduledTaskResponse>;
8826
9699
  /**
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
9700
+ * @summary Modifies a scheduled task.
9701
+ *
9702
+ * @description You can use the following parameters to specify the scaling method of a scheduled task:
9703
+ * * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
9704
+ * * If you use the `ScalingGroupId` parameter, you must specify the minimum number, maximum number, or expected number of instances in the scheduled task.
9705
+ * > You cannot specify the `ScheduledAction` and `ScalingGroupId` parameters at the same time.
9706
+ *
9707
+ * @param request ModifyScheduledTaskRequest
9708
+ * @return ModifyScheduledTaskResponse
8834
9709
  */
8835
9710
  modifyScheduledTask(request: ModifyScheduledTaskRequest): Promise<ModifyScheduledTaskResponse>;
9711
+ /**
9712
+ * @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.
9713
+ *
9714
+ * @description ## [](#)Usage notes
9715
+ * 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.
9716
+ * * This operation is supported by only multi-zone scaling groups whose `MultiAZPolicy` is set to `BALANCE`.
9717
+ * * 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.
9718
+ * * 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.
9719
+ * **
9720
+ * **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).
9721
+ *
9722
+ * @param request RebalanceInstancesRequest
9723
+ * @param runtime runtime options for this request RuntimeOptions
9724
+ * @return RebalanceInstancesResponse
9725
+ */
8836
9726
  rebalanceInstancesWithOptions(request: RebalanceInstancesRequest, runtime: $Util.RuntimeOptions): Promise<RebalanceInstancesResponse>;
9727
+ /**
9728
+ * @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.
9729
+ *
9730
+ * @description ## [](#)Usage notes
9731
+ * 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.
9732
+ * * This operation is supported by only multi-zone scaling groups whose `MultiAZPolicy` is set to `BALANCE`.
9733
+ * * 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.
9734
+ * * 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.
9735
+ * **
9736
+ * **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).
9737
+ *
9738
+ * @param request RebalanceInstancesRequest
9739
+ * @return RebalanceInstancesResponse
9740
+ */
8837
9741
  rebalanceInstances(request: RebalanceInstancesRequest): Promise<RebalanceInstancesResponse>;
8838
9742
  /**
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
9743
+ * @summary Prolongs a lifecycle hook for Elastic Compute Service (ECS) instances.
9744
+ *
9745
+ * @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.
9746
+ *
9747
+ * @param request RecordLifecycleActionHeartbeatRequest
9748
+ * @param runtime runtime options for this request RuntimeOptions
9749
+ * @return RecordLifecycleActionHeartbeatResponse
8844
9750
  */
8845
9751
  recordLifecycleActionHeartbeatWithOptions(request: RecordLifecycleActionHeartbeatRequest, runtime: $Util.RuntimeOptions): Promise<RecordLifecycleActionHeartbeatResponse>;
8846
9752
  /**
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
9753
+ * @summary Prolongs a lifecycle hook for Elastic Compute Service (ECS) instances.
9754
+ *
9755
+ * @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.
9756
+ *
9757
+ * @param request RecordLifecycleActionHeartbeatRequest
9758
+ * @return RecordLifecycleActionHeartbeatResponse
8851
9759
  */
8852
9760
  recordLifecycleActionHeartbeat(request: RecordLifecycleActionHeartbeatRequest): Promise<RecordLifecycleActionHeartbeatResponse>;
8853
9761
  /**
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
9762
+ * @summary Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
9763
+ *
9764
+ * @description * Before you call this operation, make sure that the following requirements are met:
9765
+ * * The scaling group is in the Active state.
9766
+ * * No scaling activity is in progress within the scaling group.
9767
+ * > If no scaling activity is in progress within the scaling group, you can call the operation even within the cooldown period.
9768
+ * * 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.
9769
+ * * 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.
9770
+ * * 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.
9771
+ * 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.
9772
+ *
9773
+ * @param request RemoveInstancesRequest
9774
+ * @param runtime runtime options for this request RuntimeOptions
9775
+ * @return RemoveInstancesResponse
8866
9776
  */
8867
9777
  removeInstancesWithOptions(request: RemoveInstancesRequest, runtime: $Util.RuntimeOptions): Promise<RemoveInstancesResponse>;
8868
9778
  /**
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
9779
+ * @summary Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
9780
+ *
9781
+ * @description * Before you call this operation, make sure that the following requirements are met:
9782
+ * * The scaling group is in the Active state.
9783
+ * * No scaling activity is in progress within the scaling group.
9784
+ * > If no scaling activity is in progress within the scaling group, you can call the operation even within the cooldown period.
9785
+ * * 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.
9786
+ * * 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.
9787
+ * * 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.
9788
+ * 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.
9789
+ *
9790
+ * @param request RemoveInstancesRequest
9791
+ * @return RemoveInstancesResponse
8880
9792
  */
8881
9793
  removeInstances(request: RemoveInstancesRequest): Promise<RemoveInstancesResponse>;
9794
+ /**
9795
+ * @summary Resumes suspended processes in a scaling group.
9796
+ *
9797
+ * @param request ResumeProcessesRequest
9798
+ * @param runtime runtime options for this request RuntimeOptions
9799
+ * @return ResumeProcessesResponse
9800
+ */
8882
9801
  resumeProcessesWithOptions(request: ResumeProcessesRequest, runtime: $Util.RuntimeOptions): Promise<ResumeProcessesResponse>;
9802
+ /**
9803
+ * @summary Resumes suspended processes in a scaling group.
9804
+ *
9805
+ * @param request ResumeProcessesRequest
9806
+ * @return ResumeProcessesResponse
9807
+ */
8883
9808
  resumeProcesses(request: ResumeProcessesRequest): Promise<ResumeProcessesResponse>;
8884
9809
  /**
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
9810
+ * @summary Scales instances in a scaling group based on the specified scaling policy.
9811
+ *
9812
+ * @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:
9813
+ * * The following conditions must be met:
9814
+ * * The scaling group is in the Active state.
9815
+ * * No scaling activities in the scaling group are in progress.
9816
+ * * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9817
+ * * 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.
9818
+ * * 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.
9819
+ * 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.
9820
+ *
9821
+ * @param tmpReq ScaleWithAdjustmentRequest
9822
+ * @param runtime runtime options for this request RuntimeOptions
9823
+ * @return ScaleWithAdjustmentResponse
8897
9824
  */
8898
9825
  scaleWithAdjustmentWithOptions(tmpReq: ScaleWithAdjustmentRequest, runtime: $Util.RuntimeOptions): Promise<ScaleWithAdjustmentResponse>;
8899
9826
  /**
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
9827
+ * @summary Scales instances in a scaling group based on the specified scaling policy.
9828
+ *
9829
+ * @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:
9830
+ * * The following conditions must be met:
9831
+ * * The scaling group is in the Active state.
9832
+ * * No scaling activities in the scaling group are in progress.
9833
+ * * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities even before the cooldown time expires.
9834
+ * * 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.
9835
+ * * 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.
9836
+ * 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.
9837
+ *
9838
+ * @param request ScaleWithAdjustmentRequest
9839
+ * @return ScaleWithAdjustmentResponse
8911
9840
  */
8912
9841
  scaleWithAdjustment(request: ScaleWithAdjustmentRequest): Promise<ScaleWithAdjustmentResponse>;
9842
+ /**
9843
+ * @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.
9844
+ *
9845
+ * @param request SetGroupDeletionProtectionRequest
9846
+ * @param runtime runtime options for this request RuntimeOptions
9847
+ * @return SetGroupDeletionProtectionResponse
9848
+ */
8913
9849
  setGroupDeletionProtectionWithOptions(request: SetGroupDeletionProtectionRequest, runtime: $Util.RuntimeOptions): Promise<SetGroupDeletionProtectionResponse>;
9850
+ /**
9851
+ * @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.
9852
+ *
9853
+ * @param request SetGroupDeletionProtectionRequest
9854
+ * @return SetGroupDeletionProtectionResponse
9855
+ */
8914
9856
  setGroupDeletionProtection(request: SetGroupDeletionProtectionRequest): Promise<SetGroupDeletionProtectionResponse>;
8915
9857
  /**
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
9858
+ * @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.
9859
+ *
9860
+ * @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~~).
9861
+ *
9862
+ * @param request SetInstanceHealthRequest
9863
+ * @param runtime runtime options for this request RuntimeOptions
9864
+ * @return SetInstanceHealthResponse
8921
9865
  */
8922
9866
  setInstanceHealthWithOptions(request: SetInstanceHealthRequest, runtime: $Util.RuntimeOptions): Promise<SetInstanceHealthResponse>;
8923
9867
  /**
8924
- * Configures the health check feature for Elastic Compute Service (ECS) instances.
8925
- *
8926
- * @param request SetInstanceHealthRequest
8927
- * @return SetInstanceHealthResponse
9868
+ * @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.
9869
+ *
9870
+ * @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~~).
9871
+ *
9872
+ * @param request SetInstanceHealthRequest
9873
+ * @return SetInstanceHealthResponse
8928
9874
  */
8929
9875
  setInstanceHealth(request: SetInstanceHealthRequest): Promise<SetInstanceHealthResponse>;
8930
9876
  /**
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
9877
+ * @summary Puts one or more Elastic Compute Service (ECS) instances into the Protected state.
9878
+ *
9879
+ * @description ## Description
9880
+ * Before you call this operation, take note of the following items:
9881
+ * * After you put an ECS instance into the Protected state, the ECS instance remains in the Protected state until you manually move the ECS instance out of the Protected state.
9882
+ * * After you put an ECS instance into the Protected state, Auto Scaling does not remove the ECS instance even if a scale-in activity caused by changes in instance quantity or event-triggered tasks occurs. In this case, you must manually move the ECS instance out of the Protected state and then release the ECS instance. For more information, see the "RemoveInstances" topic.
9883
+ * * After you put an ECS instance into the Protected state, Auto Scaling does not update the health status of the instance when the instance is stopped or restarted.
9884
+ *
9885
+ * @param request SetInstancesProtectionRequest
9886
+ * @param runtime runtime options for this request RuntimeOptions
9887
+ * @return SetInstancesProtectionResponse
8936
9888
  */
8937
9889
  setInstancesProtectionWithOptions(request: SetInstancesProtectionRequest, runtime: $Util.RuntimeOptions): Promise<SetInstancesProtectionResponse>;
8938
9890
  /**
8939
- * Puts one or more Elastic Compute Service (ECS) instances into the Protected state.
8940
- *
8941
- * @param request SetInstancesProtectionRequest
8942
- * @return SetInstancesProtectionResponse
9891
+ * @summary Puts one or more Elastic Compute Service (ECS) instances into the Protected state.
9892
+ *
9893
+ * @description ## Description
9894
+ * Before you call this operation, take note of the following items:
9895
+ * * After you put an ECS instance into the Protected state, the ECS instance remains in the Protected state until you manually move the ECS instance out of the Protected state.
9896
+ * * After you put an ECS instance into the Protected state, Auto Scaling does not remove the ECS instance even if a scale-in activity caused by changes in instance quantity or event-triggered tasks occurs. In this case, you must manually move the ECS instance out of the Protected state and then release the ECS instance. For more information, see the "RemoveInstances" topic.
9897
+ * * After you put an ECS instance into the Protected state, Auto Scaling does not update the health status of the instance when the instance is stopped or restarted.
9898
+ *
9899
+ * @param request SetInstancesProtectionRequest
9900
+ * @return SetInstancesProtectionResponse
8943
9901
  */
8944
9902
  setInstancesProtection(request: SetInstancesProtectionRequest): Promise<SetInstancesProtectionResponse>;
9903
+ /**
9904
+ * @summary Suspends processes in a scaling group.
9905
+ *
9906
+ * @param request SuspendProcessesRequest
9907
+ * @param runtime runtime options for this request RuntimeOptions
9908
+ * @return SuspendProcessesResponse
9909
+ */
8945
9910
  suspendProcessesWithOptions(request: SuspendProcessesRequest, runtime: $Util.RuntimeOptions): Promise<SuspendProcessesResponse>;
9911
+ /**
9912
+ * @summary Suspends processes in a scaling group.
9913
+ *
9914
+ * @param request SuspendProcessesRequest
9915
+ * @return SuspendProcessesResponse
9916
+ */
8946
9917
  suspendProcesses(request: SuspendProcessesRequest): Promise<SuspendProcessesResponse>;
9918
+ /**
9919
+ * @summary Adds tags to specified Auto Scaling resources.
9920
+ *
9921
+ * @param request TagResourcesRequest
9922
+ * @param runtime runtime options for this request RuntimeOptions
9923
+ * @return TagResourcesResponse
9924
+ */
8947
9925
  tagResourcesWithOptions(request: TagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<TagResourcesResponse>;
9926
+ /**
9927
+ * @summary Adds tags to specified Auto Scaling resources.
9928
+ *
9929
+ * @param request TagResourcesRequest
9930
+ * @return TagResourcesResponse
9931
+ */
8948
9932
  tagResources(request: TagResourcesRequest): Promise<TagResourcesResponse>;
9933
+ /**
9934
+ * @summary Removes tags from the specified Auto Scaling resources. If you remove a tag and the tag is not added to other resources, the tag is automatically deleted.
9935
+ *
9936
+ * @param request UntagResourcesRequest
9937
+ * @param runtime runtime options for this request RuntimeOptions
9938
+ * @return UntagResourcesResponse
9939
+ */
8949
9940
  untagResourcesWithOptions(request: UntagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<UntagResourcesResponse>;
9941
+ /**
9942
+ * @summary Removes tags from the specified Auto Scaling resources. If you remove a tag and the tag is not added to other resources, the tag is automatically deleted.
9943
+ *
9944
+ * @param request UntagResourcesRequest
9945
+ * @return UntagResourcesResponse
9946
+ */
8950
9947
  untagResources(request: UntagResourcesRequest): Promise<UntagResourcesResponse>;
9948
+ /**
9949
+ * @summary Checks whether Auto Scaling is authorized to access Elastic Compute Service (ECS) and Elastic Container Instance resources.
9950
+ *
9951
+ * @param request VerifyAuthenticationRequest
9952
+ * @param runtime runtime options for this request RuntimeOptions
9953
+ * @return VerifyAuthenticationResponse
9954
+ */
8951
9955
  verifyAuthenticationWithOptions(request: VerifyAuthenticationRequest, runtime: $Util.RuntimeOptions): Promise<VerifyAuthenticationResponse>;
9956
+ /**
9957
+ * @summary Checks whether Auto Scaling is authorized to access Elastic Compute Service (ECS) and Elastic Container Instance resources.
9958
+ *
9959
+ * @param request VerifyAuthenticationRequest
9960
+ * @return VerifyAuthenticationResponse
9961
+ */
8952
9962
  verifyAuthentication(request: VerifyAuthenticationRequest): Promise<VerifyAuthenticationResponse>;
9963
+ /**
9964
+ * @summary Checks whether Auto Scaling is activated.
9965
+ *
9966
+ * @param request VerifyUserRequest
9967
+ * @param runtime runtime options for this request RuntimeOptions
9968
+ * @return VerifyUserResponse
9969
+ */
8953
9970
  verifyUserWithOptions(request: VerifyUserRequest, runtime: $Util.RuntimeOptions): Promise<VerifyUserResponse>;
9971
+ /**
9972
+ * @summary Checks whether Auto Scaling is activated.
9973
+ *
9974
+ * @param request VerifyUserRequest
9975
+ * @return VerifyUserResponse
9976
+ */
8954
9977
  verifyUser(request: VerifyUserRequest): Promise<VerifyUserResponse>;
8955
9978
  }