@alicloud/ess20220222 1.8.12 → 1.8.14

package/dist/client.d.ts

@@ -2211,6 +2211,10 @@ export declare class CreateScalingConfigurationRequestNetworkInterfaces extends
 }
 export declare class CreateScalingConfigurationRequestResourcePoolOptions extends $dara.Model {
     privatePoolIds?: string[];
+    /**
+     * @example
+     * PrivatePoolFirst
+     */
     strategy?: string;
     static names(): {
         [key: string]: string;
@@ -2999,6 +3003,10 @@ export declare class CreateScalingConfigurationShrinkRequestNetworkInterfaces ex
 }
 export declare class CreateScalingConfigurationShrinkRequestResourcePoolOptions extends $dara.Model {
     privatePoolIds?: string[];
+    /**
+     * @example
+     * PrivatePoolFirst
+     */
     strategy?: string;
     static names(): {
         [key: string]: string;
@@ -7688,9 +7696,25 @@ export declare class DescribeElasticStrengthResponseBodyElasticStrengthModels ex
     });
 }
 export declare class DescribeElasticStrengthResponseBodyResourcePoolsInventoryHealth extends $dara.Model {
+    /**
+     * @example
+     * 3
+     */
     adequacyScore?: number;
+    /**
+     * @example
+     * 3
+     */
     healthScore?: number;
+    /**
+     * @example
+     * 3
+     */
     hotScore?: number;
+    /**
+     * @example
+     * 3
+     */
     supplyScore?: number;
     static names(): {
         [key: string]: string;
@@ -7729,6 +7753,10 @@ export declare class DescribeElasticStrengthResponseBodyResourcePools extends $d
      * The instanceType does not support the image in the configuration.
      */
     msg?: string;
+    /**
+     * @example
+     * Available
+     */
     status?: string;
     /**
      * @remarks
@@ -9005,6 +9033,10 @@ export declare class DescribeScalingConfigurationsResponseBodyScalingConfigurati
 }
 export declare class DescribeScalingConfigurationsResponseBodyScalingConfigurationsResourcePoolOptions extends $dara.Model {
     privatePoolIds?: string[];
+    /**
+     * @example
+     * PrivatePoolFirst
+     */
     strategy?: string;
     static names(): {
         [key: string]: string;
@@ -14606,6 +14638,10 @@ export declare class ModifyScalingConfigurationRequestNetworkInterfaces extends
 }
 export declare class ModifyScalingConfigurationRequestResourcePoolOptions extends $dara.Model {
     privatePoolIds?: string[];
+    /**
+     * @example
+     * PrivatePoolFirst
+     */
     strategy?: string;
     static names(): {
         [key: string]: string;
@@ -15412,6 +15448,10 @@ export declare class ModifyScalingConfigurationShrinkRequestNetworkInterfaces ex
 }
 export declare class ModifyScalingConfigurationShrinkRequestResourcePoolOptions extends $dara.Model {
     privatePoolIds?: string[];
+    /**
+     * @example
+     * PrivatePoolFirst
+     */
     strategy?: string;
     static names(): {
         [key: string]: string;
@@ -15749,6 +15789,20 @@ export declare class ModifyScalingRuleRequestStepAdjustments extends $dara.Model
         [key: string]: any;
     });
 }
+export declare class RemoveInstancesRequestLifecycleHookContext extends $dara.Model {
+    disableLifecycleHook?: boolean;
+    ignoredLifecycleHookIds?: string[];
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class ScaleWithAdjustmentRequestLifecycleHookContext extends $dara.Model {
     /**
      * @remarks
@@ -16224,7 +16278,7 @@ export declare class AttachAlbServerGroupsRequest extends $dara.Model {
      * @remarks
      * Specifies whether to add the existing Elastic Compute Service (ECS) instances or elastic container instances in the scaling group to the new ALB server group. Valid values:
      *
-     * *   true: adds the existing ECS instances or elastic container instances in the scaling group to the new ALB server group. In this case, the system returns the value of `ScalingActivityId`.
+     * *   true: adds the existing ECS instances or elastic container instances in the scaling group to the new ALB server group and returns the value of `ScalingActivityId`. You can query the value of ScalingActivityId to check whether the existing ECS instances are added to the ALB server group.
      * *   false: does not add the existing ECS instances or elastic container instances in the scaling group to the new ALB server group.
      *
      * Default value: false.
@@ -16348,7 +16402,7 @@ export declare class AttachDBInstancesRequest extends $dara.Model {
     DBInstances?: string[];
     /**
      * @remarks
-     * Specifies whether to add the private IP addresses of all ECS instances in the scaling group to the IP address whitelist of an ApsaraDB RDS instance when you attach the ApsaraDB RDS instance to the scaling group. Valid values:
+     * Specifies whether to add the private IP addresses of all ECS instances in the scaling group to the IP address whitelist of the ApsaraDB RDS instance that you want to attach to the scaling group. Valid values:
      *
      * *   true
      * *   false
@@ -17388,11 +17442,11 @@ export declare class CreateAlarmRequest extends $dara.Model {
     scalingGroupId?: string;
     /**
      * @remarks
-     * The method that you want to use to aggregate the metric data. Valid values:
+     * The statistical method of the metric data. Valid values:
      *
-     * *   Average: the average value.
-     * *   Minimum: the minimum value.
-     * *   Maximum: the maximum value.
+     * *   Average: calculates the average value of the metric data.
+     * *   Minimum: calculates the minimum value of the metric data.
+     * *   Maximum: calculates the maximum value of the metric data.
      *
      * Default value: Average.
      *
@@ -17845,7 +17899,7 @@ export declare class CreateEciScalingConfigurationRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * The name of the instance Resource Access Management (RAM) role. Elastic container instances and Elastic Compute Service (ECS) instances can share the same RAM role. For more information, see [Use an instance RAM role by calling API operations](https://help.aliyun.com/document_detail/61178.html).
+     * The name of the instance Resource Access Management (RAM) role. Elastic container instances and Elastic Compute Service (ECS) instances can share the same RAM role. For more information, see [RAM roles](https://help.aliyun.com/document_detail/61175.html).
      *
      * @example
      * RamTestRole
@@ -20117,7 +20171,7 @@ export declare class CreateScalingRuleRequest extends $dara.Model {
      * *   SimpleScalingRule: a simple scaling rule. After you execute a simple scaling rule, Auto Scaling adjusts the number of ECS instances or elastic container instances in the scaling group based on the values of AdjustmentType and AdjustmentValue.
      * *   TargetTrackingScalingRule: a target tracking scaling rule. After you execute a target tracking scaling rule, Auto Scaling dynamically calculates the number of ECS instances or elastic container instances to scale based on the predefined metric (MetricName) and attempts to maintain the metric value close to the expected value (TargetValue).
      * *   StepScalingRule: a step scaling rule. After you execute a step scaling rule, Auto Scaling scales instances step by step based on the predefined thresholds and metric values.
-     * *   PredictiveScalingRule: a predictive scaling rule. After you execute a predictive scaling rule, Auto Scaling uses machine learning to analyze historical monitoring data of the scaling group and predicts the future values of metrics. In addition, Auto Scaling automatically creates scheduled tasks to specify the value range for the scaling group.
+     * *   PredictiveScalingRule: a predictive scaling rule. After you execute a predictive scaling rule, Auto Scaling uses machine learning to analyze historical monitoring data of the scaling group and predicts the future values of metrics. In addition, Auto Scaling automatically creates scheduled tasks to adjust the boundary values for the scaling group.
      *
      * Default value: SimpleScalingRule.
      *
@@ -21576,7 +21630,7 @@ export declare class DescribeEciScalingConfigurationsRequest extends $dara.Model
     ownerId?: number;
     /**
      * @remarks
-     * The number of the page to return. Pages start from page 1.
+     * The page number. Pages start from page 1.
      *
      * Default value: 1.
      *
@@ -21586,7 +21640,7 @@ export declare class DescribeEciScalingConfigurationsRequest extends $dara.Model
     pageNumber?: number;
     /**
      * @remarks
-     * The number of entries to return on each page. Maximum value: 50.
+     * The number of entries per page. Maximum value: 50.
      *
      * Default value: 10.
      *
@@ -21846,6 +21900,10 @@ export declare class DescribeElasticStrengthRequest extends $dara.Model {
     });
 }
 export declare class DescribeElasticStrengthResponseBody extends $dara.Model {
+    /**
+     * @example
+     * Strong
+     */
     elasticStrength?: string;
     /**
      * @remarks
@@ -24620,7 +24678,7 @@ export declare class DetachLoadBalancersRequest extends $dara.Model {
     clientToken?: string;
     /**
      * @remarks
-     * Specifies whether to remove Elastic Compute Service (ECS) instances in the scaling group from the backend server groups of the Server Load Balancer (SLB) instance. Valid values:
+     * Specifies whether to remove Elastic Compute Service (ECS) instances in the scaling group from the backend server groups of the load balancer. Valid values:
      *
      * *   true
      * *   false
@@ -26035,7 +26093,7 @@ export declare class ModifyAlarmRequest extends $dara.Model {
      * @remarks
      * The metric type. Valid values:
      *
-     * *   system: system metrics of CloudMonitor
+     * *   system: system metrics of CloudMonitor.
      * *   custom: custom metrics that are reported to CloudMonitor.
      *
      * @example
@@ -26719,12 +26777,15 @@ export declare class ModifyInstanceAttributeRequest extends $dara.Model {
      * @remarks
      * The ID of the ECS instance.
      *
-     * This parameter is required.
-     *
      * @example
      * i-bp109k5j3dum1ce6****
      */
     instanceId?: string;
+    /**
+     * @remarks
+     * The instance IDs.
+     */
+    instanceIds?: string[];
     ownerId?: number;
     /**
      * @remarks
@@ -29165,6 +29226,126 @@ export declare class RemoveInstancesRequest extends $dara.Model {
      * This parameter is required.
      */
     instanceIds?: string[];
+    lifecycleHookContext?: RemoveInstancesRequestLifecycleHookContext;
+    ownerAccount?: string;
+    ownerId?: number;
+    /**
+     * @remarks
+     * The region ID of the scaling group.
+     *
+     * @example
+     * cn-qingdao
+     */
+    regionId?: string;
+    /**
+     * @remarks
+     * The action subsequent to the removal of the Elastic Compute Service (ECS) instances. Valid values:
+     *
+     * *   recycle: The ECS instances enter the Economical Mode.
+     *
+     *     **
+     *
+     *     **Note** This setting is applicable only if you set `ScalingPolicy` to `recycle`.
+     *
+     * *   release: The ECS instances are released.
+     *
+     * ScalingPolicy of the CreateScalingGroup operation specifies the reclaim mode of the scaling group while RemovePolicy of the RemoveInstances operation specifies the subsequent action when an ECS instance is removed from the scaling group. Examples:
+     *
+     * *   If you set ScalingPolicy and RemovePolicy to recycle, the ECS instances enter the Economical Mode when they are removed.
+     * *   If you set ScalingPolicy to recycle and RemovePolicy to release, the ECS instances are released when they are removed.
+     * *   If you set ScalingPolicy to release and RemovePolicy to recycle, the ECS instances are released when they are removed.
+     * *   If you set ScalingPolicy and RemovePolicy to release, the ECS instances are released when they are removed.
+     *
+     * Default value: release.
+     *
+     * @example
+     * release
+     */
+    removePolicy?: string;
+    resourceOwnerAccount?: string;
+    resourceOwnerId?: number;
+    /**
+     * @remarks
+     * The ID of the scaling group.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * asg-bp18p2yfxow2dloq****
+     */
+    scalingGroupId?: string;
+    /**
+     * @remarks
+     * The period of time required by the ECS instance to enter the Stopped state. Unit: seconds. Valid values: 30 to 240.
+     *
+     * >
+     *
+     * *   By default, this parameter inherits the value of StopInstanceTimeout specified in the CreateScalingGroup or ModifyScalingGroup operation. You can also specify a different value for this parameter in the RemoveInstances operation.
+     *
+     * *   This parameter takes effect only if you set RemovePolicy to release.
+     *
+     * *   If you specify this parameter, the system waits for the ECS instance to enter the Stopped state only for up to the specified period of time before continuing with the scale-in operation, regardless of the status of the ECS instance.
+     *
+     * *   If you do not specify this parameter, the system continues with the scale-in operation until the ECS instance enters the Stopped state. If the ECS instance is not successfully stopped, the scale-in process is rolled back and considered failed.
+     *
+     * @example
+     * 60
+     */
+    stopInstanceTimeout?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class RemoveInstancesShrinkRequest extends $dara.Model {
+    /**
+     * @remarks
+     * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25965.html).
+     *
+     * @example
+     * 123e4567-e89b-12d3-a456-42665544****
+     */
+    clientToken?: string;
+    /**
+     * @remarks
+     * Specifies whether to adjust the expected number of ECS instances in the scaling group. Valid values:
+     *
+     * *   true: After ECS instances are removed from the scaling group, the expected number of ECS instances in the scaling group decreases.
+     * *   false: After ECS instances are removed from the scaling group, the expected number of ECS instances in the scaling group remains unchanged.
+     *
+     * Default value: true.
+     *
+     * @example
+     * true
+     */
+    decreaseDesiredCapacity?: boolean;
+    /**
+     * @remarks
+     * Specifies whether to ignore invalid instances when you remove a batch of instances from the scaling group. Valid values:
+     *
+     * *   true: ignores invalid instances. If invalid instances exist and valid instances are deleted, the corresponding scaling activity enters the Warning state. You can check the scaling activity details to view the invalid instances that are ignored.
+     * *   false: does not ignore invalid instances. If invalid instances exist in the batch of instances that you want to remove from the scaling group, an error is reported.
+     *
+     * Default value: false.
+     *
+     * @example
+     * false
+     */
+    ignoreInvalidInstance?: boolean;
+    /**
+     * @remarks
+     * The IDs of the ECS instances that you want to remove from the scaling group.
+     *
+     * This parameter is required.
+     */
+    instanceIds?: string[];
+    lifecycleHookContextShrink?: string;
     ownerAccount?: string;
     ownerId?: number;
     /**
@@ -32588,11 +32769,11 @@ export default class Client extends OpenApi {
      * *   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.
      * 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.
      *
-     * @param request - RemoveInstancesRequest
+     * @param tmpReq - RemoveInstancesRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns RemoveInstancesResponse
      */
-    removeInstancesWithOptions(request: RemoveInstancesRequest, runtime: $dara.RuntimeOptions): Promise<RemoveInstancesResponse>;
+    removeInstancesWithOptions(tmpReq: RemoveInstancesRequest, runtime: $dara.RuntimeOptions): Promise<RemoveInstancesResponse>;
     /**
      * Removes one or more instances from a scaling group. If your scaling group is enabled and contains no ongoing scaling activities, you can call the RemoveInstances operation to remove instances that you no longer require from the scaling group.
      *