@alicloud/ess20220222 1.4.2 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +299 -160
- package/dist/client.js +415 -169
- package/dist/client.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +453 -160
package/dist/client.d.ts
CHANGED
|
@@ -1539,6 +1539,50 @@ export declare class DescribeAlarmsResponse extends $tea.Model {
|
|
|
1539
1539
|
[key: string]: any;
|
|
1540
1540
|
});
|
|
1541
1541
|
}
|
|
1542
|
+
export declare class DescribeAlertConfigurationRequest extends $tea.Model {
|
|
1543
|
+
ownerId?: number;
|
|
1544
|
+
regionId?: string;
|
|
1545
|
+
resourceOwnerAccount?: string;
|
|
1546
|
+
scalingGroupId?: string;
|
|
1547
|
+
static names(): {
|
|
1548
|
+
[key: string]: string;
|
|
1549
|
+
};
|
|
1550
|
+
static types(): {
|
|
1551
|
+
[key: string]: any;
|
|
1552
|
+
};
|
|
1553
|
+
constructor(map?: {
|
|
1554
|
+
[key: string]: any;
|
|
1555
|
+
});
|
|
1556
|
+
}
|
|
1557
|
+
export declare class DescribeAlertConfigurationResponseBody extends $tea.Model {
|
|
1558
|
+
requestId?: string;
|
|
1559
|
+
scaleStatuses?: string[];
|
|
1560
|
+
static names(): {
|
|
1561
|
+
[key: string]: string;
|
|
1562
|
+
};
|
|
1563
|
+
static types(): {
|
|
1564
|
+
[key: string]: any;
|
|
1565
|
+
};
|
|
1566
|
+
constructor(map?: {
|
|
1567
|
+
[key: string]: any;
|
|
1568
|
+
});
|
|
1569
|
+
}
|
|
1570
|
+
export declare class DescribeAlertConfigurationResponse extends $tea.Model {
|
|
1571
|
+
headers?: {
|
|
1572
|
+
[key: string]: string;
|
|
1573
|
+
};
|
|
1574
|
+
statusCode?: number;
|
|
1575
|
+
body?: DescribeAlertConfigurationResponseBody;
|
|
1576
|
+
static names(): {
|
|
1577
|
+
[key: string]: string;
|
|
1578
|
+
};
|
|
1579
|
+
static types(): {
|
|
1580
|
+
[key: string]: any;
|
|
1581
|
+
};
|
|
1582
|
+
constructor(map?: {
|
|
1583
|
+
[key: string]: any;
|
|
1584
|
+
});
|
|
1585
|
+
}
|
|
1542
1586
|
export declare class DescribeEciScalingConfigurationDetailRequest extends $tea.Model {
|
|
1543
1587
|
outputFormat?: string;
|
|
1544
1588
|
regionId?: string;
|
|
@@ -3228,6 +3272,50 @@ export declare class ModifyAlarmResponse extends $tea.Model {
|
|
|
3228
3272
|
[key: string]: any;
|
|
3229
3273
|
});
|
|
3230
3274
|
}
|
|
3275
|
+
export declare class ModifyAlertConfigurationRequest extends $tea.Model {
|
|
3276
|
+
ownerId?: number;
|
|
3277
|
+
regionId?: string;
|
|
3278
|
+
resourceOwnerAccount?: string;
|
|
3279
|
+
scaleStatuses?: string[];
|
|
3280
|
+
scalingGroupId?: string;
|
|
3281
|
+
static names(): {
|
|
3282
|
+
[key: string]: string;
|
|
3283
|
+
};
|
|
3284
|
+
static types(): {
|
|
3285
|
+
[key: string]: any;
|
|
3286
|
+
};
|
|
3287
|
+
constructor(map?: {
|
|
3288
|
+
[key: string]: any;
|
|
3289
|
+
});
|
|
3290
|
+
}
|
|
3291
|
+
export declare class ModifyAlertConfigurationResponseBody extends $tea.Model {
|
|
3292
|
+
requestId?: string;
|
|
3293
|
+
static names(): {
|
|
3294
|
+
[key: string]: string;
|
|
3295
|
+
};
|
|
3296
|
+
static types(): {
|
|
3297
|
+
[key: string]: any;
|
|
3298
|
+
};
|
|
3299
|
+
constructor(map?: {
|
|
3300
|
+
[key: string]: any;
|
|
3301
|
+
});
|
|
3302
|
+
}
|
|
3303
|
+
export declare class ModifyAlertConfigurationResponse extends $tea.Model {
|
|
3304
|
+
headers?: {
|
|
3305
|
+
[key: string]: string;
|
|
3306
|
+
};
|
|
3307
|
+
statusCode?: number;
|
|
3308
|
+
body?: ModifyAlertConfigurationResponseBody;
|
|
3309
|
+
static names(): {
|
|
3310
|
+
[key: string]: string;
|
|
3311
|
+
};
|
|
3312
|
+
static types(): {
|
|
3313
|
+
[key: string]: any;
|
|
3314
|
+
};
|
|
3315
|
+
constructor(map?: {
|
|
3316
|
+
[key: string]: any;
|
|
3317
|
+
});
|
|
3318
|
+
}
|
|
3231
3319
|
export declare class ModifyEciScalingConfigurationRequest extends $tea.Model {
|
|
3232
3320
|
acrRegistryInfos?: ModifyEciScalingConfigurationRequestAcrRegistryInfos[];
|
|
3233
3321
|
activeDeadlineSeconds?: number;
|
|
@@ -3493,6 +3581,7 @@ export declare class ModifyScalingConfigurationRequest extends $tea.Model {
|
|
|
3493
3581
|
override?: boolean;
|
|
3494
3582
|
ownerAccount?: string;
|
|
3495
3583
|
ownerId?: number;
|
|
3584
|
+
password?: string;
|
|
3496
3585
|
passwordInherit?: boolean;
|
|
3497
3586
|
ramRoleName?: string;
|
|
3498
3587
|
resourceGroupId?: string;
|
|
@@ -3559,6 +3648,7 @@ export declare class ModifyScalingConfigurationShrinkRequest extends $tea.Model
|
|
|
3559
3648
|
override?: boolean;
|
|
3560
3649
|
ownerAccount?: string;
|
|
3561
3650
|
ownerId?: number;
|
|
3651
|
+
password?: string;
|
|
3562
3652
|
passwordInherit?: boolean;
|
|
3563
3653
|
ramRoleName?: string;
|
|
3564
3654
|
resourceGroupId?: string;
|
|
@@ -6574,6 +6664,7 @@ export declare class DescribeScalingConfigurationsResponseBodyScalingConfigurati
|
|
|
6574
6664
|
memory?: number;
|
|
6575
6665
|
networkInterfaces?: DescribeScalingConfigurationsResponseBodyScalingConfigurationsNetworkInterfaces[];
|
|
6576
6666
|
passwordInherit?: boolean;
|
|
6667
|
+
passwordSetted?: boolean;
|
|
6577
6668
|
privatePoolOptions_id?: string;
|
|
6578
6669
|
privatePoolOptions_matchCriteria?: string;
|
|
6579
6670
|
ramRoleName?: string;
|
|
@@ -8219,10 +8310,11 @@ export default class Client extends OpenApi {
|
|
|
8219
8310
|
[key: string]: string;
|
|
8220
8311
|
}, endpoint: string): string;
|
|
8221
8312
|
/**
|
|
8222
|
-
* @summary
|
|
8313
|
+
* @summary Applies a scaling configuration of the Elastic Container Instance type. If you want to create and manage scaling configurations of the Elastic Container Instance type by using a configuration file, you can call the ApplyEciScalingConfiguration operation.
|
|
8223
8314
|
*
|
|
8224
|
-
* @description
|
|
8225
|
-
* If you
|
|
8315
|
+
* @description Before you use a YAML configuration file to manage scaling configurations of the Elastic Container Instance type, you must take note of the following items:
|
|
8316
|
+
* * If you include a scaling configuration ID within your request, the system updates the scaling configuration based on the YAML configuration file.
|
|
8317
|
+
* * If you do not include a scaling configuration ID within your request, the system creates a scaling configuration of the Elastic Container Instance type based on the YAML configuration file.
|
|
8226
8318
|
*
|
|
8227
8319
|
* @param request ApplyEciScalingConfigurationRequest
|
|
8228
8320
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8230,10 +8322,11 @@ export default class Client extends OpenApi {
|
|
|
8230
8322
|
*/
|
|
8231
8323
|
applyEciScalingConfigurationWithOptions(request: ApplyEciScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ApplyEciScalingConfigurationResponse>;
|
|
8232
8324
|
/**
|
|
8233
|
-
* @summary
|
|
8325
|
+
* @summary Applies a scaling configuration of the Elastic Container Instance type. If you want to create and manage scaling configurations of the Elastic Container Instance type by using a configuration file, you can call the ApplyEciScalingConfiguration operation.
|
|
8234
8326
|
*
|
|
8235
|
-
* @description
|
|
8236
|
-
* If you
|
|
8327
|
+
* @description Before you use a YAML configuration file to manage scaling configurations of the Elastic Container Instance type, you must take note of the following items:
|
|
8328
|
+
* * If you include a scaling configuration ID within your request, the system updates the scaling configuration based on the YAML configuration file.
|
|
8329
|
+
* * If you do not include a scaling configuration ID within your request, the system creates a scaling configuration of the Elastic Container Instance type based on the YAML configuration file.
|
|
8237
8330
|
*
|
|
8238
8331
|
* @param request ApplyEciScalingConfigurationRequest
|
|
8239
8332
|
* @return ApplyEciScalingConfigurationResponse
|
|
@@ -8373,7 +8466,7 @@ export default class Client extends OpenApi {
|
|
|
8373
8466
|
*/
|
|
8374
8467
|
attachDBInstances(request: AttachDBInstancesRequest): Promise<AttachDBInstancesResponse>;
|
|
8375
8468
|
/**
|
|
8376
|
-
* @summary Adds instances to a scaling group. You can call the AttachInstances operation to add
|
|
8469
|
+
* @summary Adds instances to a scaling group to provide services or restarts Elastic Compute Service (ECS) instances stopped in Economical Mode to provide services. You can call the AttachInstances operation to add ECS instances, elastic container instances, or third-party instances managed by Alibaba Cloud to your scaling group to provide services. You can also call this operation to restart ECS instances stopped in Economical Mode in your scaling group to provide services.
|
|
8377
8470
|
*
|
|
8378
8471
|
* @description Before you call this operation, take note of the following items:
|
|
8379
8472
|
* * The scaling group is in the Active state.
|
|
@@ -8396,7 +8489,7 @@ export default class Client extends OpenApi {
|
|
|
8396
8489
|
*/
|
|
8397
8490
|
attachInstancesWithOptions(request: AttachInstancesRequest, runtime: $Util.RuntimeOptions): Promise<AttachInstancesResponse>;
|
|
8398
8491
|
/**
|
|
8399
|
-
* @summary Adds instances to a scaling group. You can call the AttachInstances operation to add
|
|
8492
|
+
* @summary Adds instances to a scaling group to provide services or restarts Elastic Compute Service (ECS) instances stopped in Economical Mode to provide services. You can call the AttachInstances operation to add ECS instances, elastic container instances, or third-party instances managed by Alibaba Cloud to your scaling group to provide services. You can also call this operation to restart ECS instances stopped in Economical Mode in your scaling group to provide services.
|
|
8400
8493
|
*
|
|
8401
8494
|
* @description Before you call this operation, take note of the following items:
|
|
8402
8495
|
* * The scaling group is in the Active state.
|
|
@@ -8599,7 +8692,7 @@ export default class Client extends OpenApi {
|
|
|
8599
8692
|
*/
|
|
8600
8693
|
createEciScalingConfiguration(request: CreateEciScalingConfigurationRequest): Promise<CreateEciScalingConfigurationResponse>;
|
|
8601
8694
|
/**
|
|
8602
|
-
* @summary Creates one or more lifecycle hooks.
|
|
8695
|
+
* @summary Creates one or more lifecycle hooks in a scaling group. A lifecycle hook allows you to execute custom actions like sending notifications or automating script execution at critical stages (such as instance startup and termination) in the lifecycle of an instance. Implementing the lifecycle hook feature allows for finer control and management of instances. For example, you can verify configurations, set up custom tasks, or back up data on your instances when lifecycle hooks take effect, thus enhancing the flexibility and reliability of application deployment.
|
|
8603
8696
|
*
|
|
8604
8697
|
* @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.
|
|
8605
8698
|
* 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.
|
|
@@ -8612,7 +8705,7 @@ export default class Client extends OpenApi {
|
|
|
8612
8705
|
*/
|
|
8613
8706
|
createLifecycleHookWithOptions(request: CreateLifecycleHookRequest, runtime: $Util.RuntimeOptions): Promise<CreateLifecycleHookResponse>;
|
|
8614
8707
|
/**
|
|
8615
|
-
* @summary Creates one or more lifecycle hooks.
|
|
8708
|
+
* @summary Creates one or more lifecycle hooks in a scaling group. A lifecycle hook allows you to execute custom actions like sending notifications or automating script execution at critical stages (such as instance startup and termination) in the lifecycle of an instance. Implementing the lifecycle hook feature allows for finer control and management of instances. For example, you can verify configurations, set up custom tasks, or back up data on your instances when lifecycle hooks take effect, thus enhancing the flexibility and reliability of application deployment.
|
|
8616
8709
|
*
|
|
8617
8710
|
* @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.
|
|
8618
8711
|
* 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.
|
|
@@ -8676,27 +8769,27 @@ export default class Client extends OpenApi {
|
|
|
8676
8769
|
*/
|
|
8677
8770
|
createScalingConfiguration(request: CreateScalingConfigurationRequest): Promise<CreateScalingConfigurationResponse>;
|
|
8678
8771
|
/**
|
|
8679
|
-
* @summary Creates a scaling group.
|
|
8680
|
-
*
|
|
8681
|
-
* @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used
|
|
8682
|
-
* You can create only a limited number of scaling groups in a region.
|
|
8683
|
-
* A scaling group does not immediately take effect after you create the scaling group. You
|
|
8684
|
-
*
|
|
8685
|
-
* If you
|
|
8686
|
-
* * Default server group:
|
|
8687
|
-
* * vServer group: If you want to forward requests to backend servers
|
|
8688
|
-
* >
|
|
8689
|
-
* The default weight of
|
|
8690
|
-
* * The CLB instance
|
|
8691
|
-
* *
|
|
8692
|
-
* If you
|
|
8693
|
-
* If you
|
|
8694
|
-
* * The ApsaraDB RDS instance
|
|
8695
|
-
* * The number of IP addresses in the IP address whitelist of the ApsaraDB RDS instance
|
|
8696
|
-
* If you set
|
|
8697
|
-
* *
|
|
8698
|
-
* * If you do not specify
|
|
8699
|
-
* If you set
|
|
8772
|
+
* @summary Creates a scaling group. You can call the CreateScalingGroup operation to automate the adjustment of computing power of a specific type based on your business requirements and scaling polices.
|
|
8773
|
+
*
|
|
8774
|
+
* @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used for similar purposes.
|
|
8775
|
+
* You can create only a limited number of scaling groups in a region. To check the quota of the scaling groups, go to Quota Center.
|
|
8776
|
+
* A scaling group does not immediately take effect after you create the scaling group. You can call the [EnableScalingGroup](https://help.aliyun.com/document_detail/25939.html) operation to enable a scaling group. You can trigger scaling events and execute scaling rules only in scaling groups that are in the Enabled state.
|
|
8777
|
+
* If you want to attach a Classic Load Balancer (CLB, formerly known as SLB) instance and an ApsaraDB RDS instance to the scaling group that you want to create, the scaling group, the CLB instance, and the ApsaraDB RDS instance must reside in the same region. For more information, see [Regions and zones](https://help.aliyun.com/document_detail/40654.html).
|
|
8778
|
+
* If you attach a CLB instance to the scaling group that you want to create, Auto Scaling will automatically add the ECS instances in the scaling group to the backend server groups of the CLB instance. You can specify the following types of server groups to add ECS instances:
|
|
8779
|
+
* * Default server group: ECS instances in this group process frontend requests. If no listeners are configured for vServer groups or primary/secondary server groups, the frontend requests are forwarded to the ECS instances in the default server group.
|
|
8780
|
+
* * vServer group: If you want to forward different requests to different backend servers, or you want to forward requests based on domain names and URLs, you can specify vServer groups.
|
|
8781
|
+
* > If you specify both the default server group and multiple server groups simultaneously, Auto Scaling will add the ECS instances in your scaling group to these server groups concurrently.
|
|
8782
|
+
* The default weight of each ECS instance as a backend server is 50. If you want to attach a CLB instance to the scaling group that you want to create, make sure that the CLB instance meets the following requirements:
|
|
8783
|
+
* * The CLB instance is in the Active state. You can call the [DescribeLoadBalancers](https://help.aliyun.com/document_detail/2401696.html) operation to query the status of CLB instances.
|
|
8784
|
+
* * Health check must be enabled on all listener ports configured for the CLB instance. Otherwise, the scaling group will fail to be created.
|
|
8785
|
+
* If you attach Application Load Balancer (ALB) or Network Load Balancer (NLB) server groups to the scaling group that you want to create, Auto Scaling will add the ECS instances in your scaling group to the ALB or NLB server groups to process the access requests forwarded by the corresponding ALB or NLB instances. You can attach multiple ALB or NLB server groups to a scaling group. Make sure that the ALB or NLB server groups belong to the same virtual private cloud (VPC). For more information, see [AttachAlbServerGroups](https://help.aliyun.com/document_detail/266800.html) or [AttachServerGroups](https://help.aliyun.com/document_detail/600559.html).
|
|
8786
|
+
* If you attach an ApsaraDB RDS instance to the scaling group that you want to create, Auto Scaling will automatically add the private IP addresses of the ECS instances in your scaling group to the IP address whitelist of the ApsaraDB RDS instance. Before you attach an ApsaraDB RDS instance to your scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
|
|
8787
|
+
* * The ApsaraDB RDS instance is in the Running state. You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/610396.html) state to query the status of ApsaraDB RDS instances.
|
|
8788
|
+
* * The number of IP addresses in the IP address whitelist of the ApsaraDB RDS instance does not reach its upper limit. For more information, see [Configure a whitelist](https://help.aliyun.com/document_detail/43185.html).
|
|
8789
|
+
* If you set MultiAZPolicy for the scaling group that you want to create to COST_OPTIMIZED, the following rules apply:
|
|
8790
|
+
* * If you use OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, and SpotInstancePools to specify the instance allocation mode under the cost optimization policy, Auto Scaling will prioritize the implementation of the specified instance allocation mode during scale-out events.
|
|
8791
|
+
* * If you do not specify OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, or SpotInstancePools, Auto Scaling will preferentially create instances of the lowest-priced instance type based on the cost optimization policy.
|
|
8792
|
+
* If you set `Tags.Propagate` to true, the following rules will apply:
|
|
8700
8793
|
* * 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.
|
|
8701
8794
|
* * 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.
|
|
8702
8795
|
* * 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.
|
|
@@ -8707,27 +8800,27 @@ export default class Client extends OpenApi {
|
|
|
8707
8800
|
*/
|
|
8708
8801
|
createScalingGroupWithOptions(request: CreateScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateScalingGroupResponse>;
|
|
8709
8802
|
/**
|
|
8710
|
-
* @summary Creates a scaling group.
|
|
8711
|
-
*
|
|
8712
|
-
* @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used
|
|
8713
|
-
* You can create only a limited number of scaling groups in a region.
|
|
8714
|
-
* A scaling group does not immediately take effect after you create the scaling group. You
|
|
8715
|
-
*
|
|
8716
|
-
* If you
|
|
8717
|
-
* * Default server group:
|
|
8718
|
-
* * vServer group: If you want to forward requests to backend servers
|
|
8719
|
-
* >
|
|
8720
|
-
* The default weight of
|
|
8721
|
-
* * The CLB instance
|
|
8722
|
-
* *
|
|
8723
|
-
* If you
|
|
8724
|
-
* If you
|
|
8725
|
-
* * The ApsaraDB RDS instance
|
|
8726
|
-
* * The number of IP addresses in the IP address whitelist of the ApsaraDB RDS instance
|
|
8727
|
-
* If you set
|
|
8728
|
-
* *
|
|
8729
|
-
* * If you do not specify
|
|
8730
|
-
* If you set
|
|
8803
|
+
* @summary Creates a scaling group. You can call the CreateScalingGroup operation to automate the adjustment of computing power of a specific type based on your business requirements and scaling polices.
|
|
8804
|
+
*
|
|
8805
|
+
* @description A scaling group is a group of Elastic Compute Service (ECS) instances that can be used for similar purposes.
|
|
8806
|
+
* You can create only a limited number of scaling groups in a region. To check the quota of the scaling groups, go to Quota Center.
|
|
8807
|
+
* A scaling group does not immediately take effect after you create the scaling group. You can call the [EnableScalingGroup](https://help.aliyun.com/document_detail/25939.html) operation to enable a scaling group. You can trigger scaling events and execute scaling rules only in scaling groups that are in the Enabled state.
|
|
8808
|
+
* If you want to attach a Classic Load Balancer (CLB, formerly known as SLB) instance and an ApsaraDB RDS instance to the scaling group that you want to create, the scaling group, the CLB instance, and the ApsaraDB RDS instance must reside in the same region. For more information, see [Regions and zones](https://help.aliyun.com/document_detail/40654.html).
|
|
8809
|
+
* If you attach a CLB instance to the scaling group that you want to create, Auto Scaling will automatically add the ECS instances in the scaling group to the backend server groups of the CLB instance. You can specify the following types of server groups to add ECS instances:
|
|
8810
|
+
* * Default server group: ECS instances in this group process frontend requests. If no listeners are configured for vServer groups or primary/secondary server groups, the frontend requests are forwarded to the ECS instances in the default server group.
|
|
8811
|
+
* * vServer group: If you want to forward different requests to different backend servers, or you want to forward requests based on domain names and URLs, you can specify vServer groups.
|
|
8812
|
+
* > If you specify both the default server group and multiple server groups simultaneously, Auto Scaling will add the ECS instances in your scaling group to these server groups concurrently.
|
|
8813
|
+
* The default weight of each ECS instance as a backend server is 50. If you want to attach a CLB instance to the scaling group that you want to create, make sure that the CLB instance meets the following requirements:
|
|
8814
|
+
* * The CLB instance is in the Active state. You can call the [DescribeLoadBalancers](https://help.aliyun.com/document_detail/2401696.html) operation to query the status of CLB instances.
|
|
8815
|
+
* * Health check must be enabled on all listener ports configured for the CLB instance. Otherwise, the scaling group will fail to be created.
|
|
8816
|
+
* If you attach Application Load Balancer (ALB) or Network Load Balancer (NLB) server groups to the scaling group that you want to create, Auto Scaling will add the ECS instances in your scaling group to the ALB or NLB server groups to process the access requests forwarded by the corresponding ALB or NLB instances. You can attach multiple ALB or NLB server groups to a scaling group. Make sure that the ALB or NLB server groups belong to the same virtual private cloud (VPC). For more information, see [AttachAlbServerGroups](https://help.aliyun.com/document_detail/266800.html) or [AttachServerGroups](https://help.aliyun.com/document_detail/600559.html).
|
|
8817
|
+
* If you attach an ApsaraDB RDS instance to the scaling group that you want to create, Auto Scaling will automatically add the private IP addresses of the ECS instances in your scaling group to the IP address whitelist of the ApsaraDB RDS instance. Before you attach an ApsaraDB RDS instance to your scaling group, make sure that the ApsaraDB RDS instance meets the following requirements:
|
|
8818
|
+
* * The ApsaraDB RDS instance is in the Running state. You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/610396.html) state to query the status of ApsaraDB RDS instances.
|
|
8819
|
+
* * The number of IP addresses in the IP address whitelist of the ApsaraDB RDS instance does not reach its upper limit. For more information, see [Configure a whitelist](https://help.aliyun.com/document_detail/43185.html).
|
|
8820
|
+
* If you set MultiAZPolicy for the scaling group that you want to create to COST_OPTIMIZED, the following rules apply:
|
|
8821
|
+
* * If you use OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, and SpotInstancePools to specify the instance allocation mode under the cost optimization policy, Auto Scaling will prioritize the implementation of the specified instance allocation mode during scale-out events.
|
|
8822
|
+
* * If you do not specify OnDemandBaseCapacity, OnDemandPercentageAboveBaseCapacity, or SpotInstancePools, Auto Scaling will preferentially create instances of the lowest-priced instance type based on the cost optimization policy.
|
|
8823
|
+
* If you set `Tags.Propagate` to true, the following rules will apply:
|
|
8731
8824
|
* * 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.
|
|
8732
8825
|
* * 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.
|
|
8733
8826
|
* * 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.
|
|
@@ -8737,21 +8830,20 @@ export default class Client extends OpenApi {
|
|
|
8737
8830
|
*/
|
|
8738
8831
|
createScalingGroup(request: CreateScalingGroupRequest): Promise<CreateScalingGroupResponse>;
|
|
8739
8832
|
/**
|
|
8740
|
-
* @summary Creates a scaling rule.
|
|
8833
|
+
* @summary Creates a scaling rule. The purpose of a scaling rule varies based on its type. You can use a scaling rule to trigger a scaling activity or adjust the boundary values for a scaling group. You can call the CreateScalingRule operation to create different types of scaling rules based on your business requirements. For example, if your business requires only automatic adjustment of the boundary values for your scaling group, you can call this operation to create a predictive scaling rule.
|
|
8741
8834
|
*
|
|
8742
|
-
* @description
|
|
8743
|
-
*
|
|
8744
|
-
* *
|
|
8745
|
-
* * 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.
|
|
8835
|
+
* @description A scaling rule defines the specific scaling action. For example, you can use a scaling rule to define N instances to add or remove. If the execution of a scaling rule causes the total number of Elastic Compute Service (ECS) instances or elastic container instances in the scaling group to drop below the value of MinSize or to exceed the value of MaxSize, Auto Scaling adjusts the number of instances to add or remove, which ensures that the total number of instances stays within the valid range. Take note that Auto Scaling does not adjust the number of instances that you defined in the scaling rule. Examples:
|
|
8836
|
+
* * The maximum number of instances (MaxSize) that can be contained in a scaling group is 3 and the current number of instances (Total Capacity) in the scaling group is 2. In this example, the Add3 scaling rule is created to add three ECS instances to the scaling group. However, after you execute Add3, Auto Scaling adds only one ECS instance to the scaling group. In addition, the number of ECS instances to add in the Add3 scaling rule remains unchanged.
|
|
8837
|
+
* * The minimum number of instances (MinSize) that must be contained in a scaling group is 2 and the current number of instances (Total Capacity) is 3. In this example, the Remove5 scaling rule is created to remove five ECS instances from the scaling group. However, after you execute Remove5, Auto Scaling only removes one ECS instance from the scaling group. In addition, the number of ECS instances to remove in the Remove5 scaling rule remains unchanged.
|
|
8746
8838
|
* Before you call this operation, take note of the following items:
|
|
8747
|
-
* * If you set
|
|
8748
|
-
* * If you set
|
|
8749
|
-
* * If you set
|
|
8750
|
-
* * If
|
|
8751
|
-
* * You can create only a limited number of scaling rules for a scaling group. For more information, see
|
|
8752
|
-
* * The unique identifier
|
|
8753
|
-
* * ExecuteScalingRule: You can call this operation to manually execute a
|
|
8754
|
-
* * CreateScheduledTask: You can call this operation to create a scheduled task for a
|
|
8839
|
+
* * If you set AdjustmentType to TotalCapacity, the total number of ECS instances or elastic container instances in your scaling group will be adjusted to a specified number when the scaling rule that you create by calling this operation is executed. You must set AdjustmentValue to an integer that is greater than 0.
|
|
8840
|
+
* * If you set AdjustmentType to QuantityChangeInCapacity or PercentChangeInCapacity, a positive value of AdjustmentValue specifies that a specific number of ECS instances or elastic container instances will be added to your scaling group, and a negative value of AdjustmentValue specifies that a specific number of ECS instances or elastic container instances will be removed from the scaling group.
|
|
8841
|
+
* * If you set AdjustmentType to PercentChangeInCapacity, Auto Scaling calculates the number of ECS instances or elastic container instances to add or remove by multiplying the current capacity of the scaling group (Total Capacity) by AdjustmentValue divided by 100, rounding off the result to determine the final adjustment count.
|
|
8842
|
+
* * If you specify a cooldown period for a scaling rule, the cooldown period of the scaling rule takes effect after you execute the scaling rule. If you do not specify a cooldown period for a scaling rule, the value of DefaultCooldown of the scaling group takes effect after you execute the scaling rule.
|
|
8843
|
+
* * You can create only a limited number of scaling rules for a scaling group. For more information, see [Limits](https://help.aliyun.com/document_detail/25863.html).
|
|
8844
|
+
* * The following API operations may use the unique identifier of a scaling rule (ScalingRuleAri) that is returned after you call the CreateScalingRule operation:
|
|
8845
|
+
* * ExecuteScalingRule: You can call this operation to manually execute a scaling rule. In this operation, you can set ScalingRuleAri to the unique identifier of the scaling rule that you want to execute.
|
|
8846
|
+
* * CreateScheduledTask: You can call this operation to create a scheduled task for a scaling rule. In this operation, you can set ScalingRuleAri to the unique identifier of the scaling rule for which you want to create a scheduled task.
|
|
8755
8847
|
*
|
|
8756
8848
|
* @param request CreateScalingRuleRequest
|
|
8757
8849
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8759,21 +8851,20 @@ export default class Client extends OpenApi {
|
|
|
8759
8851
|
*/
|
|
8760
8852
|
createScalingRuleWithOptions(request: CreateScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<CreateScalingRuleResponse>;
|
|
8761
8853
|
/**
|
|
8762
|
-
* @summary Creates a scaling rule.
|
|
8854
|
+
* @summary Creates a scaling rule. The purpose of a scaling rule varies based on its type. You can use a scaling rule to trigger a scaling activity or adjust the boundary values for a scaling group. You can call the CreateScalingRule operation to create different types of scaling rules based on your business requirements. For example, if your business requires only automatic adjustment of the boundary values for your scaling group, you can call this operation to create a predictive scaling rule.
|
|
8763
8855
|
*
|
|
8764
|
-
* @description
|
|
8765
|
-
*
|
|
8766
|
-
* *
|
|
8767
|
-
* * 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.
|
|
8856
|
+
* @description A scaling rule defines the specific scaling action. For example, you can use a scaling rule to define N instances to add or remove. If the execution of a scaling rule causes the total number of Elastic Compute Service (ECS) instances or elastic container instances in the scaling group to drop below the value of MinSize or to exceed the value of MaxSize, Auto Scaling adjusts the number of instances to add or remove, which ensures that the total number of instances stays within the valid range. Take note that Auto Scaling does not adjust the number of instances that you defined in the scaling rule. Examples:
|
|
8857
|
+
* * The maximum number of instances (MaxSize) that can be contained in a scaling group is 3 and the current number of instances (Total Capacity) in the scaling group is 2. In this example, the Add3 scaling rule is created to add three ECS instances to the scaling group. However, after you execute Add3, Auto Scaling adds only one ECS instance to the scaling group. In addition, the number of ECS instances to add in the Add3 scaling rule remains unchanged.
|
|
8858
|
+
* * The minimum number of instances (MinSize) that must be contained in a scaling group is 2 and the current number of instances (Total Capacity) is 3. In this example, the Remove5 scaling rule is created to remove five ECS instances from the scaling group. However, after you execute Remove5, Auto Scaling only removes one ECS instance from the scaling group. In addition, the number of ECS instances to remove in the Remove5 scaling rule remains unchanged.
|
|
8768
8859
|
* Before you call this operation, take note of the following items:
|
|
8769
|
-
* * If you set
|
|
8770
|
-
* * If you set
|
|
8771
|
-
* * If you set
|
|
8772
|
-
* * If
|
|
8773
|
-
* * You can create only a limited number of scaling rules for a scaling group. For more information, see
|
|
8774
|
-
* * The unique identifier
|
|
8775
|
-
* * ExecuteScalingRule: You can call this operation to manually execute a
|
|
8776
|
-
* * CreateScheduledTask: You can call this operation to create a scheduled task for a
|
|
8860
|
+
* * If you set AdjustmentType to TotalCapacity, the total number of ECS instances or elastic container instances in your scaling group will be adjusted to a specified number when the scaling rule that you create by calling this operation is executed. You must set AdjustmentValue to an integer that is greater than 0.
|
|
8861
|
+
* * If you set AdjustmentType to QuantityChangeInCapacity or PercentChangeInCapacity, a positive value of AdjustmentValue specifies that a specific number of ECS instances or elastic container instances will be added to your scaling group, and a negative value of AdjustmentValue specifies that a specific number of ECS instances or elastic container instances will be removed from the scaling group.
|
|
8862
|
+
* * If you set AdjustmentType to PercentChangeInCapacity, Auto Scaling calculates the number of ECS instances or elastic container instances to add or remove by multiplying the current capacity of the scaling group (Total Capacity) by AdjustmentValue divided by 100, rounding off the result to determine the final adjustment count.
|
|
8863
|
+
* * If you specify a cooldown period for a scaling rule, the cooldown period of the scaling rule takes effect after you execute the scaling rule. If you do not specify a cooldown period for a scaling rule, the value of DefaultCooldown of the scaling group takes effect after you execute the scaling rule.
|
|
8864
|
+
* * You can create only a limited number of scaling rules for a scaling group. For more information, see [Limits](https://help.aliyun.com/document_detail/25863.html).
|
|
8865
|
+
* * The following API operations may use the unique identifier of a scaling rule (ScalingRuleAri) that is returned after you call the CreateScalingRule operation:
|
|
8866
|
+
* * ExecuteScalingRule: You can call this operation to manually execute a scaling rule. In this operation, you can set ScalingRuleAri to the unique identifier of the scaling rule that you want to execute.
|
|
8867
|
+
* * CreateScheduledTask: You can call this operation to create a scheduled task for a scaling rule. In this operation, you can set ScalingRuleAri to the unique identifier of the scaling rule for which you want to create a scheduled task.
|
|
8777
8868
|
*
|
|
8778
8869
|
* @param request CreateScalingRuleRequest
|
|
8779
8870
|
* @return CreateScalingRuleResponse
|
|
@@ -8782,12 +8873,15 @@ export default class Client extends OpenApi {
|
|
|
8782
8873
|
/**
|
|
8783
8874
|
* @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.
|
|
8784
8875
|
*
|
|
8785
|
-
* @description * If a scheduled task fails to
|
|
8786
|
-
* * If
|
|
8787
|
-
*
|
|
8788
|
-
* *
|
|
8789
|
-
*
|
|
8790
|
-
*
|
|
8876
|
+
* @description * If the scaling rule of a scheduled task fails to be executed due to an ongoing scaling activity in the scaling group or because the scaling group is disabled, the scheduled task is automatically retried during the time window specified by `LaunchExpirationTime`. If the scheduled task still fails after the specified time window ends, the task is automatically skipped.
|
|
8877
|
+
* * If several scheduled tasks concurrently attempt to execute the same scaling rule within a scaling group, the following rules apply:
|
|
8878
|
+
* * Scaling groups with **Expected Number of Instances** configured: The scaling activities incurred by the scheduled tasks are parallel scaling activities. In a proximate time window, Auto Scaling can trigger several scheduled tasks and then execute multiple parallel scaling activities at the same time.
|
|
8879
|
+
* * Scaling groups with **Expected Number of Instances** not configured: The scaling activity incurred by the earliest scheduled task is executed. Considering that a scaling group allows for no more than one ongoing scaling activity simultaneously, other scheduled tasks will spontaneously invoke retries within the time window specified by `LaunchExpirationTime`. Upon completion of the first scheduled task, any retries invoked by other tasks within the time window specified by `LaunchExpirationTime` lead to continuous enforcement of the scaling rule, with each iteration generating a distinct scaling activity.
|
|
8880
|
+
* * You can use one of the following methods to specify the scaling mode:
|
|
8881
|
+
* * ScheduledAction: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
|
|
8882
|
+
* * ScalingGroupId: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you create the scheduled task.
|
|
8883
|
+
* **
|
|
8884
|
+
* **Note** You cannot specify ScheduledAction and ScalingGroupId at the same time.
|
|
8791
8885
|
*
|
|
8792
8886
|
* @param request CreateScheduledTaskRequest
|
|
8793
8887
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8797,12 +8891,15 @@ export default class Client extends OpenApi {
|
|
|
8797
8891
|
/**
|
|
8798
8892
|
* @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.
|
|
8799
8893
|
*
|
|
8800
|
-
* @description * If a scheduled task fails to
|
|
8801
|
-
* * If
|
|
8802
|
-
*
|
|
8803
|
-
* *
|
|
8804
|
-
*
|
|
8805
|
-
*
|
|
8894
|
+
* @description * If the scaling rule of a scheduled task fails to be executed due to an ongoing scaling activity in the scaling group or because the scaling group is disabled, the scheduled task is automatically retried during the time window specified by `LaunchExpirationTime`. If the scheduled task still fails after the specified time window ends, the task is automatically skipped.
|
|
8895
|
+
* * If several scheduled tasks concurrently attempt to execute the same scaling rule within a scaling group, the following rules apply:
|
|
8896
|
+
* * Scaling groups with **Expected Number of Instances** configured: The scaling activities incurred by the scheduled tasks are parallel scaling activities. In a proximate time window, Auto Scaling can trigger several scheduled tasks and then execute multiple parallel scaling activities at the same time.
|
|
8897
|
+
* * Scaling groups with **Expected Number of Instances** not configured: The scaling activity incurred by the earliest scheduled task is executed. Considering that a scaling group allows for no more than one ongoing scaling activity simultaneously, other scheduled tasks will spontaneously invoke retries within the time window specified by `LaunchExpirationTime`. Upon completion of the first scheduled task, any retries invoked by other tasks within the time window specified by `LaunchExpirationTime` lead to continuous enforcement of the scaling rule, with each iteration generating a distinct scaling activity.
|
|
8898
|
+
* * You can use one of the following methods to specify the scaling mode:
|
|
8899
|
+
* * ScheduledAction: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
|
|
8900
|
+
* * ScalingGroupId: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you create the scheduled task.
|
|
8901
|
+
* **
|
|
8902
|
+
* **Note** You cannot specify ScheduledAction and ScalingGroupId at the same time.
|
|
8806
8903
|
*
|
|
8807
8904
|
* @param request CreateScheduledTaskRequest
|
|
8808
8905
|
* @return CreateScheduledTaskResponse
|
|
@@ -8866,11 +8963,11 @@ export default class Client extends OpenApi {
|
|
|
8866
8963
|
*/
|
|
8867
8964
|
deleteEciScalingConfiguration(request: DeleteEciScalingConfigurationRequest): Promise<DeleteEciScalingConfigurationResponse>;
|
|
8868
8965
|
/**
|
|
8869
|
-
* @summary Deletes a lifecycle hook.
|
|
8966
|
+
* @summary Deletes a lifecycle hook. If you no longer require a lifecycle hook, you can call the DeleteLifecycleHook operation to delete it, which frees up the lifecycle hook quota.
|
|
8870
8967
|
*
|
|
8871
|
-
* @description If you delete
|
|
8872
|
-
* *
|
|
8873
|
-
* *
|
|
8968
|
+
* @description If you delete an effective lifecycle hook before its timeout period ends, the instances on which the lifecycle hook takes effect exits the Pending state ahead of schedule. You can use the following methods to delete a lifecycle hook:
|
|
8969
|
+
* * Include `LifecycleHookId` within your request to specify the lifecycle hook that you want to delete. In this case, `ScalingGroupId` and `LifecycleHookName` are ignored.
|
|
8970
|
+
* * Include `ScalingGroupId` and `LifecycleHookName` within your request to specify the lifecycle hook that you want to delete.
|
|
8874
8971
|
*
|
|
8875
8972
|
* @param request DeleteLifecycleHookRequest
|
|
8876
8973
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8878,11 +8975,11 @@ export default class Client extends OpenApi {
|
|
|
8878
8975
|
*/
|
|
8879
8976
|
deleteLifecycleHookWithOptions(request: DeleteLifecycleHookRequest, runtime: $Util.RuntimeOptions): Promise<DeleteLifecycleHookResponse>;
|
|
8880
8977
|
/**
|
|
8881
|
-
* @summary Deletes a lifecycle hook.
|
|
8978
|
+
* @summary Deletes a lifecycle hook. If you no longer require a lifecycle hook, you can call the DeleteLifecycleHook operation to delete it, which frees up the lifecycle hook quota.
|
|
8882
8979
|
*
|
|
8883
|
-
* @description If you delete
|
|
8884
|
-
* *
|
|
8885
|
-
* *
|
|
8980
|
+
* @description If you delete an effective lifecycle hook before its timeout period ends, the instances on which the lifecycle hook takes effect exits the Pending state ahead of schedule. You can use the following methods to delete a lifecycle hook:
|
|
8981
|
+
* * Include `LifecycleHookId` within your request to specify the lifecycle hook that you want to delete. In this case, `ScalingGroupId` and `LifecycleHookName` are ignored.
|
|
8982
|
+
* * Include `ScalingGroupId` and `LifecycleHookName` within your request to specify the lifecycle hook that you want to delete.
|
|
8886
8983
|
*
|
|
8887
8984
|
* @param request DeleteLifecycleHookRequest
|
|
8888
8985
|
* @return DeleteLifecycleHookResponse
|
|
@@ -9009,7 +9106,22 @@ export default class Client extends OpenApi {
|
|
|
9009
9106
|
*/
|
|
9010
9107
|
describeAlarms(request: DescribeAlarmsRequest): Promise<DescribeAlarmsResponse>;
|
|
9011
9108
|
/**
|
|
9012
|
-
* @summary Queries
|
|
9109
|
+
* @summary Queries the status of scaling activities that prompt text message or email notifications.
|
|
9110
|
+
*
|
|
9111
|
+
* @param request DescribeAlertConfigurationRequest
|
|
9112
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
9113
|
+
* @return DescribeAlertConfigurationResponse
|
|
9114
|
+
*/
|
|
9115
|
+
describeAlertConfigurationWithOptions(request: DescribeAlertConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAlertConfigurationResponse>;
|
|
9116
|
+
/**
|
|
9117
|
+
* @summary Queries the status of scaling activities that prompt text message or email notifications.
|
|
9118
|
+
*
|
|
9119
|
+
* @param request DescribeAlertConfigurationRequest
|
|
9120
|
+
* @return DescribeAlertConfigurationResponse
|
|
9121
|
+
*/
|
|
9122
|
+
describeAlertConfiguration(request: DescribeAlertConfigurationRequest): Promise<DescribeAlertConfigurationResponse>;
|
|
9123
|
+
/**
|
|
9124
|
+
* @summary Queries the details of a scaling configuration. You can query a scaling configuration by its ID to learn about its details such as the temporary storage size, number of IPv6 addresses, and bandwidth of the elastic IP address (EIP). The scaling configuration details can be obtained as a YAML file.
|
|
9013
9125
|
*
|
|
9014
9126
|
* @param request DescribeEciScalingConfigurationDetailRequest
|
|
9015
9127
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9017,7 +9129,7 @@ export default class Client extends OpenApi {
|
|
|
9017
9129
|
*/
|
|
9018
9130
|
describeEciScalingConfigurationDetailWithOptions(request: DescribeEciScalingConfigurationDetailRequest, runtime: $Util.RuntimeOptions): Promise<DescribeEciScalingConfigurationDetailResponse>;
|
|
9019
9131
|
/**
|
|
9020
|
-
* @summary Queries
|
|
9132
|
+
* @summary Queries the details of a scaling configuration. You can query a scaling configuration by its ID to learn about its details such as the temporary storage size, number of IPv6 addresses, and bandwidth of the elastic IP address (EIP). The scaling configuration details can be obtained as a YAML file.
|
|
9021
9133
|
*
|
|
9022
9134
|
* @param request DescribeEciScalingConfigurationDetailRequest
|
|
9023
9135
|
* @return DescribeEciScalingConfigurationDetailResponse
|
|
@@ -9039,7 +9151,7 @@ export default class Client extends OpenApi {
|
|
|
9039
9151
|
*/
|
|
9040
9152
|
describeEciScalingConfigurations(request: DescribeEciScalingConfigurationsRequest): Promise<DescribeEciScalingConfigurationsResponse>;
|
|
9041
9153
|
/**
|
|
9042
|
-
* @summary Queries lifecycle
|
|
9154
|
+
* @summary Queries the details of a lifecycle hook. If you want to query the details of a lifecycle hook, you can call the DescribeLifecycleActions operation. For example, you can query the execution status and ID of a lifecycle hook, along with the Elastic Compute Service (ECS) instances on which the lifecycle hook takes effect. When you call this operation, you can specify parameters such as ScalingActivityId, LifecycleActionToken, and MaxResults to query the details of a lifecycle hook.
|
|
9043
9155
|
*
|
|
9044
9156
|
* @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:
|
|
9045
9157
|
* * 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.
|
|
@@ -9053,7 +9165,7 @@ export default class Client extends OpenApi {
|
|
|
9053
9165
|
*/
|
|
9054
9166
|
describeLifecycleActionsWithOptions(request: DescribeLifecycleActionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLifecycleActionsResponse>;
|
|
9055
9167
|
/**
|
|
9056
|
-
* @summary Queries lifecycle
|
|
9168
|
+
* @summary Queries the details of a lifecycle hook. If you want to query the details of a lifecycle hook, you can call the DescribeLifecycleActions operation. For example, you can query the execution status and ID of a lifecycle hook, along with the Elastic Compute Service (ECS) instances on which the lifecycle hook takes effect. When you call this operation, you can specify parameters such as ScalingActivityId, LifecycleActionToken, and MaxResults to query the details of a lifecycle hook.
|
|
9057
9169
|
*
|
|
9058
9170
|
* @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:
|
|
9059
9171
|
* * 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.
|
|
@@ -9066,7 +9178,7 @@ export default class Client extends OpenApi {
|
|
|
9066
9178
|
*/
|
|
9067
9179
|
describeLifecycleActions(request: DescribeLifecycleActionsRequest): Promise<DescribeLifecycleActionsResponse>;
|
|
9068
9180
|
/**
|
|
9069
|
-
* @summary Queries lifecycle hooks.
|
|
9181
|
+
* @summary Queries lifecycle hooks. If you want to check whether the configurations of your lifecycle hooks are correct or you want to query the details of multiple lifecycle hooks at the same time, you can call the DescribeLifecycleHooks operation. You can specify lifecycle hook IDs or scaling group IDs when you call this operation. This operation returns details such as the default actions, scaling activities, Alibaba Cloud Resource Names (ARNs) of notification recipients, and timeout periods of lifecycle hooks.
|
|
9070
9182
|
*
|
|
9071
9183
|
* @description You can use one of the following methods to query lifecycle hooks:
|
|
9072
9184
|
* * 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.
|
|
@@ -9079,7 +9191,7 @@ export default class Client extends OpenApi {
|
|
|
9079
9191
|
*/
|
|
9080
9192
|
describeLifecycleHooksWithOptions(request: DescribeLifecycleHooksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLifecycleHooksResponse>;
|
|
9081
9193
|
/**
|
|
9082
|
-
* @summary Queries lifecycle hooks.
|
|
9194
|
+
* @summary Queries lifecycle hooks. If you want to check whether the configurations of your lifecycle hooks are correct or you want to query the details of multiple lifecycle hooks at the same time, you can call the DescribeLifecycleHooks operation. You can specify lifecycle hook IDs or scaling group IDs when you call this operation. This operation returns details such as the default actions, scaling activities, Alibaba Cloud Resource Names (ARNs) of notification recipients, and timeout periods of lifecycle hooks.
|
|
9083
9195
|
*
|
|
9084
9196
|
* @description You can use one of the following methods to query lifecycle hooks:
|
|
9085
9197
|
* * 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.
|
|
@@ -9106,7 +9218,7 @@ export default class Client extends OpenApi {
|
|
|
9106
9218
|
*/
|
|
9107
9219
|
describeLimitation(request: DescribeLimitationRequest): Promise<DescribeLimitationResponse>;
|
|
9108
9220
|
/**
|
|
9109
|
-
* @summary Queries event
|
|
9221
|
+
* @summary Queries notifications. If you want to learn about a notification regarding the status of a scaling event or resource changes, you can call the DescribeNotificationConfigurations operation. This operation enables you to retrieve notification details, analyze resource change data, and refine scaling policies to efficiently utilize resources and fulfill business needs.
|
|
9110
9222
|
*
|
|
9111
9223
|
* @param request DescribeNotificationConfigurationsRequest
|
|
9112
9224
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9114,14 +9226,14 @@ export default class Client extends OpenApi {
|
|
|
9114
9226
|
*/
|
|
9115
9227
|
describeNotificationConfigurationsWithOptions(request: DescribeNotificationConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeNotificationConfigurationsResponse>;
|
|
9116
9228
|
/**
|
|
9117
|
-
* @summary Queries event
|
|
9229
|
+
* @summary Queries notifications. If you want to learn about a notification regarding the status of a scaling event or resource changes, you can call the DescribeNotificationConfigurations operation. This operation enables you to retrieve notification details, analyze resource change data, and refine scaling policies to efficiently utilize resources and fulfill business needs.
|
|
9118
9230
|
*
|
|
9119
9231
|
* @param request DescribeNotificationConfigurationsRequest
|
|
9120
9232
|
* @return DescribeNotificationConfigurationsResponse
|
|
9121
9233
|
*/
|
|
9122
9234
|
describeNotificationConfigurations(request: DescribeNotificationConfigurationsRequest): Promise<DescribeNotificationConfigurationsResponse>;
|
|
9123
9235
|
/**
|
|
9124
|
-
* @summary Queries notification types.
|
|
9236
|
+
* @summary Queries notification types. You can call the DescribeNotificationTypes operation to query the types of notifications on scaling events or resource changes occurred in your scaling groups. Notifications are triggered in scenarios such as successful scale-out events, successful scale-in events, expiration of scheduled tasks, and partially successful scale-out events.
|
|
9125
9237
|
*
|
|
9126
9238
|
* @param request DescribeNotificationTypesRequest
|
|
9127
9239
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9129,7 +9241,7 @@ export default class Client extends OpenApi {
|
|
|
9129
9241
|
*/
|
|
9130
9242
|
describeNotificationTypesWithOptions(request: DescribeNotificationTypesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeNotificationTypesResponse>;
|
|
9131
9243
|
/**
|
|
9132
|
-
* @summary Queries notification types.
|
|
9244
|
+
* @summary Queries notification types. You can call the DescribeNotificationTypes operation to query the types of notifications on scaling events or resource changes occurred in your scaling groups. Notifications are triggered in scenarios such as successful scale-out events, successful scale-in events, expiration of scheduled tasks, and partially successful scale-out events.
|
|
9133
9245
|
*
|
|
9134
9246
|
* @param request DescribeNotificationTypesRequest
|
|
9135
9247
|
* @return DescribeNotificationTypesResponse
|
|
@@ -9189,7 +9301,7 @@ export default class Client extends OpenApi {
|
|
|
9189
9301
|
*/
|
|
9190
9302
|
describeScalingActivities(request: DescribeScalingActivitiesRequest): Promise<DescribeScalingActivitiesResponse>;
|
|
9191
9303
|
/**
|
|
9192
|
-
* @summary Queries the details
|
|
9304
|
+
* @summary Queries the details of a scaling activity. The DescribeScalingActivityDetail operation enables you to access and monitor the details of a scaling activity, which is beneficial for troubleshooting and performance analysis purposes.
|
|
9193
9305
|
*
|
|
9194
9306
|
* @param request DescribeScalingActivityDetailRequest
|
|
9195
9307
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9197,7 +9309,7 @@ export default class Client extends OpenApi {
|
|
|
9197
9309
|
*/
|
|
9198
9310
|
describeScalingActivityDetailWithOptions(request: DescribeScalingActivityDetailRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingActivityDetailResponse>;
|
|
9199
9311
|
/**
|
|
9200
|
-
* @summary Queries the details
|
|
9312
|
+
* @summary Queries the details of a scaling activity. The DescribeScalingActivityDetail operation enables you to access and monitor the details of a scaling activity, which is beneficial for troubleshooting and performance analysis purposes.
|
|
9201
9313
|
*
|
|
9202
9314
|
* @param request DescribeScalingActivityDetailRequest
|
|
9203
9315
|
* @return DescribeScalingActivityDetailResponse
|
|
@@ -9249,7 +9361,7 @@ export default class Client extends OpenApi {
|
|
|
9249
9361
|
*/
|
|
9250
9362
|
describeScalingGroups(request: DescribeScalingGroupsRequest): Promise<DescribeScalingGroupsResponse>;
|
|
9251
9363
|
/**
|
|
9252
|
-
* @summary Queries the Elastic Compute Service (ECS) instances in a scaling group
|
|
9364
|
+
* @summary Queries the Elastic Compute Service (ECS) instances in a scaling group. If you want to flexibly filter ECS instances that meet the specified criteria and query the instance details, you can call the DescribeScalingInstances operation. This operation enables you to input custom parameters for precise query of ECS instances, helping you gain a clear understanding of the instance details and optimize scaling configurations.
|
|
9253
9365
|
*
|
|
9254
9366
|
* @param request DescribeScalingInstancesRequest
|
|
9255
9367
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9257,7 +9369,7 @@ export default class Client extends OpenApi {
|
|
|
9257
9369
|
*/
|
|
9258
9370
|
describeScalingInstancesWithOptions(request: DescribeScalingInstancesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingInstancesResponse>;
|
|
9259
9371
|
/**
|
|
9260
|
-
* @summary Queries the Elastic Compute Service (ECS) instances in a scaling group
|
|
9372
|
+
* @summary Queries the Elastic Compute Service (ECS) instances in a scaling group. If you want to flexibly filter ECS instances that meet the specified criteria and query the instance details, you can call the DescribeScalingInstances operation. This operation enables you to input custom parameters for precise query of ECS instances, helping you gain a clear understanding of the instance details and optimize scaling configurations.
|
|
9261
9373
|
*
|
|
9262
9374
|
* @param request DescribeScalingInstancesRequest
|
|
9263
9375
|
* @return DescribeScalingInstancesResponse
|
|
@@ -9283,7 +9395,7 @@ export default class Client extends OpenApi {
|
|
|
9283
9395
|
*/
|
|
9284
9396
|
describeScalingRules(request: DescribeScalingRulesRequest): Promise<DescribeScalingRulesResponse>;
|
|
9285
9397
|
/**
|
|
9286
|
-
* @summary Queries scheduled tasks.
|
|
9398
|
+
* @summary Queries scheduled tasks. A scheduled task is a predefined task that triggers the automatic execution of a scaling rule at the specified point in time. It ensures an automatic scaling of computing resources to fulfill your business demands at a minimum cost. After you create a scheduled task, you can call the DescribeScheduledTasks operation to query the details of the task, such as the execution time point and the scaling group ID. You can also call this operation to query the total number of existing scheduled tasks.
|
|
9287
9399
|
*
|
|
9288
9400
|
* @description You can query scheduled tasks by scaling rule, task ID, or task name.
|
|
9289
9401
|
*
|
|
@@ -9293,7 +9405,7 @@ export default class Client extends OpenApi {
|
|
|
9293
9405
|
*/
|
|
9294
9406
|
describeScheduledTasksWithOptions(request: DescribeScheduledTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScheduledTasksResponse>;
|
|
9295
9407
|
/**
|
|
9296
|
-
* @summary Queries scheduled tasks.
|
|
9408
|
+
* @summary Queries scheduled tasks. A scheduled task is a predefined task that triggers the automatic execution of a scaling rule at the specified point in time. It ensures an automatic scaling of computing resources to fulfill your business demands at a minimum cost. After you create a scheduled task, you can call the DescribeScheduledTasks operation to query the details of the task, such as the execution time point and the scaling group ID. You can also call this operation to query the total number of existing scheduled tasks.
|
|
9297
9409
|
*
|
|
9298
9410
|
* @description You can query scheduled tasks by scaling rule, task ID, or task name.
|
|
9299
9411
|
*
|
|
@@ -9332,16 +9444,18 @@ export default class Client extends OpenApi {
|
|
|
9332
9444
|
*/
|
|
9333
9445
|
detachDBInstances(request: DetachDBInstancesRequest): Promise<DetachDBInstancesResponse>;
|
|
9334
9446
|
/**
|
|
9335
|
-
* @summary Removes one or more Elastic Compute Service (ECS) instances
|
|
9447
|
+
* @summary Removes instances from a scaling group. If an enabled scaling group has no ongoing scaling activities, you can call the DetachInstances operation to remove one or more Elastic Compute Service (ECS) instances, elastic container instances, or Alibaba Cloud-hosted third-party instances from the scaling group.
|
|
9336
9448
|
*
|
|
9337
|
-
* @description
|
|
9338
|
-
*
|
|
9339
|
-
*
|
|
9340
|
-
*
|
|
9341
|
-
*
|
|
9342
|
-
*
|
|
9343
|
-
*
|
|
9344
|
-
*
|
|
9449
|
+
* @description * Before you call the DetachInstances operation, make sure that the following conditions are met:
|
|
9450
|
+
* * The specified scaling group is enabled.
|
|
9451
|
+
* * The specified scaling group does not have any ongoing scaling activities.
|
|
9452
|
+
* **
|
|
9453
|
+
* **Note** If the specified scaling group does not have any ongoing scaling activities, the operation can bypass the cooldown period of the scaling group and immediately trigger scaling activities.
|
|
9454
|
+
* * Before you call this operation, take note of the following items:
|
|
9455
|
+
* * The ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances that are removed from a scaling group by using this operation can run independently. If needed, you can call the [AttachInstances](https://help.aliyun.com/document_detail/25954.html) operation to re-add these instances to a scaling group.
|
|
9456
|
+
* * The ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances that are removed from a scaling group by using this operation are not stopped or released.
|
|
9457
|
+
* * A successful call only means that Auto Scaling accepts your request. Scaling activities can be triggered as expected, but their successful execution is not guaranteed. You can query the status of a scaling activity based on the ScalingActivityId response parameter.
|
|
9458
|
+
* * The removal of ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances must not result in the overall number of instances within the specified scaling group falling below the minimum capacity threshold (MinSize); otherwise, an error will be reported.
|
|
9345
9459
|
*
|
|
9346
9460
|
* @param request DetachInstancesRequest
|
|
9347
9461
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9349,23 +9463,25 @@ export default class Client extends OpenApi {
|
|
|
9349
9463
|
*/
|
|
9350
9464
|
detachInstancesWithOptions(request: DetachInstancesRequest, runtime: $Util.RuntimeOptions): Promise<DetachInstancesResponse>;
|
|
9351
9465
|
/**
|
|
9352
|
-
* @summary Removes one or more Elastic Compute Service (ECS) instances
|
|
9466
|
+
* @summary Removes instances from a scaling group. If an enabled scaling group has no ongoing scaling activities, you can call the DetachInstances operation to remove one or more Elastic Compute Service (ECS) instances, elastic container instances, or Alibaba Cloud-hosted third-party instances from the scaling group.
|
|
9353
9467
|
*
|
|
9354
|
-
* @description
|
|
9355
|
-
*
|
|
9356
|
-
*
|
|
9357
|
-
*
|
|
9358
|
-
*
|
|
9359
|
-
*
|
|
9360
|
-
*
|
|
9361
|
-
*
|
|
9468
|
+
* @description * Before you call the DetachInstances operation, make sure that the following conditions are met:
|
|
9469
|
+
* * The specified scaling group is enabled.
|
|
9470
|
+
* * The specified scaling group does not have any ongoing scaling activities.
|
|
9471
|
+
* **
|
|
9472
|
+
* **Note** If the specified scaling group does not have any ongoing scaling activities, the operation can bypass the cooldown period of the scaling group and immediately trigger scaling activities.
|
|
9473
|
+
* * Before you call this operation, take note of the following items:
|
|
9474
|
+
* * The ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances that are removed from a scaling group by using this operation can run independently. If needed, you can call the [AttachInstances](https://help.aliyun.com/document_detail/25954.html) operation to re-add these instances to a scaling group.
|
|
9475
|
+
* * The ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances that are removed from a scaling group by using this operation are not stopped or released.
|
|
9476
|
+
* * A successful call only means that Auto Scaling accepts your request. Scaling activities can be triggered as expected, but their successful execution is not guaranteed. You can query the status of a scaling activity based on the ScalingActivityId response parameter.
|
|
9477
|
+
* * The removal of ECS instances, elastic container instances, or Alibaba Cloud-hosted third-party instances must not result in the overall number of instances within the specified scaling group falling below the minimum capacity threshold (MinSize); otherwise, an error will be reported.
|
|
9362
9478
|
*
|
|
9363
9479
|
* @param request DetachInstancesRequest
|
|
9364
9480
|
* @return DetachInstancesResponse
|
|
9365
9481
|
*/
|
|
9366
9482
|
detachInstances(request: DetachInstancesRequest): Promise<DetachInstancesResponse>;
|
|
9367
9483
|
/**
|
|
9368
|
-
* @summary Detaches one or more
|
|
9484
|
+
* @summary Detaches Classic Load Balancer (CLB, formerly known as Server Load Balancer or SLB) instances from a scaling group. If the current CLB instance no longer meets your business requirements, you can call the DetachLoadBalancers operation to detach it from your scaling group. When you call this operation, you can use ScalingGroupId, LoadBalancer.N, and ForceDetach to specify one or more CLB instances to detach. You can also determine whether to call this operation asynchronously and whether to remove the Elastic Compute Service (ECS) instances acting as backend servers from the backend server groups of the CLB instance. You can call this operation to detach only CLB instances from a scaling group.
|
|
9369
9485
|
*
|
|
9370
9486
|
* @param request DetachLoadBalancersRequest
|
|
9371
9487
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9373,7 +9489,7 @@ export default class Client extends OpenApi {
|
|
|
9373
9489
|
*/
|
|
9374
9490
|
detachLoadBalancersWithOptions(request: DetachLoadBalancersRequest, runtime: $Util.RuntimeOptions): Promise<DetachLoadBalancersResponse>;
|
|
9375
9491
|
/**
|
|
9376
|
-
* @summary Detaches one or more
|
|
9492
|
+
* @summary Detaches Classic Load Balancer (CLB, formerly known as Server Load Balancer or SLB) instances from a scaling group. If the current CLB instance no longer meets your business requirements, you can call the DetachLoadBalancers operation to detach it from your scaling group. When you call this operation, you can use ScalingGroupId, LoadBalancer.N, and ForceDetach to specify one or more CLB instances to detach. You can also determine whether to call this operation asynchronously and whether to remove the Elastic Compute Service (ECS) instances acting as backend servers from the backend server groups of the CLB instance. You can call this operation to detach only CLB instances from a scaling group.
|
|
9377
9493
|
*
|
|
9378
9494
|
* @param request DetachLoadBalancersRequest
|
|
9379
9495
|
* @return DetachLoadBalancersResponse
|
|
@@ -9537,7 +9653,7 @@ export default class Client extends OpenApi {
|
|
|
9537
9653
|
*/
|
|
9538
9654
|
enterStandby(request: EnterStandbyRequest): Promise<EnterStandbyResponse>;
|
|
9539
9655
|
/**
|
|
9540
|
-
* @summary Executes a scaling rule.
|
|
9656
|
+
* @summary Executes a scaling rule. To adjust the number of Elastic Compute Service (ECS) instances or elastic container instances, you can manually execute a scaling rule or enable Auto Scaling to execute a scaling rule. You can call the ExecuteScalingRule operation to execute simple scaling rules or step scaling rules. Auto Scaling automatically executes target tracking scaling rules and predictive scaling rules on your behalf without requiring explicit execution calls.
|
|
9541
9657
|
*
|
|
9542
9658
|
* @description Before you call this operation, take note of the following items:
|
|
9543
9659
|
* * The scaling group is in the Active state.
|
|
@@ -9554,7 +9670,7 @@ export default class Client extends OpenApi {
|
|
|
9554
9670
|
*/
|
|
9555
9671
|
executeScalingRuleWithOptions(request: ExecuteScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<ExecuteScalingRuleResponse>;
|
|
9556
9672
|
/**
|
|
9557
|
-
* @summary Executes a scaling rule.
|
|
9673
|
+
* @summary Executes a scaling rule. To adjust the number of Elastic Compute Service (ECS) instances or elastic container instances, you can manually execute a scaling rule or enable Auto Scaling to execute a scaling rule. You can call the ExecuteScalingRule operation to execute simple scaling rules or step scaling rules. Auto Scaling automatically executes target tracking scaling rules and predictive scaling rules on your behalf without requiring explicit execution calls.
|
|
9558
9674
|
*
|
|
9559
9675
|
* @description Before you call this operation, take note of the following items:
|
|
9560
9676
|
* * The scaling group is in the Active state.
|
|
@@ -9570,10 +9686,13 @@ export default class Client extends OpenApi {
|
|
|
9570
9686
|
*/
|
|
9571
9687
|
executeScalingRule(request: ExecuteScalingRuleRequest): Promise<ExecuteScalingRuleResponse>;
|
|
9572
9688
|
/**
|
|
9573
|
-
* @summary
|
|
9689
|
+
* @summary Removes an instance from the Standby state. When a scale-in event is triggered in a scaling group, Auto Scaling does not remove Elastic Compute Service (ECS) instances or elastic container instances that are in the Standby state from the scaling group. If you want to restart the instances that are in the Standby state, you can call the ExitStandby operation to remove the instances from the Standby state and put them into the In Service state.
|
|
9574
9690
|
*
|
|
9575
|
-
* @description
|
|
9576
|
-
*
|
|
9691
|
+
* @description After ECS instances or elastic container instances are removed from the Standby state, the following rules apply:
|
|
9692
|
+
* * The ECS instances or elastic container instances enter the In Service state.
|
|
9693
|
+
* * The default weight of each ECS instance or elastic container instance as a backend server of the attached load balancer is 50.
|
|
9694
|
+
* * If you stop or restart the ECS instances or elastic container instances, the health check status of the instances will be updated.
|
|
9695
|
+
* * When a scale-in event is triggered, Auto Scaling may remove the ECS instances or elastic container instances from the scaling group.
|
|
9577
9696
|
*
|
|
9578
9697
|
* @param request ExitStandbyRequest
|
|
9579
9698
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9581,10 +9700,13 @@ export default class Client extends OpenApi {
|
|
|
9581
9700
|
*/
|
|
9582
9701
|
exitStandbyWithOptions(request: ExitStandbyRequest, runtime: $Util.RuntimeOptions): Promise<ExitStandbyResponse>;
|
|
9583
9702
|
/**
|
|
9584
|
-
* @summary
|
|
9703
|
+
* @summary Removes an instance from the Standby state. When a scale-in event is triggered in a scaling group, Auto Scaling does not remove Elastic Compute Service (ECS) instances or elastic container instances that are in the Standby state from the scaling group. If you want to restart the instances that are in the Standby state, you can call the ExitStandby operation to remove the instances from the Standby state and put them into the In Service state.
|
|
9585
9704
|
*
|
|
9586
|
-
* @description
|
|
9587
|
-
*
|
|
9705
|
+
* @description After ECS instances or elastic container instances are removed from the Standby state, the following rules apply:
|
|
9706
|
+
* * The ECS instances or elastic container instances enter the In Service state.
|
|
9707
|
+
* * The default weight of each ECS instance or elastic container instance as a backend server of the attached load balancer is 50.
|
|
9708
|
+
* * If you stop or restart the ECS instances or elastic container instances, the health check status of the instances will be updated.
|
|
9709
|
+
* * When a scale-in event is triggered, Auto Scaling may remove the ECS instances or elastic container instances from the scaling group.
|
|
9588
9710
|
*
|
|
9589
9711
|
* @param request ExitStandbyRequest
|
|
9590
9712
|
* @return ExitStandbyResponse
|
|
@@ -9668,6 +9790,21 @@ export default class Client extends OpenApi {
|
|
|
9668
9790
|
* @return ModifyAlarmResponse
|
|
9669
9791
|
*/
|
|
9670
9792
|
modifyAlarm(request: ModifyAlarmRequest): Promise<ModifyAlarmResponse>;
|
|
9793
|
+
/**
|
|
9794
|
+
* @summary Sets the status of scaling activities that prompt text message or email notifications.
|
|
9795
|
+
*
|
|
9796
|
+
* @param request ModifyAlertConfigurationRequest
|
|
9797
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
9798
|
+
* @return ModifyAlertConfigurationResponse
|
|
9799
|
+
*/
|
|
9800
|
+
modifyAlertConfigurationWithOptions(request: ModifyAlertConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyAlertConfigurationResponse>;
|
|
9801
|
+
/**
|
|
9802
|
+
* @summary Sets the status of scaling activities that prompt text message or email notifications.
|
|
9803
|
+
*
|
|
9804
|
+
* @param request ModifyAlertConfigurationRequest
|
|
9805
|
+
* @return ModifyAlertConfigurationResponse
|
|
9806
|
+
*/
|
|
9807
|
+
modifyAlertConfiguration(request: ModifyAlertConfigurationRequest): Promise<ModifyAlertConfigurationResponse>;
|
|
9671
9808
|
/**
|
|
9672
9809
|
* @summary Modifies a scaling configuration for a scaling group that contains elastic container instances.
|
|
9673
9810
|
*
|
|
@@ -9703,11 +9840,11 @@ export default class Client extends OpenApi {
|
|
|
9703
9840
|
*/
|
|
9704
9841
|
modifyInstanceAttribute(request: ModifyInstanceAttributeRequest): Promise<ModifyInstanceAttributeResponse>;
|
|
9705
9842
|
/**
|
|
9706
|
-
* @summary Modifies a lifecycle hook.
|
|
9843
|
+
* @summary Modifies a lifecycle hook. If an existing lifecycle hook does not meet your business requirements anymore, you can call the ModifyLifecycleHook operation to modify the information such as the scaling event, timeout period, and default action of the lifecycle hook. Before you modify a lifecycle hook, you can locate the lifecycle hook by its ID, name, or scaling group.
|
|
9707
9844
|
*
|
|
9708
|
-
* @description You can use one of the following methods to
|
|
9709
|
-
* * Specify
|
|
9710
|
-
* * Specify
|
|
9845
|
+
* @description You can use one of the following methods to locate the lifecycle hook that you want to modify:
|
|
9846
|
+
* * Specify LifecycleHookId. In this case, ScalingGroupId and LifecycleHookName are ignored.
|
|
9847
|
+
* * Specify ScalingGroupId and LifecycleHookName. Each lifecycle hook within a scaling group has a unique name.
|
|
9711
9848
|
*
|
|
9712
9849
|
* @param request ModifyLifecycleHookRequest
|
|
9713
9850
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9715,18 +9852,18 @@ export default class Client extends OpenApi {
|
|
|
9715
9852
|
*/
|
|
9716
9853
|
modifyLifecycleHookWithOptions(request: ModifyLifecycleHookRequest, runtime: $Util.RuntimeOptions): Promise<ModifyLifecycleHookResponse>;
|
|
9717
9854
|
/**
|
|
9718
|
-
* @summary Modifies a lifecycle hook.
|
|
9855
|
+
* @summary Modifies a lifecycle hook. If an existing lifecycle hook does not meet your business requirements anymore, you can call the ModifyLifecycleHook operation to modify the information such as the scaling event, timeout period, and default action of the lifecycle hook. Before you modify a lifecycle hook, you can locate the lifecycle hook by its ID, name, or scaling group.
|
|
9719
9856
|
*
|
|
9720
|
-
* @description You can use one of the following methods to
|
|
9721
|
-
* * Specify
|
|
9722
|
-
* * Specify
|
|
9857
|
+
* @description You can use one of the following methods to locate the lifecycle hook that you want to modify:
|
|
9858
|
+
* * Specify LifecycleHookId. In this case, ScalingGroupId and LifecycleHookName are ignored.
|
|
9859
|
+
* * Specify ScalingGroupId and LifecycleHookName. Each lifecycle hook within a scaling group has a unique name.
|
|
9723
9860
|
*
|
|
9724
9861
|
* @param request ModifyLifecycleHookRequest
|
|
9725
9862
|
* @return ModifyLifecycleHookResponse
|
|
9726
9863
|
*/
|
|
9727
9864
|
modifyLifecycleHook(request: ModifyLifecycleHookRequest): Promise<ModifyLifecycleHookResponse>;
|
|
9728
9865
|
/**
|
|
9729
|
-
* @summary Modifies a notification.
|
|
9866
|
+
* @summary Modifies event notification rules. Event notification rules support automatic sending of notifications to CloudMonitor, Message Service (MNS) topics, or MNS queues when a specified type of events occur. This helps you learn about the dynamics of your scaling group at the earliest opportunity and further automate resource management. If an existing event notification rule does not meet your business requirements, you can call the ModifyNotificationConfiguration operation to modify the event notification rule, without the need to create a new rule. Take not that you cannot modify the notification method of an event notification rule by calling this operation.
|
|
9730
9867
|
*
|
|
9731
9868
|
* @param request ModifyNotificationConfigurationRequest
|
|
9732
9869
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9734,7 +9871,7 @@ export default class Client extends OpenApi {
|
|
|
9734
9871
|
*/
|
|
9735
9872
|
modifyNotificationConfigurationWithOptions(request: ModifyNotificationConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyNotificationConfigurationResponse>;
|
|
9736
9873
|
/**
|
|
9737
|
-
* @summary Modifies a notification.
|
|
9874
|
+
* @summary Modifies event notification rules. Event notification rules support automatic sending of notifications to CloudMonitor, Message Service (MNS) topics, or MNS queues when a specified type of events occur. This helps you learn about the dynamics of your scaling group at the earliest opportunity and further automate resource management. If an existing event notification rule does not meet your business requirements, you can call the ModifyNotificationConfiguration operation to modify the event notification rule, without the need to create a new rule. Take not that you cannot modify the notification method of an event notification rule by calling this operation.
|
|
9738
9875
|
*
|
|
9739
9876
|
* @param request ModifyNotificationConfigurationRequest
|
|
9740
9877
|
* @return ModifyNotificationConfigurationResponse
|
|
@@ -9803,7 +9940,7 @@ export default class Client extends OpenApi {
|
|
|
9803
9940
|
*/
|
|
9804
9941
|
modifyScalingGroup(request: ModifyScalingGroupRequest): Promise<ModifyScalingGroupResponse>;
|
|
9805
9942
|
/**
|
|
9806
|
-
* @summary Modifies a scaling rule.
|
|
9943
|
+
* @summary Modifies a scaling rule. If an existing scaling rule cannot meet your business requirements, you can call the ModifyScalingRule operation to modify the scaling rule, without the need to create a new one. This streamlines your workflow, enhancing operational efficiency while also contributing to cost optimization by avoiding redundant steps.
|
|
9807
9944
|
*
|
|
9808
9945
|
* @param request ModifyScalingRuleRequest
|
|
9809
9946
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9811,14 +9948,14 @@ export default class Client extends OpenApi {
|
|
|
9811
9948
|
*/
|
|
9812
9949
|
modifyScalingRuleWithOptions(request: ModifyScalingRuleRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScalingRuleResponse>;
|
|
9813
9950
|
/**
|
|
9814
|
-
* @summary Modifies a scaling rule.
|
|
9951
|
+
* @summary Modifies a scaling rule. If an existing scaling rule cannot meet your business requirements, you can call the ModifyScalingRule operation to modify the scaling rule, without the need to create a new one. This streamlines your workflow, enhancing operational efficiency while also contributing to cost optimization by avoiding redundant steps.
|
|
9815
9952
|
*
|
|
9816
9953
|
* @param request ModifyScalingRuleRequest
|
|
9817
9954
|
* @return ModifyScalingRuleResponse
|
|
9818
9955
|
*/
|
|
9819
9956
|
modifyScalingRule(request: ModifyScalingRuleRequest): Promise<ModifyScalingRuleResponse>;
|
|
9820
9957
|
/**
|
|
9821
|
-
* @summary Modifies a scheduled task.
|
|
9958
|
+
* @summary Modifies a scheduled task. If an existing scheduled task cannot meet your business requirements, you can call the ModifyScheduledTask operation to adjust its parameter settings including the scaling rule to execute and the boundary values of your scaling group, without the need to create a new scheduled task. This operation provides a flexible way to optimize scheduled tasks.
|
|
9822
9959
|
*
|
|
9823
9960
|
* @description You can use the following parameters to specify the scaling method of a scheduled task:
|
|
9824
9961
|
* * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
|
|
@@ -9831,7 +9968,7 @@ export default class Client extends OpenApi {
|
|
|
9831
9968
|
*/
|
|
9832
9969
|
modifyScheduledTaskWithOptions(request: ModifyScheduledTaskRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScheduledTaskResponse>;
|
|
9833
9970
|
/**
|
|
9834
|
-
* @summary Modifies a scheduled task.
|
|
9971
|
+
* @summary Modifies a scheduled task. If an existing scheduled task cannot meet your business requirements, you can call the ModifyScheduledTask operation to adjust its parameter settings including the scaling rule to execute and the boundary values of your scaling group, without the need to create a new scheduled task. This operation provides a flexible way to optimize scheduled tasks.
|
|
9835
9972
|
*
|
|
9836
9973
|
* @description You can use the following parameters to specify the scaling method of a scheduled task:
|
|
9837
9974
|
* * If you use the `ScheduledAction` parameter, you must select an existing scaling rule for the scheduled task.
|
|
@@ -9874,9 +10011,10 @@ export default class Client extends OpenApi {
|
|
|
9874
10011
|
*/
|
|
9875
10012
|
rebalanceInstances(request: RebalanceInstancesRequest): Promise<RebalanceInstancesResponse>;
|
|
9876
10013
|
/**
|
|
9877
|
-
* @summary
|
|
10014
|
+
* @summary Extends the time window during which Elastic Compute Service (ECS) instances stay in a Pending state. If the current time window during which an ECS instance stays in a Pending state is not sufficient for you to complete custom operations on the ECS instance, you can call the RecordLifecycleActionHeartbeat operation to extend the time window. When you call this operation, you can specify lifecycleHookId, lifecycleActionToken, and heartbeatTimeout to extend the time window for the desired ECS instance.
|
|
9878
10015
|
*
|
|
9879
|
-
* @description You can call this operation
|
|
10016
|
+
* @description You can call this operation only when the desired ECS instance enters a Pending state.\\
|
|
10017
|
+
* An ECS instance can stay in a Pending state for up to six hours. Each time an ECS instance enters a Pending state, you can extend the time window during which the ECS instance stays in a Pending state up to 20 times.
|
|
9880
10018
|
*
|
|
9881
10019
|
* @param request RecordLifecycleActionHeartbeatRequest
|
|
9882
10020
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9884,9 +10022,10 @@ export default class Client extends OpenApi {
|
|
|
9884
10022
|
*/
|
|
9885
10023
|
recordLifecycleActionHeartbeatWithOptions(request: RecordLifecycleActionHeartbeatRequest, runtime: $Util.RuntimeOptions): Promise<RecordLifecycleActionHeartbeatResponse>;
|
|
9886
10024
|
/**
|
|
9887
|
-
* @summary
|
|
10025
|
+
* @summary Extends the time window during which Elastic Compute Service (ECS) instances stay in a Pending state. If the current time window during which an ECS instance stays in a Pending state is not sufficient for you to complete custom operations on the ECS instance, you can call the RecordLifecycleActionHeartbeat operation to extend the time window. When you call this operation, you can specify lifecycleHookId, lifecycleActionToken, and heartbeatTimeout to extend the time window for the desired ECS instance.
|
|
9888
10026
|
*
|
|
9889
|
-
* @description You can call this operation
|
|
10027
|
+
* @description You can call this operation only when the desired ECS instance enters a Pending state.\\
|
|
10028
|
+
* An ECS instance can stay in a Pending state for up to six hours. Each time an ECS instance enters a Pending state, you can extend the time window during which the ECS instance stays in a Pending state up to 20 times.
|
|
9890
10029
|
*
|
|
9891
10030
|
* @param request RecordLifecycleActionHeartbeatRequest
|
|
9892
10031
|
* @return RecordLifecycleActionHeartbeatResponse
|