@alicloud/ess20220222 1.8.11 → 1.8.13

package/dist/client.d.ts

@@ -2209,6 +2209,24 @@ export declare class CreateScalingConfigurationRequestNetworkInterfaces extends
         [key: string]: any;
     });
 }
+export declare class CreateScalingConfigurationRequestResourcePoolOptions extends $dara.Model {
+    privatePoolIds?: string[];
+    /**
+     * @example
+     * PrivatePoolFirst
+     */
+    strategy?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class CreateScalingConfigurationRequestSecurityOptions extends $dara.Model {
     /**
      * @remarks
@@ -2983,6 +3001,24 @@ export declare class CreateScalingConfigurationShrinkRequestNetworkInterfaces ex
         [key: string]: any;
     });
 }
+export declare class CreateScalingConfigurationShrinkRequestResourcePoolOptions extends $dara.Model {
+    privatePoolIds?: string[];
+    /**
+     * @example
+     * PrivatePoolFirst
+     */
+    strategy?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class CreateScalingConfigurationShrinkRequestSecurityOptions extends $dara.Model {
     /**
      * @remarks
@@ -3107,6 +3143,14 @@ export declare class CreateScalingGroupRequestCapacityOptions extends $dara.Mode
      */
     onDemandPercentageAboveBaseCapacity?: number;
     /**
+     * @remarks
+     * The cost comparison method. Valid values:
+     *
+     * *   PricePerUnit: compares costs based on unit price divided by instance capacities (weights). The capacity of an instance in a scaling group is determined by the weight of the instance type used. If no weight is set, the capacity defaults to 1.
+     * *   PricePerVCpu: compares costs based on unit price divided by the number of vCPUs.
+     *
+     * Default value: PricePerUnit.
+     *
      * @example
      * PricePerUnit
      */
@@ -7652,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;
@@ -7693,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
@@ -8967,6 +9031,24 @@ export declare class DescribeScalingConfigurationsResponseBodyScalingConfigurati
         [key: string]: any;
     });
 }
+export declare class DescribeScalingConfigurationsResponseBodyScalingConfigurationsResourcePoolOptions extends $dara.Model {
+    privatePoolIds?: string[];
+    /**
+     * @example
+     * PrivatePoolFirst
+     */
+    strategy?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DescribeScalingConfigurationsResponseBodyScalingConfigurationsSchedulerOptions extends $dara.Model {
     /**
      * @remarks
@@ -9416,6 +9498,7 @@ export declare class DescribeScalingConfigurationsResponseBodyScalingConfigurati
      * rg-aekzn2ou7xo****
      */
     resourceGroupId?: string;
+    resourcePoolOptions?: DescribeScalingConfigurationsResponseBodyScalingConfigurationsResourcePoolOptions;
     /**
      * @remarks
      * The ID of the scaling configuration.
@@ -10583,10 +10666,13 @@ export declare class DescribeScalingGroupsResponseBodyScalingGroupsCapacityOptio
     onDemandPercentageAboveBaseCapacity?: number;
     /**
      * @remarks
-     * The price comparison mode. Valid values:
+     * Indicates how prices are compared. Valid values:
      *
-     * *   PricePerUnit: compares prices based on capacity. The capacity of instances in a scaling group is determined by the weights of the instance types used. If no weight is specified, the default weight is 1.
-     * *   PricePerVCpu: compares prices based on the price per vCPU.
+     * *   PricePerUnit: Prices are compared based on the price per instance capacity.
+     *
+     *     Capacity is determined by the weights assigned to instance types in the scaling group. If no weight is specified, a default weight of 1 is used, meaning each instance is assigned a capacity of 1.
+     *
+     * *   PricePerVCpu: Prices are compared based on the price per vCPU.
      *
      * @example
      * PricePerUnit
@@ -11937,7 +12023,7 @@ export declare class DescribeScalingRulesResponseBodyScalingRules extends $dara.
     estimatedInstanceWarmup?: number;
     /**
      * @remarks
-     * The Hybrid Cloud Monitoring metrics.
+     * The Hybrid Cloud Monitoring metrics. For more information, see [Create a custom target tracking scaling rule](https://help.aliyun.com/document_detail/2852162.html).
      */
     hybridMetrics?: DescribeScalingRulesResponseBodyScalingRulesHybridMetrics[];
     /**
@@ -14550,6 +14636,24 @@ export declare class ModifyScalingConfigurationRequestNetworkInterfaces extends
         [key: string]: any;
     });
 }
+export declare class ModifyScalingConfigurationRequestResourcePoolOptions extends $dara.Model {
+    privatePoolIds?: string[];
+    /**
+     * @example
+     * PrivatePoolFirst
+     */
+    strategy?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class ModifyScalingConfigurationRequestSecurityOptions extends $dara.Model {
     /**
      * @remarks
@@ -15342,6 +15446,24 @@ export declare class ModifyScalingConfigurationShrinkRequestNetworkInterfaces ex
         [key: string]: any;
     });
 }
+export declare class ModifyScalingConfigurationShrinkRequestResourcePoolOptions extends $dara.Model {
+    privatePoolIds?: string[];
+    /**
+     * @example
+     * PrivatePoolFirst
+     */
+    strategy?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class ModifyScalingConfigurationShrinkRequestSecurityOptions extends $dara.Model {
     /**
      * @remarks
@@ -16142,7 +16264,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.
@@ -16266,7 +16388,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
@@ -17306,11 +17428,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.
      *
@@ -17763,7 +17885,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
@@ -18541,6 +18663,7 @@ export declare class CreateScalingConfigurationRequest extends $dara.Model {
      */
     resourceGroupId?: string;
     resourceOwnerAccount?: string;
+    resourcePoolOptions?: CreateScalingConfigurationRequestResourcePoolOptions;
     /**
      * @remarks
      * The name of the scaling configuration. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name must start with a letter or a digit.
@@ -19058,6 +19181,7 @@ export declare class CreateScalingConfigurationShrinkRequest extends $dara.Model
      */
     resourceGroupId?: string;
     resourceOwnerAccount?: string;
+    resourcePoolOptions?: CreateScalingConfigurationShrinkRequestResourcePoolOptions;
     /**
      * @remarks
      * The name of the scaling configuration. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name must start with a letter or a digit.
@@ -19856,7 +19980,7 @@ export declare class CreateScalingRuleRequest extends $dara.Model {
     estimatedInstanceWarmup?: number;
     /**
      * @remarks
-     * The Hybrid Cloud Monitoring metrics.
+     * The Hybrid Cloud Monitoring metrics. For more information, see [Create a custom target tracking scaling rule](https://help.aliyun.com/document_detail/2852162.html).
      */
     hybridMetrics?: CreateScalingRuleRequestHybridMetrics[];
     /**
@@ -20033,7 +20157,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.
      *
@@ -21032,7 +21156,7 @@ export declare class DescribeAlarmsRequest extends $dara.Model {
     metricName?: string;
     /**
      * @remarks
-     * The type of the metric. Valid values:
+     * The metric type. Valid values:
      *
      * *   system: system metrics of CloudMonitor
      * *   custom: custom metrics that are reported to CloudMonitor.
@@ -21492,7 +21616,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.
      *
@@ -21502,7 +21626,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.
      *
@@ -21762,6 +21886,10 @@ export declare class DescribeElasticStrengthRequest extends $dara.Model {
     });
 }
 export declare class DescribeElasticStrengthResponseBody extends $dara.Model {
+    /**
+     * @example
+     * Strong
+     */
     elasticStrength?: string;
     /**
      * @remarks
@@ -23461,7 +23589,7 @@ export declare class DescribeScalingGroupsRequest extends $dara.Model {
      * @remarks
      * The page number. Minimum value: 1.
      *
-     * Default value: 1.
+     * Default value: 1
      *
      * @example
      * 1
@@ -24536,7 +24664,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
@@ -25951,7 +26079,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
@@ -26635,12 +26763,11 @@ export declare class ModifyInstanceAttributeRequest extends $dara.Model {
      * @remarks
      * The ID of the ECS instance.
      *
-     * This parameter is required.
-     *
      * @example
      * i-bp109k5j3dum1ce6****
      */
     instanceId?: string;
+    instanceIds?: string[];
     ownerId?: number;
     /**
      * @remarks
@@ -27324,6 +27451,7 @@ export declare class ModifyScalingConfigurationRequest extends $dara.Model {
      */
     resourceGroupId?: string;
     resourceOwnerAccount?: string;
+    resourcePoolOptions?: ModifyScalingConfigurationRequestResourcePoolOptions;
     /**
      * @remarks
      * The ID of the scaling configuration that you want to modify.
@@ -27823,6 +27951,7 @@ export declare class ModifyScalingConfigurationShrinkRequest extends $dara.Model
      */
     resourceGroupId?: string;
     resourceOwnerAccount?: string;
+    resourcePoolOptions?: ModifyScalingConfigurationShrinkRequestResourcePoolOptions;
     /**
      * @remarks
      * The ID of the scaling configuration that you want to modify.
@@ -28449,7 +28578,7 @@ export declare class ModifyScalingRuleRequest extends $dara.Model {
     estimatedInstanceWarmup?: number;
     /**
      * @remarks
-     * The Hybrid Cloud Monitoring metrics.
+     * The Hybrid Cloud Monitoring metrics. For more information, see [Create a custom target tracking scaling rule](https://help.aliyun.com/document_detail/2852162.html).
      */
     hybridMetrics?: ModifyScalingRuleRequestHybridMetrics[];
     /**
@@ -32245,8 +32374,8 @@ export default class Client extends OpenApi {
      * Modifies a scaling configuration of the Elastic Container Instance type. When you call the ModifyEciScalingConfiguration operation, you can specify the ID, name, and instance properties of the scaling configuration whose information you want to modify. You can modify the instance restart policy, instance bidding policy, and elastic IP address (EIP) bandwidth.
      *
      * @remarks
-     *   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.
-     * *   You can call the [ModifyEciScalingConfiguration](https://help.aliyun.com/document_detail/459378.html) operation to check the modification result.
+     *   To rename a scaling configuration in a scaling group, ensure the new name is unique within that group.
+     * *   You can call the [DescribeEciScalingConfigurations](https://help.aliyun.com/document_detail/459374.html) operation to check the modification result.
      *
      * @param request - ModifyEciScalingConfigurationRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -32257,8 +32386,8 @@ export default class Client extends OpenApi {
      * Modifies a scaling configuration of the Elastic Container Instance type. When you call the ModifyEciScalingConfiguration operation, you can specify the ID, name, and instance properties of the scaling configuration whose information you want to modify. You can modify the instance restart policy, instance bidding policy, and elastic IP address (EIP) bandwidth.
      *
      * @remarks
-     *   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.
-     * *   You can call the [ModifyEciScalingConfiguration](https://help.aliyun.com/document_detail/459378.html) operation to check the modification result.
+     *   To rename a scaling configuration in a scaling group, ensure the new name is unique within that group.
+     * *   You can call the [DescribeEciScalingConfigurations](https://help.aliyun.com/document_detail/459374.html) operation to check the modification result.
      *
      * @param request - ModifyEciScalingConfigurationRequest
      * @returns ModifyEciScalingConfigurationResponse