@alicloud/ess20220222 1.4.0 → 1.4.2
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 +312 -166
- package/dist/client.js +416 -166
- package/dist/client.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +516 -166
package/dist/client.d.ts
CHANGED
|
@@ -1886,11 +1886,27 @@ export declare class DescribePatternTypesRequest extends $tea.Model {
|
|
|
1886
1886
|
channelId?: number;
|
|
1887
1887
|
cores?: number;
|
|
1888
1888
|
coresList?: number[];
|
|
1889
|
+
cpuArchitectures?: string[];
|
|
1889
1890
|
excludedInstanceType?: string[];
|
|
1891
|
+
gpuSpecs?: string[];
|
|
1892
|
+
instanceCategories?: string[];
|
|
1890
1893
|
instanceFamilyLevel?: string;
|
|
1894
|
+
instanceTypeFamilies?: string[];
|
|
1891
1895
|
maxPrice?: number;
|
|
1896
|
+
maximumCpuCoreCount?: number;
|
|
1897
|
+
maximumGpuAmount?: number;
|
|
1898
|
+
maximumMemorySize?: number;
|
|
1892
1899
|
memory?: number;
|
|
1893
1900
|
memoryList?: number[];
|
|
1901
|
+
minimumBaselineCredit?: number;
|
|
1902
|
+
minimumCpuCoreCount?: number;
|
|
1903
|
+
minimumEniIpv6AddressQuantity?: number;
|
|
1904
|
+
minimumEniPrivateIpAddressQuantity?: number;
|
|
1905
|
+
minimumEniQuantity?: number;
|
|
1906
|
+
minimumGpuAmount?: number;
|
|
1907
|
+
minimumInitialCredit?: number;
|
|
1908
|
+
minimumMemorySize?: number;
|
|
1909
|
+
physicalProcessorModels?: string[];
|
|
1894
1910
|
regionId?: string;
|
|
1895
1911
|
spotStrategy?: string;
|
|
1896
1912
|
vSwitchId?: string[];
|
|
@@ -2497,6 +2513,7 @@ export declare class DetachInstancesRequest extends $tea.Model {
|
|
|
2497
2513
|
clientToken?: string;
|
|
2498
2514
|
decreaseDesiredCapacity?: boolean;
|
|
2499
2515
|
detachOption?: string;
|
|
2516
|
+
ignoreInvalidInstance?: boolean;
|
|
2500
2517
|
instanceIds?: string[];
|
|
2501
2518
|
lifecycleHook?: boolean;
|
|
2502
2519
|
ownerAccount?: string;
|
|
@@ -3885,6 +3902,7 @@ export declare class RecordLifecycleActionHeartbeatResponse extends $tea.Model {
|
|
|
3885
3902
|
export declare class RemoveInstancesRequest extends $tea.Model {
|
|
3886
3903
|
clientToken?: string;
|
|
3887
3904
|
decreaseDesiredCapacity?: boolean;
|
|
3905
|
+
ignoreInvalidInstance?: boolean;
|
|
3888
3906
|
instanceIds?: string[];
|
|
3889
3907
|
ownerAccount?: string;
|
|
3890
3908
|
ownerId?: number;
|
|
@@ -5094,10 +5112,26 @@ export declare class CreateScalingConfigurationRequestInstancePatternInfos exten
|
|
|
5094
5112
|
architectures?: string[];
|
|
5095
5113
|
burstablePerformance?: string;
|
|
5096
5114
|
cores?: number;
|
|
5115
|
+
cpuArchitectures?: string[];
|
|
5097
5116
|
excludedInstanceTypes?: string[];
|
|
5117
|
+
gpuSpecs?: string[];
|
|
5118
|
+
instanceCategories?: string[];
|
|
5098
5119
|
instanceFamilyLevel?: string;
|
|
5120
|
+
instanceTypeFamilies?: string[];
|
|
5099
5121
|
maxPrice?: number;
|
|
5122
|
+
maximumCpuCoreCount?: number;
|
|
5123
|
+
maximumGpuAmount?: number;
|
|
5124
|
+
maximumMemorySize?: number;
|
|
5100
5125
|
memory?: number;
|
|
5126
|
+
minimumBaselineCredit?: number;
|
|
5127
|
+
minimumCpuCoreCount?: number;
|
|
5128
|
+
minimumEniIpv6AddressQuantity?: number;
|
|
5129
|
+
minimumEniPrivateIpAddressQuantity?: number;
|
|
5130
|
+
minimumEniQuantity?: number;
|
|
5131
|
+
minimumGpuAmount?: number;
|
|
5132
|
+
minimumInitialCredit?: number;
|
|
5133
|
+
minimumMemorySize?: number;
|
|
5134
|
+
physicalProcessorModels?: string[];
|
|
5101
5135
|
static names(): {
|
|
5102
5136
|
[key: string]: string;
|
|
5103
5137
|
};
|
|
@@ -5238,10 +5272,26 @@ export declare class CreateScalingConfigurationShrinkRequestInstancePatternInfos
|
|
|
5238
5272
|
architectures?: string[];
|
|
5239
5273
|
burstablePerformance?: string;
|
|
5240
5274
|
cores?: number;
|
|
5275
|
+
cpuArchitectures?: string[];
|
|
5241
5276
|
excludedInstanceTypes?: string[];
|
|
5277
|
+
gpuSpecs?: string[];
|
|
5278
|
+
instanceCategories?: string[];
|
|
5242
5279
|
instanceFamilyLevel?: string;
|
|
5280
|
+
instanceTypeFamilies?: string[];
|
|
5243
5281
|
maxPrice?: number;
|
|
5282
|
+
maximumCpuCoreCount?: number;
|
|
5283
|
+
maximumGpuAmount?: number;
|
|
5284
|
+
maximumMemorySize?: number;
|
|
5244
5285
|
memory?: number;
|
|
5286
|
+
minimumBaselineCredit?: number;
|
|
5287
|
+
minimumCpuCoreCount?: number;
|
|
5288
|
+
minimumEniIpv6AddressQuantity?: number;
|
|
5289
|
+
minimumEniPrivateIpAddressQuantity?: number;
|
|
5290
|
+
minimumEniQuantity?: number;
|
|
5291
|
+
minimumGpuAmount?: number;
|
|
5292
|
+
minimumInitialCredit?: number;
|
|
5293
|
+
minimumMemorySize?: number;
|
|
5294
|
+
physicalProcessorModels?: string[];
|
|
5245
5295
|
static names(): {
|
|
5246
5296
|
[key: string]: string;
|
|
5247
5297
|
};
|
|
@@ -6406,10 +6456,26 @@ export declare class DescribeScalingConfigurationsResponseBodyScalingConfigurati
|
|
|
6406
6456
|
architectures?: string[];
|
|
6407
6457
|
burstablePerformance?: string;
|
|
6408
6458
|
cores?: number;
|
|
6459
|
+
cpuArchitectures?: string[];
|
|
6409
6460
|
excludedInstanceTypes?: string[];
|
|
6461
|
+
gpuSpecs?: string[];
|
|
6462
|
+
instanceCategories?: string[];
|
|
6410
6463
|
instanceFamilyLevel?: string;
|
|
6464
|
+
instanceTypeFamilies?: string[];
|
|
6411
6465
|
maxPrice?: number;
|
|
6466
|
+
maximumCpuCoreCount?: number;
|
|
6467
|
+
maximumGpuAmount?: number;
|
|
6468
|
+
maximumMemorySize?: number;
|
|
6412
6469
|
memory?: number;
|
|
6470
|
+
minimumBaselineCredit?: number;
|
|
6471
|
+
minimumCpuCoreCount?: number;
|
|
6472
|
+
minimumEniIpv6AddressQuantity?: number;
|
|
6473
|
+
minimumEniPrivateIpAddressQuantity?: number;
|
|
6474
|
+
minimumEniQuantity?: number;
|
|
6475
|
+
minimumGpuAmount?: number;
|
|
6476
|
+
minimumInitialCredit?: number;
|
|
6477
|
+
minimumMemorySize?: number;
|
|
6478
|
+
physicalProcessorModels?: string[];
|
|
6413
6479
|
static names(): {
|
|
6414
6480
|
[key: string]: string;
|
|
6415
6481
|
};
|
|
@@ -7804,10 +7870,26 @@ export declare class ModifyScalingConfigurationRequestInstancePatternInfos exten
|
|
|
7804
7870
|
architectures?: string[];
|
|
7805
7871
|
burstablePerformance?: string;
|
|
7806
7872
|
cores?: number;
|
|
7873
|
+
cpuArchitectures?: string[];
|
|
7807
7874
|
excludedInstanceTypes?: string[];
|
|
7875
|
+
gpuSpecs?: string[];
|
|
7876
|
+
instanceCategories?: string[];
|
|
7808
7877
|
instanceFamilyLevel?: string;
|
|
7878
|
+
instanceTypeFamilies?: string[];
|
|
7809
7879
|
maxPrice?: number;
|
|
7880
|
+
maximumCpuCoreCount?: number;
|
|
7881
|
+
maximumGpuAmount?: number;
|
|
7882
|
+
maximumMemorySize?: number;
|
|
7810
7883
|
memory?: number;
|
|
7884
|
+
minimumBaselineCredit?: number;
|
|
7885
|
+
minimumCpuCoreCount?: number;
|
|
7886
|
+
minimumEniIpv6AddressQuantity?: number;
|
|
7887
|
+
minimumEniPrivateIpAddressQuantity?: number;
|
|
7888
|
+
minimumEniQuantity?: number;
|
|
7889
|
+
minimumGpuAmount?: number;
|
|
7890
|
+
minimumInitialCredit?: number;
|
|
7891
|
+
minimumMemorySize?: number;
|
|
7892
|
+
physicalProcessorModels?: string[];
|
|
7811
7893
|
static names(): {
|
|
7812
7894
|
[key: string]: string;
|
|
7813
7895
|
};
|
|
@@ -7948,10 +8030,26 @@ export declare class ModifyScalingConfigurationShrinkRequestInstancePatternInfos
|
|
|
7948
8030
|
architectures?: string[];
|
|
7949
8031
|
burstablePerformance?: string;
|
|
7950
8032
|
cores?: number;
|
|
8033
|
+
cpuArchitectures?: string[];
|
|
7951
8034
|
excludedInstanceTypes?: string[];
|
|
8035
|
+
gpuSpecs?: string[];
|
|
8036
|
+
instanceCategories?: string[];
|
|
7952
8037
|
instanceFamilyLevel?: string;
|
|
8038
|
+
instanceTypeFamilies?: string[];
|
|
7953
8039
|
maxPrice?: number;
|
|
8040
|
+
maximumCpuCoreCount?: number;
|
|
8041
|
+
maximumGpuAmount?: number;
|
|
8042
|
+
maximumMemorySize?: number;
|
|
7954
8043
|
memory?: number;
|
|
8044
|
+
minimumBaselineCredit?: number;
|
|
8045
|
+
minimumCpuCoreCount?: number;
|
|
8046
|
+
minimumEniIpv6AddressQuantity?: number;
|
|
8047
|
+
minimumEniPrivateIpAddressQuantity?: number;
|
|
8048
|
+
minimumEniQuantity?: number;
|
|
8049
|
+
minimumGpuAmount?: number;
|
|
8050
|
+
minimumInitialCredit?: number;
|
|
8051
|
+
minimumMemorySize?: number;
|
|
8052
|
+
physicalProcessorModels?: string[];
|
|
7955
8053
|
static names(): {
|
|
7956
8054
|
[key: string]: string;
|
|
7957
8055
|
};
|
|
@@ -8225,12 +8323,11 @@ export default class Client extends OpenApi {
|
|
|
8225
8323
|
*/
|
|
8226
8324
|
applyScalingGroup(request: ApplyScalingGroupRequest): Promise<ApplyScalingGroupResponse>;
|
|
8227
8325
|
/**
|
|
8228
|
-
* @summary
|
|
8326
|
+
* @summary Attaches Application Load Balancer (ALB) server groups to a scaling group. To seamlessly adjust the number of instances in response to changes in your business workload or to maintain the uninterrupted accessibility of your application, you can call the AttachAlbServerGroups operation. By attaching ALB server groups to your scaling group, this operation enables Auto Scaling to automatically tailor your computing capacity to your business needs. Furthermore, it optimizes traffic routing by dynamically allocating incoming requests based on current workload patterns, which significantly improves the stability and performance of your application.
|
|
8229
8327
|
*
|
|
8230
|
-
* @description Before you
|
|
8231
|
-
* * The scaling group
|
|
8328
|
+
* @description Before you call the operation to attach an ALB server group to your scaling group, make sure that the following requirements are met:
|
|
8329
|
+
* * The scaling group and the ALB server group share the same virtual private cloud (VPC).
|
|
8232
8330
|
* * The ALB server group is in the Available state.
|
|
8233
|
-
* * You can associate only a limited number of ALB server groups with a scaling group. To view the quota or manually request a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).
|
|
8234
8331
|
*
|
|
8235
8332
|
* @param request AttachAlbServerGroupsRequest
|
|
8236
8333
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8238,12 +8335,11 @@ export default class Client extends OpenApi {
|
|
|
8238
8335
|
*/
|
|
8239
8336
|
attachAlbServerGroupsWithOptions(request: AttachAlbServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<AttachAlbServerGroupsResponse>;
|
|
8240
8337
|
/**
|
|
8241
|
-
* @summary
|
|
8338
|
+
* @summary Attaches Application Load Balancer (ALB) server groups to a scaling group. To seamlessly adjust the number of instances in response to changes in your business workload or to maintain the uninterrupted accessibility of your application, you can call the AttachAlbServerGroups operation. By attaching ALB server groups to your scaling group, this operation enables Auto Scaling to automatically tailor your computing capacity to your business needs. Furthermore, it optimizes traffic routing by dynamically allocating incoming requests based on current workload patterns, which significantly improves the stability and performance of your application.
|
|
8242
8339
|
*
|
|
8243
|
-
* @description Before you
|
|
8244
|
-
* * The scaling group
|
|
8340
|
+
* @description Before you call the operation to attach an ALB server group to your scaling group, make sure that the following requirements are met:
|
|
8341
|
+
* * The scaling group and the ALB server group share the same virtual private cloud (VPC).
|
|
8245
8342
|
* * The ALB server group is in the Available state.
|
|
8246
|
-
* * You can associate only a limited number of ALB server groups with a scaling group. To view the quota or manually request a quota increase, go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas).
|
|
8247
8343
|
*
|
|
8248
8344
|
* @param request AttachAlbServerGroupsRequest
|
|
8249
8345
|
* @return AttachAlbServerGroupsResponse
|
|
@@ -8353,7 +8449,7 @@ export default class Client extends OpenApi {
|
|
|
8353
8449
|
*/
|
|
8354
8450
|
attachLoadBalancers(request: AttachLoadBalancersRequest): Promise<AttachLoadBalancersResponse>;
|
|
8355
8451
|
/**
|
|
8356
|
-
* @summary Attaches
|
|
8452
|
+
* @summary Attaches server groups to a scaling group. To seamlessly adjust the number of instances in response to changes in your business workload or to maintain the uninterrupted accessibility of your application, you can call the AttachServerGroups operation. By attaching Application Load Balancer (ALB) or Network Load Balancer (NLB) server groups to your scaling group, this operation enables Auto Scaling to automatically tailor your computing capacity to your business needs. Furthermore, it optimizes traffic routing by dynamically allocating incoming requests based on current workload patterns, which significantly improves the stability and performance of your application.
|
|
8357
8453
|
*
|
|
8358
8454
|
* @param request AttachServerGroupsRequest
|
|
8359
8455
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8361,29 +8457,30 @@ export default class Client extends OpenApi {
|
|
|
8361
8457
|
*/
|
|
8362
8458
|
attachServerGroupsWithOptions(request: AttachServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<AttachServerGroupsResponse>;
|
|
8363
8459
|
/**
|
|
8364
|
-
* @summary Attaches
|
|
8460
|
+
* @summary Attaches server groups to a scaling group. To seamlessly adjust the number of instances in response to changes in your business workload or to maintain the uninterrupted accessibility of your application, you can call the AttachServerGroups operation. By attaching Application Load Balancer (ALB) or Network Load Balancer (NLB) server groups to your scaling group, this operation enables Auto Scaling to automatically tailor your computing capacity to your business needs. Furthermore, it optimizes traffic routing by dynamically allocating incoming requests based on current workload patterns, which significantly improves the stability and performance of your application.
|
|
8365
8461
|
*
|
|
8366
8462
|
* @param request AttachServerGroupsRequest
|
|
8367
8463
|
* @return AttachServerGroupsResponse
|
|
8368
8464
|
*/
|
|
8369
8465
|
attachServerGroups(request: AttachServerGroupsRequest): Promise<AttachServerGroupsResponse>;
|
|
8370
8466
|
/**
|
|
8371
|
-
* @summary
|
|
8372
|
-
*
|
|
8373
|
-
* @description Before you call this operation
|
|
8374
|
-
*
|
|
8375
|
-
*
|
|
8376
|
-
*
|
|
8377
|
-
*
|
|
8378
|
-
*
|
|
8379
|
-
*
|
|
8380
|
-
*
|
|
8381
|
-
*
|
|
8382
|
-
* When you call this operation, you must specify the following parameters:
|
|
8383
|
-
*
|
|
8384
|
-
*
|
|
8385
|
-
*
|
|
8386
|
-
*
|
|
8467
|
+
* @summary Attaches vServer groups to a scaling group. After a Classic Load Balancer (CLB) instance is attached to your scaling group, the instances in the scaling group are automatically added as backend servers of the CLB instance. These servers then handle requests forwarded by the CLB instance, streamlining the processing of incoming traffic. To direct varying access requests to separate backend servers or to distribute requests based on domain names or URLs, you can call the AttachVServerGroups operation. This operation enables the addition of multiple vServer groups, allowing for efficient management of various backend server configurations tailored to your routing preferences.
|
|
8468
|
+
*
|
|
8469
|
+
* @description * Before you call this operation, make sure that the following requirements are met:
|
|
8470
|
+
* * The CLB instance and the scaling group belong to the same Alibaba Cloud account.
|
|
8471
|
+
* * The CLB instance and the scaling group reside in the same region.
|
|
8472
|
+
* * The CLB instance is in the Running state.
|
|
8473
|
+
* * The CLB instance is configured with at least one listener. The health check feature is enabled for the CLB instance.
|
|
8474
|
+
* * If the network type of both the CLB instance and the scaling group is virtual private cloud (VPC), they use the same VPC.
|
|
8475
|
+
* * If the network type of the scaling group is VPC and the network type of the CLB instance is classic network, any backend server of the CLB instance within a VPC setup shares the same VPC as the scaling group.
|
|
8476
|
+
* * The vServer groups that you want to attach to the scaling group belong to the CLB instance.
|
|
8477
|
+
* * The operation to attach vServer groups does not result in the total number of vServer groups exceeding the predefined quota limit. For information about the vServer group quota, see [Limits](https://help.aliyun.com/document_detail/25863.html).
|
|
8478
|
+
* * When you call this operation to attach vServer groups, you must specify the following parameters:
|
|
8479
|
+
* * LoadBalancerId: the ID of the CLB instance
|
|
8480
|
+
* * VServerGroupId: the ID of the vServer group
|
|
8481
|
+
* * Port: the port number of the vServer group
|
|
8482
|
+
* **
|
|
8483
|
+
* **Note** If you attempt to attach the same vServer group to a scaling group multiple times over the identical port, the system regards each attempt as a separate vServer group attachment to the scaling group. In your request, if you include the same vServer group ID coupled with the same port number multiple times, only the first configuration of the vServer group and port number pairing is considered valid. Subsequent vServer group and port number parings are disregarded.
|
|
8387
8484
|
*
|
|
8388
8485
|
* @param request AttachVServerGroupsRequest
|
|
8389
8486
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8391,29 +8488,33 @@ export default class Client extends OpenApi {
|
|
|
8391
8488
|
*/
|
|
8392
8489
|
attachVServerGroupsWithOptions(request: AttachVServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<AttachVServerGroupsResponse>;
|
|
8393
8490
|
/**
|
|
8394
|
-
* @summary
|
|
8395
|
-
*
|
|
8396
|
-
* @description Before you call this operation
|
|
8397
|
-
*
|
|
8398
|
-
*
|
|
8399
|
-
*
|
|
8400
|
-
*
|
|
8401
|
-
*
|
|
8402
|
-
*
|
|
8403
|
-
*
|
|
8404
|
-
*
|
|
8405
|
-
* When you call this operation, you must specify the following parameters:
|
|
8406
|
-
*
|
|
8407
|
-
*
|
|
8408
|
-
*
|
|
8409
|
-
*
|
|
8491
|
+
* @summary Attaches vServer groups to a scaling group. After a Classic Load Balancer (CLB) instance is attached to your scaling group, the instances in the scaling group are automatically added as backend servers of the CLB instance. These servers then handle requests forwarded by the CLB instance, streamlining the processing of incoming traffic. To direct varying access requests to separate backend servers or to distribute requests based on domain names or URLs, you can call the AttachVServerGroups operation. This operation enables the addition of multiple vServer groups, allowing for efficient management of various backend server configurations tailored to your routing preferences.
|
|
8492
|
+
*
|
|
8493
|
+
* @description * Before you call this operation, make sure that the following requirements are met:
|
|
8494
|
+
* * The CLB instance and the scaling group belong to the same Alibaba Cloud account.
|
|
8495
|
+
* * The CLB instance and the scaling group reside in the same region.
|
|
8496
|
+
* * The CLB instance is in the Running state.
|
|
8497
|
+
* * The CLB instance is configured with at least one listener. The health check feature is enabled for the CLB instance.
|
|
8498
|
+
* * If the network type of both the CLB instance and the scaling group is virtual private cloud (VPC), they use the same VPC.
|
|
8499
|
+
* * If the network type of the scaling group is VPC and the network type of the CLB instance is classic network, any backend server of the CLB instance within a VPC setup shares the same VPC as the scaling group.
|
|
8500
|
+
* * The vServer groups that you want to attach to the scaling group belong to the CLB instance.
|
|
8501
|
+
* * The operation to attach vServer groups does not result in the total number of vServer groups exceeding the predefined quota limit. For information about the vServer group quota, see [Limits](https://help.aliyun.com/document_detail/25863.html).
|
|
8502
|
+
* * When you call this operation to attach vServer groups, you must specify the following parameters:
|
|
8503
|
+
* * LoadBalancerId: the ID of the CLB instance
|
|
8504
|
+
* * VServerGroupId: the ID of the vServer group
|
|
8505
|
+
* * Port: the port number of the vServer group
|
|
8506
|
+
* **
|
|
8507
|
+
* **Note** If you attempt to attach the same vServer group to a scaling group multiple times over the identical port, the system regards each attempt as a separate vServer group attachment to the scaling group. In your request, if you include the same vServer group ID coupled with the same port number multiple times, only the first configuration of the vServer group and port number pairing is considered valid. Subsequent vServer group and port number parings are disregarded.
|
|
8410
8508
|
*
|
|
8411
8509
|
* @param request AttachVServerGroupsRequest
|
|
8412
8510
|
* @return AttachVServerGroupsResponse
|
|
8413
8511
|
*/
|
|
8414
8512
|
attachVServerGroups(request: AttachVServerGroupsRequest): Promise<AttachVServerGroupsResponse>;
|
|
8415
8513
|
/**
|
|
8416
|
-
* @summary
|
|
8514
|
+
* @summary Changes a resource group. Resource groups are a means to categorize and manage cloud resources, such as scaling groups, based on specific objectives, permissions, or ownership. In large, multifaceted organizations that manage numerous projects and users, this feature adopts a tiered management approach, simplifying management tasks and improving the effectiveness and oversight of resource allocation. You can call the ChangeResourceGroup operation to move your scaling groups from one resource group to another resource group, which facilitates streamlined monitoring and management within the context of the new group. This operation eliminates the need for repetitive and time-consuming cross-service resource queries, thereby enhancing operational efficiency.
|
|
8515
|
+
*
|
|
8516
|
+
* @description * A resource is an entity of cloud services that you create on Alibaba Cloud. For example, a scaling group is a resource.
|
|
8517
|
+
* * A resource group serves as a powerful organizational tool within your Alibaba Cloud account, enabling you to manage and monitor multiple resources collectively. It effectively addresses complexities surrounding resource categorization and permission control under a single Alibaba Cloud account, thereby enhancing management efficiency and control. For more information, see [What is resource management?](https://help.aliyun.com/document_detail/94475.html)
|
|
8417
8518
|
*
|
|
8418
8519
|
* @param request ChangeResourceGroupRequest
|
|
8419
8520
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8421,7 +8522,10 @@ export default class Client extends OpenApi {
|
|
|
8421
8522
|
*/
|
|
8422
8523
|
changeResourceGroupWithOptions(request: ChangeResourceGroupRequest, runtime: $Util.RuntimeOptions): Promise<ChangeResourceGroupResponse>;
|
|
8423
8524
|
/**
|
|
8424
|
-
* @summary
|
|
8525
|
+
* @summary Changes a resource group. Resource groups are a means to categorize and manage cloud resources, such as scaling groups, based on specific objectives, permissions, or ownership. In large, multifaceted organizations that manage numerous projects and users, this feature adopts a tiered management approach, simplifying management tasks and improving the effectiveness and oversight of resource allocation. You can call the ChangeResourceGroup operation to move your scaling groups from one resource group to another resource group, which facilitates streamlined monitoring and management within the context of the new group. This operation eliminates the need for repetitive and time-consuming cross-service resource queries, thereby enhancing operational efficiency.
|
|
8526
|
+
*
|
|
8527
|
+
* @description * A resource is an entity of cloud services that you create on Alibaba Cloud. For example, a scaling group is a resource.
|
|
8528
|
+
* * A resource group serves as a powerful organizational tool within your Alibaba Cloud account, enabling you to manage and monitor multiple resources collectively. It effectively addresses complexities surrounding resource categorization and permission control under a single Alibaba Cloud account, thereby enhancing management efficiency and control. For more information, see [What is resource management?](https://help.aliyun.com/document_detail/94475.html)
|
|
8425
8529
|
*
|
|
8426
8530
|
* @param request ChangeResourceGroupRequest
|
|
8427
8531
|
* @return ChangeResourceGroupResponse
|
|
@@ -8447,13 +8551,13 @@ export default class Client extends OpenApi {
|
|
|
8447
8551
|
*/
|
|
8448
8552
|
completeLifecycleAction(request: CompleteLifecycleActionRequest): Promise<CompleteLifecycleActionResponse>;
|
|
8449
8553
|
/**
|
|
8450
|
-
* @summary Creates an event-triggered task.
|
|
8554
|
+
* @summary Creates event-triggered tasks. If your business encounters unexpected traffic surges or has no specific patterns, you can call the CreateAlarm operation to create an event-triggered task and associate a CloudMonitor metric with the task. This allows you to dynamically adjust the number of Elastic Compute Service (ECS) instances or elastic container instances in your scaling group and keep updated on the real-time metric data, which facilitates cloud resource management and maintenance.
|
|
8451
8555
|
*
|
|
8452
|
-
* @description * If you set
|
|
8453
|
-
* * When you create an event-triggered task, you must specify
|
|
8454
|
-
* * If you
|
|
8455
|
-
* *
|
|
8456
|
-
* >
|
|
8556
|
+
* @description * If you set MetricType to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using the custom metrics. For more information, see [Event-triggered tasks of the custom monitoring type](https://help.aliyun.com/document_detail/74861.html).
|
|
8557
|
+
* * When you create an event-triggered task, you must specify MetricName, Dimensions.DimensionKey, and Dimensions.DimensionValue to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify user_id and scaling_group for an event-triggered task to aggregate monitoring data of all ECS instances or elastic container instances in a scaling group within an Alibaba Cloud account.
|
|
8558
|
+
* * If you create an event-triggered task of the custom monitoring type, you can specify only custom metrics in the task.
|
|
8559
|
+
* * If you create an event-triggered task of the system monitoring type, you can specify the system metrics described in [Event-triggered tasks of the system monitoring type](https://help.aliyun.com/document_detail/74854.html) in the task.
|
|
8560
|
+
* > user_id and scaling_group are automatically populated. You need to only specify device and state. For more information, see `Dimensions.DimensionKey` and `Dimensions.DimensionValue` in the "Request parameters" section of this topic.
|
|
8457
8561
|
*
|
|
8458
8562
|
* @param request CreateAlarmRequest
|
|
8459
8563
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8461,13 +8565,13 @@ export default class Client extends OpenApi {
|
|
|
8461
8565
|
*/
|
|
8462
8566
|
createAlarmWithOptions(request: CreateAlarmRequest, runtime: $Util.RuntimeOptions): Promise<CreateAlarmResponse>;
|
|
8463
8567
|
/**
|
|
8464
|
-
* @summary Creates an event-triggered task.
|
|
8568
|
+
* @summary Creates event-triggered tasks. If your business encounters unexpected traffic surges or has no specific patterns, you can call the CreateAlarm operation to create an event-triggered task and associate a CloudMonitor metric with the task. This allows you to dynamically adjust the number of Elastic Compute Service (ECS) instances or elastic container instances in your scaling group and keep updated on the real-time metric data, which facilitates cloud resource management and maintenance.
|
|
8465
8569
|
*
|
|
8466
|
-
* @description * If you set
|
|
8467
|
-
* * When you create an event-triggered task, you must specify
|
|
8468
|
-
* * If you
|
|
8469
|
-
* *
|
|
8470
|
-
* >
|
|
8570
|
+
* @description * If you set MetricType to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using the custom metrics. For more information, see [Event-triggered tasks of the custom monitoring type](https://help.aliyun.com/document_detail/74861.html).
|
|
8571
|
+
* * When you create an event-triggered task, you must specify MetricName, Dimensions.DimensionKey, and Dimensions.DimensionValue to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify user_id and scaling_group for an event-triggered task to aggregate monitoring data of all ECS instances or elastic container instances in a scaling group within an Alibaba Cloud account.
|
|
8572
|
+
* * If you create an event-triggered task of the custom monitoring type, you can specify only custom metrics in the task.
|
|
8573
|
+
* * If you create an event-triggered task of the system monitoring type, you can specify the system metrics described in [Event-triggered tasks of the system monitoring type](https://help.aliyun.com/document_detail/74854.html) in the task.
|
|
8574
|
+
* > user_id and scaling_group are automatically populated. You need to only specify device and state. For more information, see `Dimensions.DimensionKey` and `Dimensions.DimensionValue` in the "Request parameters" section of this topic.
|
|
8471
8575
|
*
|
|
8472
8576
|
* @param request CreateAlarmRequest
|
|
8473
8577
|
* @return CreateAlarmResponse
|
|
@@ -8724,7 +8828,7 @@ export default class Client extends OpenApi {
|
|
|
8724
8828
|
*/
|
|
8725
8829
|
deactivateScalingConfiguration(request: DeactivateScalingConfigurationRequest): Promise<DeactivateScalingConfigurationResponse>;
|
|
8726
8830
|
/**
|
|
8727
|
-
* @summary Deletes an event-triggered task.
|
|
8831
|
+
* @summary Deletes an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you no longer need an event-triggered task, you can call the DeleteAlarm operation to delete it.
|
|
8728
8832
|
*
|
|
8729
8833
|
* @param request DeleteAlarmRequest
|
|
8730
8834
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8732,18 +8836,18 @@ export default class Client extends OpenApi {
|
|
|
8732
8836
|
*/
|
|
8733
8837
|
deleteAlarmWithOptions(request: DeleteAlarmRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAlarmResponse>;
|
|
8734
8838
|
/**
|
|
8735
|
-
* @summary Deletes an event-triggered task.
|
|
8839
|
+
* @summary Deletes an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you no longer need an event-triggered task, you can call the DeleteAlarm operation to delete it.
|
|
8736
8840
|
*
|
|
8737
8841
|
* @param request DeleteAlarmRequest
|
|
8738
8842
|
* @return DeleteAlarmResponse
|
|
8739
8843
|
*/
|
|
8740
8844
|
deleteAlarm(request: DeleteAlarmRequest): Promise<DeleteAlarmResponse>;
|
|
8741
8845
|
/**
|
|
8742
|
-
* @summary Deletes a scaling configuration
|
|
8846
|
+
* @summary Deletes a scaling configuration of the Elastic Container Instance type. If the scaling configuration of a scaling group is in the Inactive state and the scaling group contains no elastic container instances created from the scaling configuration, you can call the DeleteEciScalingConfiguration operation to delete the scaling configuration to free up the scaling configuration quota.
|
|
8743
8847
|
*
|
|
8744
|
-
* @description You cannot
|
|
8848
|
+
* @description You cannot call this operation to delete a scaling configuration in the following scenarios:
|
|
8745
8849
|
* * The scaling configuration is in the Active state.
|
|
8746
|
-
* * The scaling group contains elastic container instances
|
|
8850
|
+
* * The scaling group contains elastic container instances created from the scaling configuration.
|
|
8747
8851
|
*
|
|
8748
8852
|
* @param request DeleteEciScalingConfigurationRequest
|
|
8749
8853
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8751,11 +8855,11 @@ export default class Client extends OpenApi {
|
|
|
8751
8855
|
*/
|
|
8752
8856
|
deleteEciScalingConfigurationWithOptions(request: DeleteEciScalingConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteEciScalingConfigurationResponse>;
|
|
8753
8857
|
/**
|
|
8754
|
-
* @summary Deletes a scaling configuration
|
|
8858
|
+
* @summary Deletes a scaling configuration of the Elastic Container Instance type. If the scaling configuration of a scaling group is in the Inactive state and the scaling group contains no elastic container instances created from the scaling configuration, you can call the DeleteEciScalingConfiguration operation to delete the scaling configuration to free up the scaling configuration quota.
|
|
8755
8859
|
*
|
|
8756
|
-
* @description You cannot
|
|
8860
|
+
* @description You cannot call this operation to delete a scaling configuration in the following scenarios:
|
|
8757
8861
|
* * The scaling configuration is in the Active state.
|
|
8758
|
-
* * The scaling group contains elastic container instances
|
|
8862
|
+
* * The scaling group contains elastic container instances created from the scaling configuration.
|
|
8759
8863
|
*
|
|
8760
8864
|
* @param request DeleteEciScalingConfigurationRequest
|
|
8761
8865
|
* @return DeleteEciScalingConfigurationResponse
|
|
@@ -8785,7 +8889,7 @@ export default class Client extends OpenApi {
|
|
|
8785
8889
|
*/
|
|
8786
8890
|
deleteLifecycleHook(request: DeleteLifecycleHookRequest): Promise<DeleteLifecycleHookResponse>;
|
|
8787
8891
|
/**
|
|
8788
|
-
* @summary Deletes
|
|
8892
|
+
* @summary Deletes event notification rules. The event notification feature facilitates efficient issue identification and event management by automatically forwarding notifications from Auto Scaling to designated endpoints such as CloudMonitor or Message Service (MNS) topics and queues. If you no longer require an event notification rule, you can call the DeleteNotificationConfiguration operation to delete it.
|
|
8789
8893
|
*
|
|
8790
8894
|
* @param request DeleteNotificationConfigurationRequest
|
|
8791
8895
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8793,7 +8897,7 @@ export default class Client extends OpenApi {
|
|
|
8793
8897
|
*/
|
|
8794
8898
|
deleteNotificationConfigurationWithOptions(request: DeleteNotificationConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteNotificationConfigurationResponse>;
|
|
8795
8899
|
/**
|
|
8796
|
-
* @summary Deletes
|
|
8900
|
+
* @summary Deletes event notification rules. The event notification feature facilitates efficient issue identification and event management by automatically forwarding notifications from Auto Scaling to designated endpoints such as CloudMonitor or Message Service (MNS) topics and queues. If you no longer require an event notification rule, you can call the DeleteNotificationConfiguration operation to delete it.
|
|
8797
8901
|
*
|
|
8798
8902
|
* @param request DeleteNotificationConfigurationRequest
|
|
8799
8903
|
* @return DeleteNotificationConfigurationResponse
|
|
@@ -8823,11 +8927,18 @@ export default class Client extends OpenApi {
|
|
|
8823
8927
|
*/
|
|
8824
8928
|
deleteScalingConfiguration(request: DeleteScalingConfigurationRequest): Promise<DeleteScalingConfigurationResponse>;
|
|
8825
8929
|
/**
|
|
8826
|
-
* @summary Deletes a scaling group.
|
|
8930
|
+
* @summary Deletes a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can create scaling groups to manage your computing power with ease. The computing power refers to the instances that provide the computing capability. If you no longer require a scaling group, you can call the DeleteScalingGroup operation to delete it to free up the scaling group quota.
|
|
8827
8931
|
*
|
|
8828
|
-
* @description Before you
|
|
8829
|
-
* *
|
|
8830
|
-
* *
|
|
8932
|
+
* @description Before you call the DeleteScalingGroup operation, take note of the following items:
|
|
8933
|
+
* * If you delete a scaling group, the scaling configurations, scaling rules, scaling activities, and scaling requests related to the scaling group are also deleted.
|
|
8934
|
+
* * If you delete a scaling group, the scheduled tasks and event-triggered tasks of the scaling group are not deleted. The Server Load Balancer (SLB) instances and ApsaraDB RDS instances that are attached to the scaling group are also not deleted.
|
|
8935
|
+
* * If the scaling group that you want to delete contains ECS instances or elastic container instances that are in the In Service state, Auto Scaling stops the instances and then removes all manually added instances from the scaling group or releases all automatically created instances in the scaling group before the scaling group is deleted.
|
|
8936
|
+
* **
|
|
8937
|
+
* **Note** Before you delete a scaling group, make sure that the Deletion Protection feature is disabled. If you have enabled the Deletion Protection feature for a scaling group, disable the feature on the Modify Scaling Group page before you delete the scaling group.
|
|
8938
|
+
* * If you do not disable the Deletion Protection feature for a scaling group, you cannot delete the scaling group by using the Auto Scaling console or calling this operation. The Deletion Protection feature is an effective measure to safeguard scaling groups against unintended deletion.
|
|
8939
|
+
* * Prior to deleting a scaling group, make sure that your ECS instances within the scaling group are safeguarded against unintended release. Even if you have already enabled the Release Protection feature for the ECS instances, you must manually put these ECS instances into the Protected state. Doing so guarantees that the ECS instances will not be forcibly released during the deletion process of the scaling group, providing an extra layer of security.
|
|
8940
|
+
* **
|
|
8941
|
+
* **Note** Before you delete a scaling group, we recommend that you enable the Deletion Protection feature for ECS instances that you want to retain. This action guarantees that the ECS instances are not forcibly released after you delete the scaling group. For more information, see [SetInstancesProtection](https://help.aliyun.com/document_detail/459342.html).
|
|
8831
8942
|
*
|
|
8832
8943
|
* @param request DeleteScalingGroupRequest
|
|
8833
8944
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8835,11 +8946,18 @@ export default class Client extends OpenApi {
|
|
|
8835
8946
|
*/
|
|
8836
8947
|
deleteScalingGroupWithOptions(request: DeleteScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteScalingGroupResponse>;
|
|
8837
8948
|
/**
|
|
8838
|
-
* @summary Deletes a scaling group.
|
|
8949
|
+
* @summary Deletes a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can create scaling groups to manage your computing power with ease. The computing power refers to the instances that provide the computing capability. If you no longer require a scaling group, you can call the DeleteScalingGroup operation to delete it to free up the scaling group quota.
|
|
8839
8950
|
*
|
|
8840
|
-
* @description Before you
|
|
8841
|
-
* *
|
|
8842
|
-
* *
|
|
8951
|
+
* @description Before you call the DeleteScalingGroup operation, take note of the following items:
|
|
8952
|
+
* * If you delete a scaling group, the scaling configurations, scaling rules, scaling activities, and scaling requests related to the scaling group are also deleted.
|
|
8953
|
+
* * If you delete a scaling group, the scheduled tasks and event-triggered tasks of the scaling group are not deleted. The Server Load Balancer (SLB) instances and ApsaraDB RDS instances that are attached to the scaling group are also not deleted.
|
|
8954
|
+
* * If the scaling group that you want to delete contains ECS instances or elastic container instances that are in the In Service state, Auto Scaling stops the instances and then removes all manually added instances from the scaling group or releases all automatically created instances in the scaling group before the scaling group is deleted.
|
|
8955
|
+
* **
|
|
8956
|
+
* **Note** Before you delete a scaling group, make sure that the Deletion Protection feature is disabled. If you have enabled the Deletion Protection feature for a scaling group, disable the feature on the Modify Scaling Group page before you delete the scaling group.
|
|
8957
|
+
* * If you do not disable the Deletion Protection feature for a scaling group, you cannot delete the scaling group by using the Auto Scaling console or calling this operation. The Deletion Protection feature is an effective measure to safeguard scaling groups against unintended deletion.
|
|
8958
|
+
* * Prior to deleting a scaling group, make sure that your ECS instances within the scaling group are safeguarded against unintended release. Even if you have already enabled the Release Protection feature for the ECS instances, you must manually put these ECS instances into the Protected state. Doing so guarantees that the ECS instances will not be forcibly released during the deletion process of the scaling group, providing an extra layer of security.
|
|
8959
|
+
* **
|
|
8960
|
+
* **Note** Before you delete a scaling group, we recommend that you enable the Deletion Protection feature for ECS instances that you want to retain. This action guarantees that the ECS instances are not forcibly released after you delete the scaling group. For more information, see [SetInstancesProtection](https://help.aliyun.com/document_detail/459342.html).
|
|
8843
8961
|
*
|
|
8844
8962
|
* @param request DeleteScalingGroupRequest
|
|
8845
8963
|
* @return DeleteScalingGroupResponse
|
|
@@ -8861,7 +8979,7 @@ export default class Client extends OpenApi {
|
|
|
8861
8979
|
*/
|
|
8862
8980
|
deleteScalingRule(request: DeleteScalingRuleRequest): Promise<DeleteScalingRuleResponse>;
|
|
8863
8981
|
/**
|
|
8864
|
-
* @summary Deletes a scheduled task.
|
|
8982
|
+
* @summary Deletes scheduled tasks. For workloads with predictable patterns, you can create scheduled tasks to align with your business requirements and optimize resource utilization for cost savings. These tasks automatically ensure that sufficient computing resources are provisioned in anticipation of peak hours and efficiently release unused resources during off-peak hours, thereby streamlining operational efficiency and reducing expenses. If you no longer require a scheduled task, you can call the DeleteScheduledTask operation to delete it.
|
|
8865
8983
|
*
|
|
8866
8984
|
* @param request DeleteScheduledTaskRequest
|
|
8867
8985
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8869,14 +8987,14 @@ export default class Client extends OpenApi {
|
|
|
8869
8987
|
*/
|
|
8870
8988
|
deleteScheduledTaskWithOptions(request: DeleteScheduledTaskRequest, runtime: $Util.RuntimeOptions): Promise<DeleteScheduledTaskResponse>;
|
|
8871
8989
|
/**
|
|
8872
|
-
* @summary Deletes a scheduled task.
|
|
8990
|
+
* @summary Deletes scheduled tasks. For workloads with predictable patterns, you can create scheduled tasks to align with your business requirements and optimize resource utilization for cost savings. These tasks automatically ensure that sufficient computing resources are provisioned in anticipation of peak hours and efficiently release unused resources during off-peak hours, thereby streamlining operational efficiency and reducing expenses. If you no longer require a scheduled task, you can call the DeleteScheduledTask operation to delete it.
|
|
8873
8991
|
*
|
|
8874
8992
|
* @param request DeleteScheduledTaskRequest
|
|
8875
8993
|
* @return DeleteScheduledTaskResponse
|
|
8876
8994
|
*/
|
|
8877
8995
|
deleteScheduledTask(request: DeleteScheduledTaskRequest): Promise<DeleteScheduledTaskResponse>;
|
|
8878
8996
|
/**
|
|
8879
|
-
* @summary Queries event-triggered tasks.
|
|
8997
|
+
* @summary Queries event-triggered tasks. You can call the DescribeAlarms operation to learn about the configurations of event-triggered tasks and keep updated on monitoring data changes. This helps you troubleshoot system resource issues at the earliest opportunity and ensures system stability and reliability.
|
|
8880
8998
|
*
|
|
8881
8999
|
* @param request DescribeAlarmsRequest
|
|
8882
9000
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8884,7 +9002,7 @@ export default class Client extends OpenApi {
|
|
|
8884
9002
|
*/
|
|
8885
9003
|
describeAlarmsWithOptions(request: DescribeAlarmsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAlarmsResponse>;
|
|
8886
9004
|
/**
|
|
8887
|
-
* @summary Queries event-triggered tasks.
|
|
9005
|
+
* @summary Queries event-triggered tasks. You can call the DescribeAlarms operation to learn about the configurations of event-triggered tasks and keep updated on monitoring data changes. This helps you troubleshoot system resource issues at the earliest opportunity and ensures system stability and reliability.
|
|
8888
9006
|
*
|
|
8889
9007
|
* @param request DescribeAlarmsRequest
|
|
8890
9008
|
* @return DescribeAlarmsResponse
|
|
@@ -9018,7 +9136,7 @@ export default class Client extends OpenApi {
|
|
|
9018
9136
|
*/
|
|
9019
9137
|
describeNotificationTypes(request: DescribeNotificationTypesRequest): Promise<DescribeNotificationTypesResponse>;
|
|
9020
9138
|
/**
|
|
9021
|
-
* @summary DescribePatternTypes
|
|
9139
|
+
* @summary Filters instance types that meet your business requirements. If you create a scaling configuration by opting for the Specify Instance Type approach, you can call the DescribePatternTypes operation. This operation is designed to sift through and identify instance types that fulfill your specific business needs. It does so by examining the number of vCPUs, memory size, instance family level, and maximum budgeted expense that you specify within the scaling configuration settings.
|
|
9022
9140
|
*
|
|
9023
9141
|
* @param request DescribePatternTypesRequest
|
|
9024
9142
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9026,14 +9144,14 @@ export default class Client extends OpenApi {
|
|
|
9026
9144
|
*/
|
|
9027
9145
|
describePatternTypesWithOptions(request: DescribePatternTypesRequest, runtime: $Util.RuntimeOptions): Promise<DescribePatternTypesResponse>;
|
|
9028
9146
|
/**
|
|
9029
|
-
* @summary DescribePatternTypes
|
|
9147
|
+
* @summary Filters instance types that meet your business requirements. If you create a scaling configuration by opting for the Specify Instance Type approach, you can call the DescribePatternTypes operation. This operation is designed to sift through and identify instance types that fulfill your specific business needs. It does so by examining the number of vCPUs, memory size, instance family level, and maximum budgeted expense that you specify within the scaling configuration settings.
|
|
9030
9148
|
*
|
|
9031
9149
|
* @param request DescribePatternTypesRequest
|
|
9032
9150
|
* @return DescribePatternTypesResponse
|
|
9033
9151
|
*/
|
|
9034
9152
|
describePatternTypes(request: DescribePatternTypesRequest): Promise<DescribePatternTypesResponse>;
|
|
9035
9153
|
/**
|
|
9036
|
-
* @summary Queries the regions
|
|
9154
|
+
* @summary Queries regions. Before you activate Auto Scaling, you can call the DescribeRegions operation to query the regions where Auto Scaling is officially launched. This preliminary step facilitates the strategic selection of both the optimal region and availability zones for activating Auto Scaling, thereby guaranteeing the finest access speeds and operational efficiency within your chosen geographical area.
|
|
9037
9155
|
*
|
|
9038
9156
|
* @param request DescribeRegionsRequest
|
|
9039
9157
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9041,7 +9159,7 @@ export default class Client extends OpenApi {
|
|
|
9041
9159
|
*/
|
|
9042
9160
|
describeRegionsWithOptions(request: DescribeRegionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRegionsResponse>;
|
|
9043
9161
|
/**
|
|
9044
|
-
* @summary Queries the regions
|
|
9162
|
+
* @summary Queries regions. Before you activate Auto Scaling, you can call the DescribeRegions operation to query the regions where Auto Scaling is officially launched. This preliminary step facilitates the strategic selection of both the optimal region and availability zones for activating Auto Scaling, thereby guaranteeing the finest access speeds and operational efficiency within your chosen geographical area.
|
|
9045
9163
|
*
|
|
9046
9164
|
* @param request DescribeRegionsRequest
|
|
9047
9165
|
* @return DescribeRegionsResponse
|
|
@@ -9101,7 +9219,7 @@ export default class Client extends OpenApi {
|
|
|
9101
9219
|
*/
|
|
9102
9220
|
describeScalingConfigurations(request: DescribeScalingConfigurationsRequest): Promise<DescribeScalingConfigurationsResponse>;
|
|
9103
9221
|
/**
|
|
9104
|
-
* @summary Queries a scaling group. You can call the DescribeScalingGroupDetail operation to query the basic information, instances, and scaling configurations of a scaling group. If you set OutputFormat to yaml, a Kubernetes Deployment file
|
|
9222
|
+
* @summary Queries a scaling group. You can call the DescribeScalingGroupDetail operation to query the basic information, instances, and scaling configurations of a scaling group. If you set OutputFormat to yaml, the output is a Kubernetes Deployment file in the YAML format.
|
|
9105
9223
|
*
|
|
9106
9224
|
* @param request DescribeScalingGroupDetailRequest
|
|
9107
9225
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9109,7 +9227,7 @@ export default class Client extends OpenApi {
|
|
|
9109
9227
|
*/
|
|
9110
9228
|
describeScalingGroupDetailWithOptions(request: DescribeScalingGroupDetailRequest, runtime: $Util.RuntimeOptions): Promise<DescribeScalingGroupDetailResponse>;
|
|
9111
9229
|
/**
|
|
9112
|
-
* @summary Queries a scaling group. You can call the DescribeScalingGroupDetail operation to query the basic information, instances, and scaling configurations of a scaling group. If you set OutputFormat to yaml, a Kubernetes Deployment file
|
|
9230
|
+
* @summary Queries a scaling group. You can call the DescribeScalingGroupDetail operation to query the basic information, instances, and scaling configurations of a scaling group. If you set OutputFormat to yaml, the output is a Kubernetes Deployment file in the YAML format.
|
|
9113
9231
|
*
|
|
9114
9232
|
* @param request DescribeScalingGroupDetailRequest
|
|
9115
9233
|
* @return DescribeScalingGroupDetailResponse
|
|
@@ -9262,7 +9380,7 @@ export default class Client extends OpenApi {
|
|
|
9262
9380
|
*/
|
|
9263
9381
|
detachLoadBalancers(request: DetachLoadBalancersRequest): Promise<DetachLoadBalancersResponse>;
|
|
9264
9382
|
/**
|
|
9265
|
-
* @summary
|
|
9383
|
+
* @summary Detach server groups from a scaling group. To seamlessly adjust the number of instances in response to changes in your business workload or to maintain the uninterrupted accessibility of your application, you can call the DetachServerGroups operation. By detaching Application Load Balancer (ALB) or Network Load Balancer (NLB) server groups from your scaling group, this operation enables Auto Scaling to automatically tailor your computing capacity to your business needs. Furthermore, it optimizes traffic routing by dynamically allocating incoming requests based on current workload patterns, which significantly improves the stability and performance of your application.
|
|
9266
9384
|
*
|
|
9267
9385
|
* @param request DetachServerGroupsRequest
|
|
9268
9386
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9270,7 +9388,7 @@ export default class Client extends OpenApi {
|
|
|
9270
9388
|
*/
|
|
9271
9389
|
detachServerGroupsWithOptions(request: DetachServerGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DetachServerGroupsResponse>;
|
|
9272
9390
|
/**
|
|
9273
|
-
* @summary
|
|
9391
|
+
* @summary Detach server groups from a scaling group. To seamlessly adjust the number of instances in response to changes in your business workload or to maintain the uninterrupted accessibility of your application, you can call the DetachServerGroups operation. By detaching Application Load Balancer (ALB) or Network Load Balancer (NLB) server groups from your scaling group, this operation enables Auto Scaling to automatically tailor your computing capacity to your business needs. Furthermore, it optimizes traffic routing by dynamically allocating incoming requests based on current workload patterns, which significantly improves the stability and performance of your application.
|
|
9274
9392
|
*
|
|
9275
9393
|
* @param request DetachServerGroupsRequest
|
|
9276
9394
|
* @return DetachServerGroupsResponse
|
|
@@ -9306,7 +9424,9 @@ export default class Client extends OpenApi {
|
|
|
9306
9424
|
*/
|
|
9307
9425
|
detachVServerGroups(request: DetachVServerGroupsRequest): Promise<DetachVServerGroupsResponse>;
|
|
9308
9426
|
/**
|
|
9309
|
-
* @summary Disables an event-triggered task.
|
|
9427
|
+
* @summary Disables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you currently do not need an event-triggered task, you can call the DisableAlarm operation to disable it.
|
|
9428
|
+
*
|
|
9429
|
+
* @description Before you disable an event-triggered task, make sure that the task is in the `Normal`, `Alert`, or `Insufficient Data` state.
|
|
9310
9430
|
*
|
|
9311
9431
|
* @param request DisableAlarmRequest
|
|
9312
9432
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9314,18 +9434,20 @@ export default class Client extends OpenApi {
|
|
|
9314
9434
|
*/
|
|
9315
9435
|
disableAlarmWithOptions(request: DisableAlarmRequest, runtime: $Util.RuntimeOptions): Promise<DisableAlarmResponse>;
|
|
9316
9436
|
/**
|
|
9317
|
-
* @summary Disables an event-triggered task.
|
|
9437
|
+
* @summary Disables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you currently do not need an event-triggered task, you can call the DisableAlarm operation to disable it.
|
|
9438
|
+
*
|
|
9439
|
+
* @description Before you disable an event-triggered task, make sure that the task is in the `Normal`, `Alert`, or `Insufficient Data` state.
|
|
9318
9440
|
*
|
|
9319
9441
|
* @param request DisableAlarmRequest
|
|
9320
9442
|
* @return DisableAlarmResponse
|
|
9321
9443
|
*/
|
|
9322
9444
|
disableAlarm(request: DisableAlarmRequest): Promise<DisableAlarmResponse>;
|
|
9323
9445
|
/**
|
|
9324
|
-
* @summary Disables a scaling group.
|
|
9446
|
+
* @summary Disables a scaling group. If you temporarily do not require a scaling group that is in the Enabled state, you can call the DisableScalingGroup operation to disable it.
|
|
9325
9447
|
*
|
|
9326
9448
|
* @description Before you call this operation to disable a scaling group, take note of the following items:
|
|
9327
|
-
* *
|
|
9328
|
-
* *
|
|
9449
|
+
* * If scaling activities are being executed in the specified scaling group when you call this operation, these activities will continue until they are complete. However, scaling activities that are triggered after this operation is called will be rejected.
|
|
9450
|
+
* * This operation can be called only when the scaling group is in the Active state.
|
|
9329
9451
|
*
|
|
9330
9452
|
* @param request DisableScalingGroupRequest
|
|
9331
9453
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9333,18 +9455,18 @@ export default class Client extends OpenApi {
|
|
|
9333
9455
|
*/
|
|
9334
9456
|
disableScalingGroupWithOptions(request: DisableScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<DisableScalingGroupResponse>;
|
|
9335
9457
|
/**
|
|
9336
|
-
* @summary Disables a scaling group.
|
|
9458
|
+
* @summary Disables a scaling group. If you temporarily do not require a scaling group that is in the Enabled state, you can call the DisableScalingGroup operation to disable it.
|
|
9337
9459
|
*
|
|
9338
9460
|
* @description Before you call this operation to disable a scaling group, take note of the following items:
|
|
9339
|
-
* *
|
|
9340
|
-
* *
|
|
9461
|
+
* * If scaling activities are being executed in the specified scaling group when you call this operation, these activities will continue until they are complete. However, scaling activities that are triggered after this operation is called will be rejected.
|
|
9462
|
+
* * This operation can be called only when the scaling group is in the Active state.
|
|
9341
9463
|
*
|
|
9342
9464
|
* @param request DisableScalingGroupRequest
|
|
9343
9465
|
* @return DisableScalingGroupResponse
|
|
9344
9466
|
*/
|
|
9345
9467
|
disableScalingGroup(request: DisableScalingGroupRequest): Promise<DisableScalingGroupResponse>;
|
|
9346
9468
|
/**
|
|
9347
|
-
* @summary Enables an event-triggered task.
|
|
9469
|
+
* @summary Enables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you want to reuse an event-triggered task that is in the Disabled state, you can call the EnableAlarm operation to enable it.
|
|
9348
9470
|
*
|
|
9349
9471
|
* @param request EnableAlarmRequest
|
|
9350
9472
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9352,20 +9474,21 @@ export default class Client extends OpenApi {
|
|
|
9352
9474
|
*/
|
|
9353
9475
|
enableAlarmWithOptions(request: EnableAlarmRequest, runtime: $Util.RuntimeOptions): Promise<EnableAlarmResponse>;
|
|
9354
9476
|
/**
|
|
9355
|
-
* @summary Enables an event-triggered task.
|
|
9477
|
+
* @summary Enables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you want to reuse an event-triggered task that is in the Disabled state, you can call the EnableAlarm operation to enable it.
|
|
9356
9478
|
*
|
|
9357
9479
|
* @param request EnableAlarmRequest
|
|
9358
9480
|
* @return EnableAlarmResponse
|
|
9359
9481
|
*/
|
|
9360
9482
|
enableAlarm(request: EnableAlarmRequest): Promise<EnableAlarmResponse>;
|
|
9361
9483
|
/**
|
|
9362
|
-
* @summary Enables a scaling group.
|
|
9484
|
+
* @summary Enables a scaling group. If a scaling group is in the Disabled state and contains an instance configuration source such as a launch template or a scaling configuration, you can call the EnableScalingGroup operation to enable the scaling group. This operation permits Auto Scaling to dynamically adjust the computing power (also known as the number of instances) in the scaling group based on your business requirements.
|
|
9363
9485
|
*
|
|
9364
|
-
* @description You can call this operation to enable a scaling group
|
|
9365
|
-
*
|
|
9366
|
-
*
|
|
9367
|
-
* * If
|
|
9368
|
-
*
|
|
9486
|
+
* @description * You can call this operation to enable a scaling group only if the scaling group is in the Inactive state and contains an instance configuration source such as a launch temple or a scaling configuration. The instance configuration source can also be the Elastic Compute Service (ECS) instance that you specified when you created the scaling group. If the preceding requirements are not met, the operation will fail.
|
|
9487
|
+
* **
|
|
9488
|
+
* **Note** A scaling group can have only one active instance configuration source at a time. When you call this operation to enable a scaling group, you can specify a scaling configuration or a launch template for the scaling group. If the scaling group already have an instance configuration source defined prior to your calling, the scaling configuration or launch template specified within your request will supersede the existing scaling configuration or launch template.
|
|
9489
|
+
* * If you specify InstanceId.N to add to the scaling group within your request, Auto Scaling will check whether the addition of InstanceId.N will cause the total number of ECS instances in the scaling group to fall outside the boundaries specified by MinSize and MaxSize after you call this operation.
|
|
9490
|
+
* * If the call results in the total number of ECS instances dropping below the value of MinSize, Auto Scaling proactively creates pay-as-you-go ECS instances to ensure that the total number reaches the minimum threshold. For example, if you set MinSize to 5 when you created a scaling group and include InstanceId.N within your request to add two ECS instances when you attempt to enable the scaling group, Auto Scaling creates three more ECS instances in the scaling group after the two ECS instances are added.
|
|
9491
|
+
* * If the call results in the total number of ECS instances exceeding the value of MaxSize, the operation fails.
|
|
9369
9492
|
*
|
|
9370
9493
|
* @param request EnableScalingGroupRequest
|
|
9371
9494
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9373,13 +9496,14 @@ export default class Client extends OpenApi {
|
|
|
9373
9496
|
*/
|
|
9374
9497
|
enableScalingGroupWithOptions(request: EnableScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<EnableScalingGroupResponse>;
|
|
9375
9498
|
/**
|
|
9376
|
-
* @summary Enables a scaling group.
|
|
9499
|
+
* @summary Enables a scaling group. If a scaling group is in the Disabled state and contains an instance configuration source such as a launch template or a scaling configuration, you can call the EnableScalingGroup operation to enable the scaling group. This operation permits Auto Scaling to dynamically adjust the computing power (also known as the number of instances) in the scaling group based on your business requirements.
|
|
9377
9500
|
*
|
|
9378
|
-
* @description You can call this operation to enable a scaling group
|
|
9379
|
-
*
|
|
9380
|
-
*
|
|
9381
|
-
* * If
|
|
9382
|
-
*
|
|
9501
|
+
* @description * You can call this operation to enable a scaling group only if the scaling group is in the Inactive state and contains an instance configuration source such as a launch temple or a scaling configuration. The instance configuration source can also be the Elastic Compute Service (ECS) instance that you specified when you created the scaling group. If the preceding requirements are not met, the operation will fail.
|
|
9502
|
+
* **
|
|
9503
|
+
* **Note** A scaling group can have only one active instance configuration source at a time. When you call this operation to enable a scaling group, you can specify a scaling configuration or a launch template for the scaling group. If the scaling group already have an instance configuration source defined prior to your calling, the scaling configuration or launch template specified within your request will supersede the existing scaling configuration or launch template.
|
|
9504
|
+
* * If you specify InstanceId.N to add to the scaling group within your request, Auto Scaling will check whether the addition of InstanceId.N will cause the total number of ECS instances in the scaling group to fall outside the boundaries specified by MinSize and MaxSize after you call this operation.
|
|
9505
|
+
* * If the call results in the total number of ECS instances dropping below the value of MinSize, Auto Scaling proactively creates pay-as-you-go ECS instances to ensure that the total number reaches the minimum threshold. For example, if you set MinSize to 5 when you created a scaling group and include InstanceId.N within your request to add two ECS instances when you attempt to enable the scaling group, Auto Scaling creates three more ECS instances in the scaling group after the two ECS instances are added.
|
|
9506
|
+
* * If the call results in the total number of ECS instances exceeding the value of MaxSize, the operation fails.
|
|
9383
9507
|
*
|
|
9384
9508
|
* @param request EnableScalingGroupRequest
|
|
9385
9509
|
* @return EnableScalingGroupResponse
|
|
@@ -9482,7 +9606,10 @@ export default class Client extends OpenApi {
|
|
|
9482
9606
|
*/
|
|
9483
9607
|
listTagKeys(request: ListTagKeysRequest): Promise<ListTagKeysResponse>;
|
|
9484
9608
|
/**
|
|
9485
|
-
* @summary Queries tags that are added to
|
|
9609
|
+
* @summary Queries tags. You can call the ListTagResources operation to query tags that are added to Auto Scaling resources, thereby clarifying resource utilization and facilitating efficient management. This operation aids in the automation of resource categorization and permission management processes.
|
|
9610
|
+
*
|
|
9611
|
+
* @description * Specify at least one of the following request parameters: `ResourceIds` and `Tags`. `Tags.Key` and `Tags.Value` are used to specify the query objects.
|
|
9612
|
+
* * If you provide both `ResourceIds` and `Tags` in your request, the response will exclusively include Auto Scaling resources that satisfy the criteria set by these parameters, ensuring targeted and precise information retrieval.
|
|
9486
9613
|
*
|
|
9487
9614
|
* @param request ListTagResourcesRequest
|
|
9488
9615
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9490,14 +9617,17 @@ export default class Client extends OpenApi {
|
|
|
9490
9617
|
*/
|
|
9491
9618
|
listTagResourcesWithOptions(request: ListTagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<ListTagResourcesResponse>;
|
|
9492
9619
|
/**
|
|
9493
|
-
* @summary Queries tags that are added to
|
|
9620
|
+
* @summary Queries tags. You can call the ListTagResources operation to query tags that are added to Auto Scaling resources, thereby clarifying resource utilization and facilitating efficient management. This operation aids in the automation of resource categorization and permission management processes.
|
|
9621
|
+
*
|
|
9622
|
+
* @description * Specify at least one of the following request parameters: `ResourceIds` and `Tags`. `Tags.Key` and `Tags.Value` are used to specify the query objects.
|
|
9623
|
+
* * If you provide both `ResourceIds` and `Tags` in your request, the response will exclusively include Auto Scaling resources that satisfy the criteria set by these parameters, ensuring targeted and precise information retrieval.
|
|
9494
9624
|
*
|
|
9495
9625
|
* @param request ListTagResourcesRequest
|
|
9496
9626
|
* @return ListTagResourcesResponse
|
|
9497
9627
|
*/
|
|
9498
9628
|
listTagResources(request: ListTagResourcesRequest): Promise<ListTagResourcesResponse>;
|
|
9499
9629
|
/**
|
|
9500
|
-
* @summary Queries tag
|
|
9630
|
+
* @summary Queries the tag keys associated with Auto Scaling resources to facilitate a deeper comprehension of those resources. By doing so, you can categorize and manage your Auto Scaling resources more efficiently.
|
|
9501
9631
|
*
|
|
9502
9632
|
* @param request ListTagValuesRequest
|
|
9503
9633
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9505,7 +9635,7 @@ export default class Client extends OpenApi {
|
|
|
9505
9635
|
*/
|
|
9506
9636
|
listTagValuesWithOptions(request: ListTagValuesRequest, runtime: $Util.RuntimeOptions): Promise<ListTagValuesResponse>;
|
|
9507
9637
|
/**
|
|
9508
|
-
* @summary Queries tag
|
|
9638
|
+
* @summary Queries the tag keys associated with Auto Scaling resources to facilitate a deeper comprehension of those resources. By doing so, you can categorize and manage your Auto Scaling resources more efficiently.
|
|
9509
9639
|
*
|
|
9510
9640
|
* @param request ListTagValuesRequest
|
|
9511
9641
|
* @return ListTagValuesResponse
|
|
@@ -9630,19 +9760,21 @@ export default class Client extends OpenApi {
|
|
|
9630
9760
|
*/
|
|
9631
9761
|
modifyScalingConfiguration(request: ModifyScalingConfigurationRequest): Promise<ModifyScalingConfigurationResponse>;
|
|
9632
9762
|
/**
|
|
9633
|
-
* @summary Modifies a scaling group.
|
|
9763
|
+
* @summary Modifies a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can modify scaling groups to adjust your computing power with ease. The computing power refers to the instances that provide the computing capability. When your scaling group cannot meet your business requirements, you can call the ModifyScalingGroup operation to modify scaling group attributes such as the maximum, minimum, and expected numbers of instances. This prevents repeated creation and configuration of scaling groups, which saves you a lot of time and resource costs.
|
|
9634
9764
|
*
|
|
9635
|
-
* @description * You cannot
|
|
9765
|
+
* @description * You cannot modify the following parameters by calling this operation:
|
|
9636
9766
|
* * RegionId
|
|
9637
9767
|
* * LoadBalancerId
|
|
9638
|
-
*
|
|
9768
|
+
* **
|
|
9769
|
+
* **Note** If you want to modify the load balancer settings of your scaling group, you can call the AttachLoadBalancers operation or the DetachLoadBalancers operation.
|
|
9639
9770
|
* * DBInstanceId
|
|
9640
|
-
*
|
|
9641
|
-
*
|
|
9642
|
-
* *
|
|
9643
|
-
* *
|
|
9644
|
-
* * If the
|
|
9645
|
-
* * If the
|
|
9771
|
+
* **
|
|
9772
|
+
* **Note** If you want to modify the ApsaraDB RDS instance settings of your scaling group, you can call the AttachDBInstances operation or the DetachDBInstances operation.
|
|
9773
|
+
* * You can call this operation to modify a scaling group only when the scaling group is in the `Active` or `Inactive` state.
|
|
9774
|
+
* * Enabling a new scaling configuration in the scaling group will not impact existing Elastic Compute Service (ECS) instances or elastic container instances that were provisioned based on the previous scaling configuration. These instances will continue to run as expected.
|
|
9775
|
+
* * If the modification of the MaxSize setting leads to the total number of ECS instances or elastic container instances in the scaling group exceeding the new maximum limit, Auto Scaling proactively removes the surplus instances to restore the total number to match the new maximum limit.
|
|
9776
|
+
* * If the modification of the MinSize setting leads to the total number of ECS instances or elastic container instances in the scaling group exceeding the new minimum threshold, Auto Scaling proactively adds more instances to the scaling group to ensure that the total number aligns with the new minimum threshold.
|
|
9777
|
+
* * If the modification of the DesiredCapacity setting leads to the total number of ECS instances or elastic container instances in the scaling group not matching the new desired capacity, Auto Scaling proactively adjusts the total number of instances to ensure that the total number aligns with the new desired capacity.
|
|
9646
9778
|
*
|
|
9647
9779
|
* @param request ModifyScalingGroupRequest
|
|
9648
9780
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9650,19 +9782,21 @@ export default class Client extends OpenApi {
|
|
|
9650
9782
|
*/
|
|
9651
9783
|
modifyScalingGroupWithOptions(request: ModifyScalingGroupRequest, runtime: $Util.RuntimeOptions): Promise<ModifyScalingGroupResponse>;
|
|
9652
9784
|
/**
|
|
9653
|
-
* @summary Modifies a scaling group.
|
|
9785
|
+
* @summary Modifies a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can modify scaling groups to adjust your computing power with ease. The computing power refers to the instances that provide the computing capability. When your scaling group cannot meet your business requirements, you can call the ModifyScalingGroup operation to modify scaling group attributes such as the maximum, minimum, and expected numbers of instances. This prevents repeated creation and configuration of scaling groups, which saves you a lot of time and resource costs.
|
|
9654
9786
|
*
|
|
9655
|
-
* @description * You cannot
|
|
9787
|
+
* @description * You cannot modify the following parameters by calling this operation:
|
|
9656
9788
|
* * RegionId
|
|
9657
9789
|
* * LoadBalancerId
|
|
9658
|
-
*
|
|
9790
|
+
* **
|
|
9791
|
+
* **Note** If you want to modify the load balancer settings of your scaling group, you can call the AttachLoadBalancers operation or the DetachLoadBalancers operation.
|
|
9659
9792
|
* * DBInstanceId
|
|
9660
|
-
*
|
|
9661
|
-
*
|
|
9662
|
-
* *
|
|
9663
|
-
* *
|
|
9664
|
-
* * If the
|
|
9665
|
-
* * If the
|
|
9793
|
+
* **
|
|
9794
|
+
* **Note** If you want to modify the ApsaraDB RDS instance settings of your scaling group, you can call the AttachDBInstances operation or the DetachDBInstances operation.
|
|
9795
|
+
* * You can call this operation to modify a scaling group only when the scaling group is in the `Active` or `Inactive` state.
|
|
9796
|
+
* * Enabling a new scaling configuration in the scaling group will not impact existing Elastic Compute Service (ECS) instances or elastic container instances that were provisioned based on the previous scaling configuration. These instances will continue to run as expected.
|
|
9797
|
+
* * If the modification of the MaxSize setting leads to the total number of ECS instances or elastic container instances in the scaling group exceeding the new maximum limit, Auto Scaling proactively removes the surplus instances to restore the total number to match the new maximum limit.
|
|
9798
|
+
* * If the modification of the MinSize setting leads to the total number of ECS instances or elastic container instances in the scaling group exceeding the new minimum threshold, Auto Scaling proactively adds more instances to the scaling group to ensure that the total number aligns with the new minimum threshold.
|
|
9799
|
+
* * If the modification of the DesiredCapacity setting leads to the total number of ECS instances or elastic container instances in the scaling group not matching the new desired capacity, Auto Scaling proactively adjusts the total number of instances to ensure that the total number aligns with the new desired capacity.
|
|
9666
9800
|
*
|
|
9667
9801
|
* @param request ModifyScalingGroupRequest
|
|
9668
9802
|
* @return ModifyScalingGroupResponse
|
|
@@ -9807,16 +9941,15 @@ export default class Client extends OpenApi {
|
|
|
9807
9941
|
*/
|
|
9808
9942
|
resumeProcesses(request: ResumeProcessesRequest): Promise<ResumeProcessesResponse>;
|
|
9809
9943
|
/**
|
|
9810
|
-
* @summary Scales instances in
|
|
9944
|
+
* @summary Scales instances. The ScaleWithAdjustment operation differs from the ExecuteScalingRule operation in that ScaleWithAdjust can directly scale instances without requiring you to create a scaling rule in advance.
|
|
9811
9945
|
*
|
|
9812
|
-
* @description
|
|
9813
|
-
* * The following conditions must be met:
|
|
9946
|
+
* @description * Before you call this operation, take note of the following items:
|
|
9814
9947
|
* * The scaling group is in the Active state.
|
|
9815
|
-
* *
|
|
9816
|
-
* * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities
|
|
9817
|
-
* * If the addition of a
|
|
9818
|
-
* * If the removal of a
|
|
9819
|
-
* A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity
|
|
9948
|
+
* * The scaling group has no ongoing scaling activities.
|
|
9949
|
+
* * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities before the cooldown period of the scaling group expires.
|
|
9950
|
+
* * If the addition of a specific number of Elastic Compute Service (ECS) instances to the scaling group causes the total number of ECS instances in the scaling group to exceed the maximum allowed number, Auto Scaling adds ECS instances to the scaling group until the total number of instances is equal to the maximum allowed number.
|
|
9951
|
+
* * If the removal of a specific number of ECS instances from the scaling group causes the total number of ECS instances in the scaling group to be less than the minimum allowed number, Auto Scaling removes ECS instances from the scaling group until the total number of instances is equal to the minimum allowed number.
|
|
9952
|
+
* A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity based on the value of `ScalingActivityId` in the response.
|
|
9820
9953
|
*
|
|
9821
9954
|
* @param tmpReq ScaleWithAdjustmentRequest
|
|
9822
9955
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9824,16 +9957,15 @@ export default class Client extends OpenApi {
|
|
|
9824
9957
|
*/
|
|
9825
9958
|
scaleWithAdjustmentWithOptions(tmpReq: ScaleWithAdjustmentRequest, runtime: $Util.RuntimeOptions): Promise<ScaleWithAdjustmentResponse>;
|
|
9826
9959
|
/**
|
|
9827
|
-
* @summary Scales instances in
|
|
9960
|
+
* @summary Scales instances. The ScaleWithAdjustment operation differs from the ExecuteScalingRule operation in that ScaleWithAdjust can directly scale instances without requiring you to create a scaling rule in advance.
|
|
9828
9961
|
*
|
|
9829
|
-
* @description
|
|
9830
|
-
* * The following conditions must be met:
|
|
9962
|
+
* @description * Before you call this operation, take note of the following items:
|
|
9831
9963
|
* * The scaling group is in the Active state.
|
|
9832
|
-
* *
|
|
9833
|
-
* * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities
|
|
9834
|
-
* * If the addition of a
|
|
9835
|
-
* * If the removal of a
|
|
9836
|
-
* A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity
|
|
9964
|
+
* * The scaling group has no ongoing scaling activities.
|
|
9965
|
+
* * If no scaling activities in the scaling group are in progress, the operation can trigger scaling activities before the cooldown period of the scaling group expires.
|
|
9966
|
+
* * If the addition of a specific number of Elastic Compute Service (ECS) instances to the scaling group causes the total number of ECS instances in the scaling group to exceed the maximum allowed number, Auto Scaling adds ECS instances to the scaling group until the total number of instances is equal to the maximum allowed number.
|
|
9967
|
+
* * If the removal of a specific number of ECS instances from the scaling group causes the total number of ECS instances in the scaling group to be less than the minimum allowed number, Auto Scaling removes ECS instances from the scaling group until the total number of instances is equal to the minimum allowed number.
|
|
9968
|
+
* A successful call indicates that Auto Scaling accepts the request. However, the scaling activity may still fail. You can obtain the status of a scaling activity based on the value of `ScalingActivityId` in the response.
|
|
9837
9969
|
*
|
|
9838
9970
|
* @param request ScaleWithAdjustmentRequest
|
|
9839
9971
|
* @return ScaleWithAdjustmentResponse
|
|
@@ -9874,13 +10006,12 @@ export default class Client extends OpenApi {
|
|
|
9874
10006
|
*/
|
|
9875
10007
|
setInstanceHealth(request: SetInstanceHealthRequest): Promise<SetInstanceHealthResponse>;
|
|
9876
10008
|
/**
|
|
9877
|
-
* @summary Puts
|
|
10009
|
+
* @summary Puts Elastic Compute Service (ECS) instances into the Protected state. When ECS instances are put into the Protected state, they become immune to manual deletion attempts by using the Auto Scaling console or API operations. This operation serves as a robust safeguard, efficiently preventing any inadvertent instance release that could lead to irreversible consequences.
|
|
9878
10010
|
*
|
|
9879
|
-
* @description
|
|
9880
|
-
*
|
|
9881
|
-
* *
|
|
9882
|
-
* *
|
|
9883
|
-
* * After you put an ECS instance into the Protected state, Auto Scaling does not update the health status of the instance when the instance is stopped or restarted.
|
|
10011
|
+
* @description Once ECS instances enter the Protected state, they become subject to the following restrictions:
|
|
10012
|
+
* * ECS instances will persist in the Protected state, unless you deliberately remove them from this state.
|
|
10013
|
+
* * Even in scenarios where automatic scale-in actions are initiated due to fluctuations in the number of ECS instances or the execution of event-triggered tasks, Auto Scaling does not remove ECS instances that are in the Protected state from their respective scaling groups. Only after being manually removed from their respective scaling groups can ECS instances that are in the Protected state be released. For more information, see [Remove an ECS instance](https://help.aliyun.com/document_detail/25955.html).
|
|
10014
|
+
* * ECS instances in the Protected state maintain their existing health status even when they undergo stopping or restarting processes.
|
|
9884
10015
|
*
|
|
9885
10016
|
* @param request SetInstancesProtectionRequest
|
|
9886
10017
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9888,20 +10019,19 @@ export default class Client extends OpenApi {
|
|
|
9888
10019
|
*/
|
|
9889
10020
|
setInstancesProtectionWithOptions(request: SetInstancesProtectionRequest, runtime: $Util.RuntimeOptions): Promise<SetInstancesProtectionResponse>;
|
|
9890
10021
|
/**
|
|
9891
|
-
* @summary Puts
|
|
10022
|
+
* @summary Puts Elastic Compute Service (ECS) instances into the Protected state. When ECS instances are put into the Protected state, they become immune to manual deletion attempts by using the Auto Scaling console or API operations. This operation serves as a robust safeguard, efficiently preventing any inadvertent instance release that could lead to irreversible consequences.
|
|
9892
10023
|
*
|
|
9893
|
-
* @description
|
|
9894
|
-
*
|
|
9895
|
-
* *
|
|
9896
|
-
* *
|
|
9897
|
-
* * After you put an ECS instance into the Protected state, Auto Scaling does not update the health status of the instance when the instance is stopped or restarted.
|
|
10024
|
+
* @description Once ECS instances enter the Protected state, they become subject to the following restrictions:
|
|
10025
|
+
* * ECS instances will persist in the Protected state, unless you deliberately remove them from this state.
|
|
10026
|
+
* * Even in scenarios where automatic scale-in actions are initiated due to fluctuations in the number of ECS instances or the execution of event-triggered tasks, Auto Scaling does not remove ECS instances that are in the Protected state from their respective scaling groups. Only after being manually removed from their respective scaling groups can ECS instances that are in the Protected state be released. For more information, see [Remove an ECS instance](https://help.aliyun.com/document_detail/25955.html).
|
|
10027
|
+
* * ECS instances in the Protected state maintain their existing health status even when they undergo stopping or restarting processes.
|
|
9898
10028
|
*
|
|
9899
10029
|
* @param request SetInstancesProtectionRequest
|
|
9900
10030
|
* @return SetInstancesProtectionResponse
|
|
9901
10031
|
*/
|
|
9902
10032
|
setInstancesProtection(request: SetInstancesProtectionRequest): Promise<SetInstancesProtectionResponse>;
|
|
9903
10033
|
/**
|
|
9904
|
-
* @summary Suspends processes
|
|
10034
|
+
* @summary Suspends scaling processes. This operation empowers you to selectively pause distinct scaling processes within a particular scaling group, enabling you to carry out alternative tasks and achieve more granular management over your scaling operations.
|
|
9905
10035
|
*
|
|
9906
10036
|
* @param request SuspendProcessesRequest
|
|
9907
10037
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9909,14 +10039,22 @@ export default class Client extends OpenApi {
|
|
|
9909
10039
|
*/
|
|
9910
10040
|
suspendProcessesWithOptions(request: SuspendProcessesRequest, runtime: $Util.RuntimeOptions): Promise<SuspendProcessesResponse>;
|
|
9911
10041
|
/**
|
|
9912
|
-
* @summary Suspends processes
|
|
10042
|
+
* @summary Suspends scaling processes. This operation empowers you to selectively pause distinct scaling processes within a particular scaling group, enabling you to carry out alternative tasks and achieve more granular management over your scaling operations.
|
|
9913
10043
|
*
|
|
9914
10044
|
* @param request SuspendProcessesRequest
|
|
9915
10045
|
* @return SuspendProcessesResponse
|
|
9916
10046
|
*/
|
|
9917
10047
|
suspendProcesses(request: SuspendProcessesRequest): Promise<SuspendProcessesResponse>;
|
|
9918
10048
|
/**
|
|
9919
|
-
* @summary
|
|
10049
|
+
* @summary Creates and attaches tags. You can call the TagResources operation to uniformly create and attach tags to your Auto Scaling resources, streamlining resource management. This capability empowers you to categorize resources based on tags, thereby enhancing the overall efficiency of resource allocation and utilization.
|
|
10050
|
+
*
|
|
10051
|
+
* @description * You can attach up to 20 tags to a scaling group.
|
|
10052
|
+
* **
|
|
10053
|
+
* **Note** Before you attach tags to a specific Auto Scaling resource, Alibaba Cloud automatically verifies the current number of tags attached to that resource. In the event the proposed addition would exceed the maximum allowed number of tags, an error message will be promptly returned after you call this operation.
|
|
10054
|
+
* * If you set `Tags.Propagate` to `true`, any tags attached to your scaling group will be automatically propagated to new instances that are subsequently created in the scaling group, without affecting existing instances.
|
|
10055
|
+
* * If both the scaling configuration and the scaling group have tags attached, and tag propagation from the scaling group is enabled, the tags of newly created instances comply with the following rules:
|
|
10056
|
+
* * Instances set to join the scaling group will inherit the following tags: tags attached to the scaling configuration that initiates the instance creation and tags attached to the scaling group that are allowed to propagate to these instances upon instance creation.
|
|
10057
|
+
* * If the tag keys of the scaling configuration and those attached to the scaling group and propagated to the instances are identical, the tags attached to the scaling group and propagated to the instances will be overwritten by the tags of the scaling configuration.
|
|
9920
10058
|
*
|
|
9921
10059
|
* @param request TagResourcesRequest
|
|
9922
10060
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9924,14 +10062,22 @@ export default class Client extends OpenApi {
|
|
|
9924
10062
|
*/
|
|
9925
10063
|
tagResourcesWithOptions(request: TagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<TagResourcesResponse>;
|
|
9926
10064
|
/**
|
|
9927
|
-
* @summary
|
|
10065
|
+
* @summary Creates and attaches tags. You can call the TagResources operation to uniformly create and attach tags to your Auto Scaling resources, streamlining resource management. This capability empowers you to categorize resources based on tags, thereby enhancing the overall efficiency of resource allocation and utilization.
|
|
10066
|
+
*
|
|
10067
|
+
* @description * You can attach up to 20 tags to a scaling group.
|
|
10068
|
+
* **
|
|
10069
|
+
* **Note** Before you attach tags to a specific Auto Scaling resource, Alibaba Cloud automatically verifies the current number of tags attached to that resource. In the event the proposed addition would exceed the maximum allowed number of tags, an error message will be promptly returned after you call this operation.
|
|
10070
|
+
* * If you set `Tags.Propagate` to `true`, any tags attached to your scaling group will be automatically propagated to new instances that are subsequently created in the scaling group, without affecting existing instances.
|
|
10071
|
+
* * If both the scaling configuration and the scaling group have tags attached, and tag propagation from the scaling group is enabled, the tags of newly created instances comply with the following rules:
|
|
10072
|
+
* * Instances set to join the scaling group will inherit the following tags: tags attached to the scaling configuration that initiates the instance creation and tags attached to the scaling group that are allowed to propagate to these instances upon instance creation.
|
|
10073
|
+
* * If the tag keys of the scaling configuration and those attached to the scaling group and propagated to the instances are identical, the tags attached to the scaling group and propagated to the instances will be overwritten by the tags of the scaling configuration.
|
|
9928
10074
|
*
|
|
9929
10075
|
* @param request TagResourcesRequest
|
|
9930
10076
|
* @return TagResourcesResponse
|
|
9931
10077
|
*/
|
|
9932
10078
|
tagResources(request: TagResourcesRequest): Promise<TagResourcesResponse>;
|
|
9933
10079
|
/**
|
|
9934
|
-
* @summary Removes tags from
|
|
10080
|
+
* @summary Removes tags from Auto Scaling resources simultaneously. This operation streamlines resource management activities, enhances system efficiency, and mitigates potential security vulnerabilities. Once a tag is removed from a particular resource, and if it is not re-added to any other resource, the system will automatically delete the unused tag.
|
|
9935
10081
|
*
|
|
9936
10082
|
* @param request UntagResourcesRequest
|
|
9937
10083
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9939,7 +10085,7 @@ export default class Client extends OpenApi {
|
|
|
9939
10085
|
*/
|
|
9940
10086
|
untagResourcesWithOptions(request: UntagResourcesRequest, runtime: $Util.RuntimeOptions): Promise<UntagResourcesResponse>;
|
|
9941
10087
|
/**
|
|
9942
|
-
* @summary Removes tags from
|
|
10088
|
+
* @summary Removes tags from Auto Scaling resources simultaneously. This operation streamlines resource management activities, enhances system efficiency, and mitigates potential security vulnerabilities. Once a tag is removed from a particular resource, and if it is not re-added to any other resource, the system will automatically delete the unused tag.
|
|
9943
10089
|
*
|
|
9944
10090
|
* @param request UntagResourcesRequest
|
|
9945
10091
|
* @return UntagResourcesResponse
|
|
@@ -9961,7 +10107,7 @@ export default class Client extends OpenApi {
|
|
|
9961
10107
|
*/
|
|
9962
10108
|
verifyAuthentication(request: VerifyAuthenticationRequest): Promise<VerifyAuthenticationResponse>;
|
|
9963
10109
|
/**
|
|
9964
|
-
* @summary
|
|
10110
|
+
* @summary Verifies whether Auto Scaling is activated. This operation guarantees that in response to shifts in business workloads or variations in incoming traffic, the system will automatically adjust resource provisioning. This auto-scaling capability enhances the overall system performance, ensuring high availability and improved flexibility to accommodate dynamic demands.
|
|
9965
10111
|
*
|
|
9966
10112
|
* @param request VerifyUserRequest
|
|
9967
10113
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -9969,7 +10115,7 @@ export default class Client extends OpenApi {
|
|
|
9969
10115
|
*/
|
|
9970
10116
|
verifyUserWithOptions(request: VerifyUserRequest, runtime: $Util.RuntimeOptions): Promise<VerifyUserResponse>;
|
|
9971
10117
|
/**
|
|
9972
|
-
* @summary
|
|
10118
|
+
* @summary Verifies whether Auto Scaling is activated. This operation guarantees that in response to shifts in business workloads or variations in incoming traffic, the system will automatically adjust resource provisioning. This auto-scaling capability enhances the overall system performance, ensuring high availability and improved flexibility to accommodate dynamic demands.
|
|
9973
10119
|
*
|
|
9974
10120
|
* @param request VerifyUserRequest
|
|
9975
10121
|
* @return VerifyUserResponse
|