@alicloud/ess20220222 1.8.20 → 1.8.22

package/src/models/CreateScalingGroupRequest.ts

@@ -491,7 +491,7 @@ export class CreateScalingGroupRequestServerGroups extends $dara.Model {
 export class CreateScalingGroupRequestTags extends $dara.Model {
   /**
    * @remarks
-   * The tag key that you want to add to the scaling group.
+   * The tag key of the scaling group.
    * 
    * @example
    * Department
@@ -499,7 +499,7 @@ export class CreateScalingGroupRequestTags extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Specifies whether to propagate the tag that you want to add to the scaling group. Valid values:
+   * Identifies whether the tag is a propagatable tag. Valid values:
    * 
    * *   true: propagates the tag to only instances that are newly created.
    * *   false: does not propagate the tag to any instances.
@@ -512,7 +512,7 @@ export class CreateScalingGroupRequestTags extends $dara.Model {
   propagate?: boolean;
   /**
    * @remarks
-   * The tag value that you want to add to the scaling group.
+   * The tag value of the scaling group.
    * 
    * @example
    * Finance
@@ -654,6 +654,19 @@ export class CreateScalingGroupRequest extends $dara.Model {
    * priority
    */
   allocationStrategy?: string;
+  /**
+   * @remarks
+   * Whether to enable automatic rebalancing for the scaling group. This takes effect only when BalancedOnly is enabled for the scaling group. Valid values:
+   * 
+   * *   false: Auto rebalancing is disabled for the scaling group.
+   * *   true: If Auto rebalancing is enabled, the scaling group automatically detects the capacity of the zone. If the capacity of the zone is unbalanced, the scaling group actively scales out the zone and re-balances the capacity of the zone.
+   * 
+   * Default value: false.
+   * 
+   * @example
+   * false
+   */
+  autoRebalance?: boolean;
   /**
    * @remarks
    * Specifies whether to evenly distribute instances in the scaling group across multiple zones. This parameter takes effect only if you set `MultiAZPolicy` to `COMPOSABLE`. Valid values:
@@ -669,6 +682,19 @@ export class CreateScalingGroupRequest extends $dara.Model {
    * false
    */
   azBalance?: boolean;
+  /**
+   * @remarks
+   * The zone balancing mode. This mode takes effect only when the zone balancing mode is enabled. Valid values:
+   * 
+   * *   BalancedBestEffort: If a resource fails to be created in a zone, it is downgraded to another zone to ensure best-effort delivery of the resource.
+   * *   BalancedOnly: If a resource fails to be created in a zone, it is not downgraded to another zone. The scale-out activity is partially successful to avoid excessive imbalance of resources in different zones.
+   * 
+   * Default value: BalancedBestEffort.
+   * 
+   * @example
+   * BalancedBestEffort
+   */
+  balanceMode?: string;
   /**
    * @remarks
    * The capacity options.
@@ -1067,7 +1093,7 @@ export class CreateScalingGroupRequest extends $dara.Model {
   syncAlarmRuleToCms?: boolean;
   /**
    * @remarks
-   * The tags that you want to add to the scaling group.
+   * The information about the tags of the scaling group.
    */
   tags?: CreateScalingGroupRequestTags[];
   /**
@@ -1102,7 +1128,9 @@ export class CreateScalingGroupRequest extends $dara.Model {
     return {
       albServerGroups: 'AlbServerGroups',
       allocationStrategy: 'AllocationStrategy',
+      autoRebalance: 'AutoRebalance',
       azBalance: 'AzBalance',
+      balanceMode: 'BalanceMode',
       capacityOptions: 'CapacityOptions',
       clientToken: 'ClientToken',
       compensateWithOnDemand: 'CompensateWithOnDemand',
@@ -1154,7 +1182,9 @@ export class CreateScalingGroupRequest extends $dara.Model {
     return {
       albServerGroups: { 'type': 'array', 'itemType': CreateScalingGroupRequestAlbServerGroups },
       allocationStrategy: 'string',
+      autoRebalance: 'boolean',
       azBalance: 'boolean',
+      balanceMode: 'string',
       capacityOptions: CreateScalingGroupRequestCapacityOptions,
       clientToken: 'string',
       compensateWithOnDemand: 'boolean',

package/src/models/DescribeInstanceRefreshesResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksCheckpoints extends $dara.Model {
+  /**
+   * @example
+   * 60
+   */
   percentage?: number;
   static names(): { [key: string]: string } {
     return {
@@ -26,8 +30,20 @@ export class DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksCheckpoint
 }
 
 export class DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksDesiredConfigurationContainersEnvironmentVars extends $dara.Model {
+  /**
+   * @example
+   * fieldPath
+   */
   fieldRefFieldPath?: string;
+  /**
+   * @example
+   * PATH
+   */
   key?: string;
+  /**
+   * @example
+   * /usr/local/bin
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -58,7 +74,15 @@ export class DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksDesiredCon
   args?: string[];
   commands?: string[];
   environmentVars?: DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksDesiredConfigurationContainersEnvironmentVars[];
+  /**
+   * @example
+   * registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
+   */
   image?: string;
+  /**
+   * @example
+   * name
+   */
   name?: string;
   static names(): { [key: string]: string } {
     return {
@@ -99,6 +123,10 @@ export class DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksDesiredCon
 }
 
 export class DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksDesiredConfigurationLaunchTemplateOverrides extends $dara.Model {
+  /**
+   * @example
+   * ecs.sn1ne.large
+   */
   instanceType?: string;
   static names(): { [key: string]: string } {
     return {
@@ -131,8 +159,16 @@ export class DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksDesiredCon
    * m-uf6g5noisr****
    */
   imageId?: string;
+  /**
+   * @example
+   * lt-2ze5x4mp*****
+   */
   launchTemplateId?: string;
   launchTemplateOverrides?: DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksDesiredConfigurationLaunchTemplateOverrides[];
+  /**
+   * @example
+   * Latest
+   */
   launchTemplateVersion?: string;
   /**
    * @remarks
@@ -180,6 +216,10 @@ export class DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksDesiredCon
 }
 
 export class DescribeInstanceRefreshesResponseBodyInstanceRefreshTasks extends $dara.Model {
+  /**
+   * @example
+   * 30
+   */
   checkpointPauseTime?: number;
   checkpoints?: DescribeInstanceRefreshesResponseBodyInstanceRefreshTasksCheckpoints[];
   /**

package/src/models/DescribeNotificationConfigurationsResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeNotificationConfigurationsResponseBodyNotificationConfigurationModels extends $dara.Model {
+  /**
+   * @example
+   * PlainText
+   */
   messageEncoding?: string;
   /**
    * @remarks

package/src/models/DescribeScalingGroupsRequest.ts

@@ -58,7 +58,7 @@ export class DescribeScalingGroupsRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The page number. Pages start from page 1.
+   * The page number. Page starts from page 1.
    * 
    * Default value: 1.
    * 
@@ -68,7 +68,7 @@ export class DescribeScalingGroupsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Maximum value: 50.
+   * The number of entries to return on each page. Maximum value: 50.
    * 
    * Default value: 10.
    * 

package/src/models/DescribeScalingGroupsResponseBody.ts

@@ -521,6 +521,17 @@ export class DescribeScalingGroupsResponseBodyScalingGroups extends $dara.Model
    * priority
    */
   allocationStrategy?: string;
+  /**
+   * @remarks
+   * Whether to enable automatic rebalancing for the scaling group. This takes effect only when BalancedOnly is enabled for the scaling group. Valid value:
+   * 
+   * *   false: Auto rebalancing is disabled for the scaling group.
+   * *   true: If Auto rebalancing is enabled, the scaling group automatically detects the capacity of the zone. If the capacity of the zone is unbalanced, the scaling group actively scales out the zone and re-balances the capacity of the zone.
+   * 
+   * @example
+   * false
+   */
+  autoRebalance?: boolean;
   /**
    * @remarks
    * Indicates whether instances in the scaling group are evenly distributed across the specified zones. This parameter takes effect only if you set `MultiAZPolicy` to `COMPOSABLE`. Valid values:
@@ -532,6 +543,17 @@ export class DescribeScalingGroupsResponseBodyScalingGroups extends $dara.Model
    * false
    */
   azBalance?: boolean;
+  /**
+   * @remarks
+   * The zone balancing mode. This mode takes effect only when the zone balancing mode is enabled. Valid value:
+   * 
+   * *   Default value: BalancedBestEffort. If a resource fails to be created in a zone, the resource is downgraded to another zone. This ensures best-effort delivery of the resource.
+   * *   BalancedOnly: If a resource fails to be created in a zone, the resource is not downgraded to another zone. The scale-out activity is partially successful to avoid excessive imbalance of resources in different zones.
+   * 
+   * @example
+   * BalancedBestEffort
+   */
+  balanceMode?: string;
   /**
    * @remarks
    * The capacity options.
@@ -1026,7 +1048,9 @@ export class DescribeScalingGroupsResponseBodyScalingGroups extends $dara.Model
       activeScalingConfigurationId: 'ActiveScalingConfigurationId',
       albServerGroups: 'AlbServerGroups',
       allocationStrategy: 'AllocationStrategy',
+      autoRebalance: 'AutoRebalance',
       azBalance: 'AzBalance',
+      balanceMode: 'BalanceMode',
       capacityOptions: 'CapacityOptions',
       compensateWithOnDemand: 'CompensateWithOnDemand',
       creationTime: 'CreationTime',
@@ -1094,7 +1118,9 @@ export class DescribeScalingGroupsResponseBodyScalingGroups extends $dara.Model
       activeScalingConfigurationId: 'string',
       albServerGroups: { 'type': 'array', 'itemType': DescribeScalingGroupsResponseBodyScalingGroupsAlbServerGroups },
       allocationStrategy: 'string',
+      autoRebalance: 'boolean',
       azBalance: 'boolean',
+      balanceMode: 'string',
       capacityOptions: DescribeScalingGroupsResponseBodyScalingGroupsCapacityOptions,
       compensateWithOnDemand: 'boolean',
       creationTime: 'string',

package/src/models/ModifyEciScalingConfigurationRequest.ts

@@ -2119,6 +2119,7 @@ export class ModifyEciScalingConfigurationRequest extends $dara.Model {
    * The endpoints of Network Time Protocol (NTP) servers.
    */
   ntpServers?: string[];
+  override?: boolean;
   ownerId?: number;
   /**
    * @remarks
@@ -2267,6 +2268,7 @@ export class ModifyEciScalingConfigurationRequest extends $dara.Model {
       loadBalancerWeight: 'LoadBalancerWeight',
       memory: 'Memory',
       ntpServers: 'NtpServers',
+      override: 'Override',
       ownerId: 'OwnerId',
       ramRoleName: 'RamRoleName',
       resourceGroupId: 'ResourceGroupId',
@@ -2323,6 +2325,7 @@ export class ModifyEciScalingConfigurationRequest extends $dara.Model {
       loadBalancerWeight: 'number',
       memory: 'number',
       ntpServers: { 'type': 'array', 'itemType': 'string' },
+      override: 'boolean',
       ownerId: 'number',
       ramRoleName: 'string',
       resourceGroupId: 'string',

package/src/models/ModifyNotificationConfigurationRequest.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyNotificationConfigurationRequest extends $dara.Model {
+  /**
+   * @example
+   * PlainText
+   */
   messageEncoding?: string;
   /**
    * @remarks

package/src/models/ModifyScalingGroupRequest.ts

@@ -183,6 +183,19 @@ export class ModifyScalingGroupRequest extends $dara.Model {
    * priority
    */
   allocationStrategy?: string;
+  /**
+   * @remarks
+   * Whether to enable automatic rebalancing for the scaling group. This takes effect only when BalancedOnly is enabled for the scaling group. Valid values:
+   * 
+   * *   false: Auto rebalancing is disabled for the scaling group.
+   * *   true: If Auto rebalancing is enabled, the scaling group automatically detects the capacity of the zone. If the capacity of the zone is unbalanced, the scaling group actively scales out the zone and re-balances the capacity of the zone.
+   * 
+   * Default value: false.
+   * 
+   * @example
+   * false
+   */
+  autoRebalance?: boolean;
   /**
    * @remarks
    * Specifies whether to evenly distribute instances in the scaling group across zones. This parameter takes effect only when you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:
@@ -196,6 +209,19 @@ export class ModifyScalingGroupRequest extends $dara.Model {
    * false
    */
   azBalance?: boolean;
+  /**
+   * @remarks
+   * The zone balancing mode. This mode takes effect only when the zone balancing mode is enabled. Valid values:
+   * 
+   * *   BalancedBestEffort: If a resource fails to be created in a zone, the resource is downgraded to another zone. This ensures best-effort delivery of the resource.
+   * *   BalancedOnly: If a resource fails to be created in a zone, the resource is not downgraded to another zone. The scale-out activity is partially successful to avoid excessive imbalance of resources in different zones.
+   * 
+   * Default value: BalancedBestEffort.
+   * 
+   * @example
+   * BalancedBestEffort
+   */
+  balanceMode?: string;
   /**
    * @remarks
    * The capacity options.
@@ -491,7 +517,9 @@ export class ModifyScalingGroupRequest extends $dara.Model {
     return {
       activeScalingConfigurationId: 'ActiveScalingConfigurationId',
       allocationStrategy: 'AllocationStrategy',
+      autoRebalance: 'AutoRebalance',
       azBalance: 'AzBalance',
+      balanceMode: 'BalanceMode',
       capacityOptions: 'CapacityOptions',
       compensateWithOnDemand: 'CompensateWithOnDemand',
       customPolicyARN: 'CustomPolicyARN',
@@ -530,7 +558,9 @@ export class ModifyScalingGroupRequest extends $dara.Model {
     return {
       activeScalingConfigurationId: 'string',
       allocationStrategy: 'string',
+      autoRebalance: 'boolean',
       azBalance: 'boolean',
+      balanceMode: 'string',
       capacityOptions: ModifyScalingGroupRequestCapacityOptions,
       compensateWithOnDemand: 'boolean',
       customPolicyARN: 'string',

package/src/models/StartInstanceRefreshRequest.ts

@@ -3,6 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class StartInstanceRefreshRequestCheckpoints extends $dara.Model {
+  /**
+   * @remarks
+   * The percentage of new instances in the scaling group to the total number of instances. When this percentage is reached, the task is automatically suspended. Valid values: 1 to 100 (%).
+   * 
+   * >  Requires a small to large setting, and the last progress percentage needs to be 100.
+   * 
+   * @example
+   * 20
+   */
   percentage?: number;
   static names(): { [key: string]: string } {
     return {
@@ -26,8 +35,29 @@ export class StartInstanceRefreshRequestCheckpoints extends $dara.Model {
 }
 
 export class StartInstanceRefreshRequestDesiredConfigurationContainersEnvironmentVars extends $dara.Model {
+  /**
+   * @remarks
+   * >  This parameter is unavailable for use.
+   * 
+   * @example
+   * fieldPath
+   */
   fieldRefFieldPath?: string;
+  /**
+   * @remarks
+   * The name of the environment variable. It can be 1 to 128 characters in length. Format requirement:[0-9a-zA-Z], and underscores, cannot start with a number.
+   * 
+   * @example
+   * PATH
+   */
   key?: string;
+  /**
+   * @remarks
+   * The value of the environment variable. The value must be 0 to 256 bits in length.
+   * 
+   * @example
+   * /usr/local/bin
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -55,10 +85,36 @@ export class StartInstanceRefreshRequestDesiredConfigurationContainersEnvironmen
 }
 
 export class StartInstanceRefreshRequestDesiredConfigurationContainers extends $dara.Model {
+  /**
+   * @remarks
+   * The argument that corresponds to the startup command of the container. You can specify up to 10 arguments.
+   */
   args?: string[];
+  /**
+   * @remarks
+   * The container startup commands. You can specify up to 20 commands. Each command can contain up to 256 characters.
+   */
   commands?: string[];
+  /**
+   * @remarks
+   * The environment variables.
+   */
   environmentVars?: StartInstanceRefreshRequestDesiredConfigurationContainersEnvironmentVars[];
+  /**
+   * @remarks
+   * The image in the container.
+   * 
+   * @example
+   * registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
+   */
   image?: string;
+  /**
+   * @remarks
+   * The custom name of the container.
+   * 
+   * @example
+   * nginx
+   */
   name?: string;
   static names(): { [key: string]: string } {
     return {
@@ -99,6 +155,15 @@ export class StartInstanceRefreshRequestDesiredConfigurationContainers extends $
 }
 
 export class StartInstanceRefreshRequestDesiredConfigurationLaunchTemplateOverrides extends $dara.Model {
+  /**
+   * @remarks
+   * The instance type specified by using this parameter overwrites the instance type of the launch template.
+   * 
+   * >  This parameter takes effect only if you specify LaunchTemplateId.
+   * 
+   * @example
+   * ecs.c5.2xlarge
+   */
   instanceType?: string;
   static names(): { [key: string]: string } {
     return {
@@ -122,6 +187,16 @@ export class StartInstanceRefreshRequestDesiredConfigurationLaunchTemplateOverri
 }
 
 export class StartInstanceRefreshRequestDesiredConfiguration extends $dara.Model {
+  /**
+   * @remarks
+   * The containers in the elastic container instance.
+   * 
+   * > 
+   * 
+   * *   This parameter supports only scaling groups of the ECI type.
+   * 
+   * *   Only the containers in the scaling configuration list that are the same as those in the `Container.Name` are refreshed.
+   */
   containers?: StartInstanceRefreshRequestDesiredConfigurationContainers[];
   /**
    * @remarks
@@ -137,15 +212,37 @@ export class StartInstanceRefreshRequestDesiredConfiguration extends $dara.Model
    * m-2ze8cqacj7opnf***
    */
   imageId?: string;
+  /**
+   * @remarks
+   * The ID of the launch template that you want to enable in the scaling group.
+   * 
+   * @example
+   * lt-2ze2qli30u***
+   */
   launchTemplateId?: string;
+  /**
+   * @remarks
+   * The information about the instance types that are extended in the launch template.
+   */
   launchTemplateOverrides?: StartInstanceRefreshRequestDesiredConfigurationLaunchTemplateOverrides[];
+  /**
+   * @remarks
+   * The version number of the launch template. Valid value:
+   * 
+   * *   A fixed template version number.
+   * *   Default: the default version of the template.
+   * *   Latest: the latest version of the template.
+   * 
+   * >  If you set the version to Default or Latest, the instance refresh task cannot be rolled back.
+   * 
+   * @example
+   * 8
+   */
   launchTemplateVersion?: string;
   /**
    * @remarks
    * The ID of the scaling configuration.
    * 
-   * >  After the instance refresh task is complete, the scaling group uses the scaling configuration specified by this parameter.
-   * 
    * @example
    * asc-2zed7lqn4ts4****
    */
@@ -188,7 +285,22 @@ export class StartInstanceRefreshRequestDesiredConfiguration extends $dara.Model
 }
 
 export class StartInstanceRefreshRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The duration of the pause when the refresh task checkpoint is entered.
+   * 
+   * *   Unit: minutes
+   * *   Valid values: 1 to 2880.
+   * *   Default: 60.
+   * 
+   * @example
+   * 10
+   */
   checkpointPauseTime?: number;
+  /**
+   * @remarks
+   * Refresh Task Checkpoint: specifies that the task is automatically suspended for CheckpointPauseTime minutes when the proportion of new instances reaches the specified value during instance refresh.
+   */
   checkpoints?: StartInstanceRefreshRequestCheckpoints[];
   /**
    * @remarks
@@ -204,9 +316,9 @@ export class StartInstanceRefreshRequest extends $dara.Model {
    * 
    * > 
    * 
-   * *   When you call this operation, you must specify one of the following parameters: ScalingConfigurationId and ImageId.
+   * *   ScalingConfigurationId, ImageId, LaunchTemplateId, and Containers cannot be set at the same time. If you do not specify this parameter, the scaling group is refreshed based on the configurations that are in effect.
    * 
-   * *   Instances whose configurations match the desired configurations of the task are ignored during instance refresh.
+   * *   After the instance refresh task is complete, the scaling group uses the scaling configuration specified by this parameter.
    */
   desiredConfiguration?: StartInstanceRefreshRequestDesiredConfiguration;
   /**