@alicloud/ecs20140526 7.8.6 → 7.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +949 -954
- package/dist/client.js +978 -950
- package/dist/client.js.map +1 -1
- package/dist/models/AcceptInquiredSystemEventRequest.d.ts +3 -3
- package/dist/models/AssignIpv6addressesRequest.d.ts +7 -7
- package/dist/models/AssignIpv6addressesResponseBody.d.ts +1 -1
- package/dist/models/AssignPrivateIpAddressesRequest.d.ts +13 -16
- package/dist/models/AssignPrivateIpAddressesRequest.js.map +1 -1
- package/dist/models/AssignPrivateIpAddressesResponseBody.d.ts +2 -2
- package/dist/models/AttachNetworkInterfaceRequest.d.ts +6 -7
- package/dist/models/AttachNetworkInterfaceRequest.js.map +1 -1
- package/dist/models/AuthorizeSecurityGroupEgressRequest.d.ts +73 -100
- package/dist/models/AuthorizeSecurityGroupEgressRequest.js.map +1 -1
- package/dist/models/AuthorizeSecurityGroupRequest.d.ts +70 -91
- package/dist/models/AuthorizeSecurityGroupRequest.js.map +1 -1
- package/dist/models/AuthorizeSecurityGroupResponseBody.d.ts +1 -1
- package/dist/models/CancelImagePipelineExecutionRequest.d.ts +2 -2
- package/dist/models/CloneDisksRequest.d.ts +55 -80
- package/dist/models/CloneDisksRequest.js.map +1 -1
- package/dist/models/CloneDisksResponseBody.d.ts +2 -2
- package/dist/models/CreateActivationRequest.d.ts +17 -16
- package/dist/models/CreateActivationRequest.js.map +1 -1
- package/dist/models/CreateActivationResponseBody.d.ts +3 -3
- package/dist/models/CreateAutoProvisioningGroupRequest.d.ts +286 -380
- package/dist/models/CreateAutoProvisioningGroupRequest.js.map +1 -1
- package/dist/models/CreateAutoProvisioningGroupShrinkRequest.d.ts +282 -375
- package/dist/models/CreateAutoProvisioningGroupShrinkRequest.js.map +1 -1
- package/dist/models/CreateCommandRequest.d.ts +52 -73
- package/dist/models/CreateCommandRequest.js.map +1 -1
- package/dist/models/CreateCommandResponseBody.d.ts +2 -2
- package/dist/models/CreateDiskRequest.d.ts +57 -59
- package/dist/models/CreateDiskRequest.js.map +1 -1
- package/dist/models/CreateDiskResponseBody.d.ts +3 -3
- package/dist/models/CreateHpcClusterRequest.d.ts +5 -5
- package/dist/models/CreateHpcClusterResponseBody.d.ts +2 -2
- package/dist/models/CreateImageComponentRequest.d.ts +7 -7
- package/dist/models/CreateImageComponentResponseBody.d.ts +1 -1
- package/dist/models/CreateImageRequest.d.ts +43 -88
- package/dist/models/CreateImageRequest.js.map +1 -1
- package/dist/models/CreateImageResponseBody.d.ts +2 -2
- package/dist/models/CreateInstanceRequest.d.ts +184 -274
- package/dist/models/CreateInstanceRequest.js.map +1 -1
- package/dist/models/CreateInstanceResponseBody.d.ts +2 -2
- package/dist/models/CreateLaunchTemplateRequest.d.ts +235 -278
- package/dist/models/CreateLaunchTemplateRequest.js.map +1 -1
- package/dist/models/CreateLaunchTemplateResponseBody.d.ts +3 -3
- package/dist/models/CreateLaunchTemplateVersionRequest.d.ts +215 -244
- package/dist/models/CreateLaunchTemplateVersionRequest.js.map +1 -1
- package/dist/models/CreateLaunchTemplateVersionResponseBody.d.ts +2 -2
- package/dist/models/CreateSecurityGroupRequest.d.ts +13 -16
- package/dist/models/CreateSecurityGroupRequest.js.map +1 -1
- package/dist/models/CreateSecurityGroupResponseBody.d.ts +1 -1
- package/dist/models/CreateVswitchRequest.d.ts +0 -29
- package/dist/models/CreateVswitchRequest.js.map +1 -1
- package/dist/models/CreateVswitchResponseBody.d.ts +0 -8
- package/dist/models/CreateVswitchResponseBody.js.map +1 -1
- package/dist/models/DeleteHpcClusterRequest.d.ts +2 -2
- package/dist/models/DeleteImagePipelineRequest.d.ts +1 -1
- package/dist/models/DescribeAutoProvisioningGroupInstancesRequest.d.ts +5 -5
- package/dist/models/DescribeAutoProvisioningGroupInstancesResponseBody.d.ts +1 -1
- package/dist/models/DescribeAutoSnapshotPolicyExRequest.d.ts +11 -11
- package/dist/models/DescribeAutoSnapshotPolicyExResponseBody.d.ts +3 -3
- package/dist/models/DescribeAvailableResourceRequest.d.ts +50 -84
- package/dist/models/DescribeAvailableResourceRequest.js.map +1 -1
- package/dist/models/DescribeAvailableResourceResponseBody.d.ts +0 -4
- package/dist/models/DescribeAvailableResourceResponseBody.js.map +1 -1
- package/dist/models/DescribeDisksRequest.d.ts +40 -40
- package/dist/models/DescribeDisksResponseBody.d.ts +3 -3
- package/dist/models/DescribeImageComponentsRequest.d.ts +3 -3
- package/dist/models/DescribeImageComponentsResponseBody.d.ts +1 -1
- package/dist/models/DescribeImagesRequest.d.ts +61 -89
- package/dist/models/DescribeImagesRequest.js.map +1 -1
- package/dist/models/DescribeImagesResponseBody.d.ts +5 -5
- package/dist/models/DescribeInstanceAttributeRequest.d.ts +1 -1
- package/dist/models/DescribeInstanceAttributeResponseBody.d.ts +64 -96
- package/dist/models/DescribeInstanceAttributeResponseBody.js.map +1 -1
- package/dist/models/DescribeInstanceHistoryEventsRequest.d.ts +50 -85
- package/dist/models/DescribeInstanceHistoryEventsRequest.js.map +1 -1
- package/dist/models/DescribeInstanceHistoryEventsResponseBody.d.ts +16 -18
- package/dist/models/DescribeInstanceHistoryEventsResponseBody.js +2 -0
- package/dist/models/DescribeInstanceHistoryEventsResponseBody.js.map +1 -1
- package/dist/models/DescribeInstanceTopologyResponseBody.d.ts +14 -0
- package/dist/models/DescribeInstanceTopologyResponseBody.js +28 -1
- package/dist/models/DescribeInstanceTopologyResponseBody.js.map +1 -1
- package/dist/models/DescribeInstancesRequest.d.ts +54 -68
- package/dist/models/DescribeInstancesRequest.js.map +1 -1
- package/dist/models/DescribeInstancesResponseBody.d.ts +5 -5
- package/dist/models/DescribeInvocationResultsRequest.d.ts +52 -69
- package/dist/models/DescribeInvocationResultsRequest.js.map +1 -1
- package/dist/models/DescribeInvocationResultsResponseBody.d.ts +6 -52
- package/dist/models/DescribeInvocationResultsResponseBody.js.map +1 -1
- package/dist/models/DescribeInvocationsRequest.d.ts +49 -76
- package/dist/models/DescribeInvocationsRequest.js.map +1 -1
- package/dist/models/DescribeInvocationsResponseBody.d.ts +5 -5
- package/dist/models/DescribeLaunchTemplateVersionsRequest.d.ts +14 -14
- package/dist/models/DescribeLaunchTemplateVersionsResponseBody.d.ts +3 -3
- package/dist/models/DescribeNetworkInterfacePermissionsRequest.d.ts +4 -4
- package/dist/models/DescribePriceRequest.d.ts +158 -242
- package/dist/models/DescribePriceRequest.js.map +1 -1
- package/dist/models/DescribePriceResponseBody.d.ts +15 -15
- package/dist/models/DescribeRecommendInstanceTypeRequest.d.ts +45 -57
- package/dist/models/DescribeRecommendInstanceTypeRequest.js.map +1 -1
- package/dist/models/DescribeResourcesModificationRequest.d.ts +26 -37
- package/dist/models/DescribeResourcesModificationRequest.js.map +1 -1
- package/dist/models/DescribeSecurityGroupAttributeRequest.d.ts +17 -28
- package/dist/models/DescribeSecurityGroupAttributeRequest.js.map +1 -1
- package/dist/models/DescribeSecurityGroupAttributeResponseBody.d.ts +10 -9
- package/dist/models/DescribeSecurityGroupAttributeResponseBody.js.map +1 -1
- package/dist/models/DescribeSecurityGroupsRequest.d.ts +20 -20
- package/dist/models/DescribeSecurityGroupsResponseBody.d.ts +4 -4
- package/dist/models/DescribeSendFileResultsRequest.d.ts +21 -25
- package/dist/models/DescribeSendFileResultsRequest.js.map +1 -1
- package/dist/models/DescribeSendFileResultsResponseBody.d.ts +3 -3
- package/dist/models/DescribeSnapshotsRequest.d.ts +44 -59
- package/dist/models/DescribeSnapshotsRequest.js.map +1 -1
- package/dist/models/DescribeSnapshotsResponseBody.d.ts +4 -8
- package/dist/models/DescribeSnapshotsResponseBody.js.map +1 -1
- package/dist/models/DescribeSpotPriceHistoryRequest.d.ts +22 -28
- package/dist/models/DescribeSpotPriceHistoryRequest.js.map +1 -1
- package/dist/models/DescribeSpotPriceHistoryResponseBody.d.ts +7 -3
- package/dist/models/DescribeSpotPriceHistoryResponseBody.js.map +1 -1
- package/dist/models/DescribeTerminalSessionsRequest.d.ts +3 -3
- package/dist/models/DescribeTerminalSessionsResponseBody.d.ts +1 -1
- package/dist/models/DescribeZonesRequest.d.ts +18 -28
- package/dist/models/DescribeZonesRequest.js.map +1 -1
- package/dist/models/DescribeZonesResponseBody.d.ts +1 -1
- package/dist/models/GetInstanceConsoleOutputRequest.d.ts +1 -1
- package/dist/models/GetInstanceConsoleOutputResponseBody.d.ts +2 -2
- package/dist/models/ModifyHpcClusterAttributeRequest.d.ts +1 -1
- package/dist/models/ModifyInstanceAttributeRequest.d.ts +78 -106
- package/dist/models/ModifyInstanceAttributeRequest.js.map +1 -1
- package/dist/models/ModifyInstanceNetworkSpecRequest.d.ts +14 -14
- package/dist/models/ModifyInstanceNetworkSpecResponseBody.d.ts +1 -1
- package/dist/models/ModifyInstanceSpecRequest.d.ts +16 -16
- package/dist/models/ModifyPlanMaintenanceWindowRequest.d.ts +4 -4
- package/dist/models/ModifyPrepayInstanceSpecRequest.d.ts +28 -46
- package/dist/models/ModifyPrepayInstanceSpecRequest.js.map +1 -1
- package/dist/models/ModifyPrepayInstanceSpecResponseBody.d.ts +2 -2
- package/dist/models/ModifySecurityGroupEgressRuleRequest.d.ts +47 -46
- package/dist/models/ModifySecurityGroupEgressRuleRequest.js.map +1 -1
- package/dist/models/ModifySecurityGroupRuleRequest.d.ts +27 -24
- package/dist/models/ModifySecurityGroupRuleRequest.js.map +1 -1
- package/dist/models/ModifySystemEventAttributeRequest.d.ts +45 -0
- package/dist/models/ModifySystemEventAttributeRequest.js +64 -0
- package/dist/models/ModifySystemEventAttributeRequest.js.map +1 -0
- package/dist/models/ModifySystemEventAttributeResponse.d.ts +19 -0
- package/dist/models/ModifySystemEventAttributeResponse.js +69 -0
- package/dist/models/ModifySystemEventAttributeResponse.js.map +1 -0
- package/dist/models/ModifySystemEventAttributeResponseBody.d.ts +18 -0
- package/dist/models/ModifySystemEventAttributeResponseBody.js +58 -0
- package/dist/models/ModifySystemEventAttributeResponseBody.js.map +1 -0
- package/dist/models/RenewElasticityAssurancesRequest.d.ts +27 -23
- package/dist/models/RenewElasticityAssurancesRequest.js.map +1 -1
- package/dist/models/RenewElasticityAssurancesResponseBody.d.ts +1 -1
- package/dist/models/RevokeSecurityGroupEgressRequest.d.ts +35 -37
- package/dist/models/RevokeSecurityGroupEgressRequest.js.map +1 -1
- package/dist/models/RevokeSecurityGroupRequest.d.ts +71 -89
- package/dist/models/RevokeSecurityGroupRequest.js.map +1 -1
- package/dist/models/StartTerminalSessionRequest.d.ts +24 -32
- package/dist/models/StartTerminalSessionRequest.js.map +1 -1
- package/dist/models/StartTerminalSessionResponseBody.d.ts +2 -2
- package/dist/models/StartTerminalSessionShrinkRequest.d.ts +16 -18
- package/dist/models/StartTerminalSessionShrinkRequest.js.map +1 -1
- package/dist/models/StopInstanceRequest.d.ts +20 -27
- package/dist/models/StopInstanceRequest.js.map +1 -1
- package/dist/models/StopInstancesRequest.d.ts +24 -35
- package/dist/models/StopInstancesRequest.js.map +1 -1
- package/dist/models/UnassignIpv6addressesRequest.d.ts +3 -3
- package/dist/models/model.d.ts +4 -0
- package/dist/models/model.js +45 -37
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +984 -950
- package/src/models/AcceptInquiredSystemEventRequest.ts +3 -3
- package/src/models/AssignIpv6addressesRequest.ts +7 -7
- package/src/models/AssignIpv6addressesResponseBody.ts +1 -1
- package/src/models/AssignPrivateIpAddressesRequest.ts +13 -16
- package/src/models/AssignPrivateIpAddressesResponseBody.ts +2 -2
- package/src/models/AttachNetworkInterfaceRequest.ts +6 -7
- package/src/models/AuthorizeSecurityGroupEgressRequest.ts +79 -106
- package/src/models/AuthorizeSecurityGroupRequest.ts +70 -91
- package/src/models/AuthorizeSecurityGroupResponseBody.ts +1 -1
- package/src/models/CancelImagePipelineExecutionRequest.ts +2 -2
- package/src/models/CloneDisksRequest.ts +55 -80
- package/src/models/CloneDisksResponseBody.ts +2 -2
- package/src/models/CreateActivationRequest.ts +17 -16
- package/src/models/CreateActivationResponseBody.ts +3 -3
- package/src/models/CreateAutoProvisioningGroupRequest.ts +287 -381
- package/src/models/CreateAutoProvisioningGroupShrinkRequest.ts +283 -376
- package/src/models/CreateCommandRequest.ts +52 -73
- package/src/models/CreateCommandResponseBody.ts +2 -2
- package/src/models/CreateDiskRequest.ts +57 -59
- package/src/models/CreateDiskResponseBody.ts +3 -3
- package/src/models/CreateHpcClusterRequest.ts +5 -5
- package/src/models/CreateHpcClusterResponseBody.ts +2 -2
- package/src/models/CreateImageComponentRequest.ts +7 -7
- package/src/models/CreateImageComponentResponseBody.ts +1 -1
- package/src/models/CreateImageRequest.ts +43 -88
- package/src/models/CreateImageResponseBody.ts +2 -2
- package/src/models/CreateInstanceRequest.ts +185 -275
- package/src/models/CreateInstanceResponseBody.ts +2 -2
- package/src/models/CreateLaunchTemplateRequest.ts +235 -278
- package/src/models/CreateLaunchTemplateResponseBody.ts +3 -3
- package/src/models/CreateLaunchTemplateVersionRequest.ts +215 -244
- package/src/models/CreateLaunchTemplateVersionResponseBody.ts +2 -2
- package/src/models/CreateSecurityGroupRequest.ts +13 -16
- package/src/models/CreateSecurityGroupResponseBody.ts +1 -1
- package/src/models/CreateVswitchRequest.ts +0 -29
- package/src/models/CreateVswitchResponseBody.ts +0 -8
- package/src/models/DeleteHpcClusterRequest.ts +2 -2
- package/src/models/DeleteImagePipelineRequest.ts +1 -1
- package/src/models/DescribeAutoProvisioningGroupInstancesRequest.ts +5 -5
- package/src/models/DescribeAutoProvisioningGroupInstancesResponseBody.ts +1 -1
- package/src/models/DescribeAutoSnapshotPolicyExRequest.ts +11 -11
- package/src/models/DescribeAutoSnapshotPolicyExResponseBody.ts +3 -3
- package/src/models/DescribeAvailableResourceRequest.ts +62 -96
- package/src/models/DescribeAvailableResourceResponseBody.ts +0 -4
- package/src/models/DescribeDisksRequest.ts +40 -40
- package/src/models/DescribeDisksResponseBody.ts +3 -3
- package/src/models/DescribeImageComponentsRequest.ts +3 -3
- package/src/models/DescribeImageComponentsResponseBody.ts +1 -1
- package/src/models/DescribeImagesRequest.ts +62 -90
- package/src/models/DescribeImagesResponseBody.ts +5 -5
- package/src/models/DescribeInstanceAttributeRequest.ts +1 -1
- package/src/models/DescribeInstanceAttributeResponseBody.ts +66 -98
- package/src/models/DescribeInstanceHistoryEventsRequest.ts +50 -85
- package/src/models/DescribeInstanceHistoryEventsResponseBody.ts +18 -18
- package/src/models/DescribeInstanceTopologyResponseBody.ts +32 -0
- package/src/models/DescribeInstancesRequest.ts +57 -71
- package/src/models/DescribeInstancesResponseBody.ts +5 -5
- package/src/models/DescribeInvocationResultsRequest.ts +52 -69
- package/src/models/DescribeInvocationResultsResponseBody.ts +6 -52
- package/src/models/DescribeInvocationsRequest.ts +50 -77
- package/src/models/DescribeInvocationsResponseBody.ts +5 -5
- package/src/models/DescribeLaunchTemplateVersionsRequest.ts +14 -14
- package/src/models/DescribeLaunchTemplateVersionsResponseBody.ts +3 -3
- package/src/models/DescribeNetworkInterfacePermissionsRequest.ts +4 -4
- package/src/models/DescribePriceRequest.ts +160 -244
- package/src/models/DescribePriceResponseBody.ts +15 -15
- package/src/models/DescribeRecommendInstanceTypeRequest.ts +45 -57
- package/src/models/DescribeResourcesModificationRequest.ts +30 -41
- package/src/models/DescribeSecurityGroupAttributeRequest.ts +18 -29
- package/src/models/DescribeSecurityGroupAttributeResponseBody.ts +11 -10
- package/src/models/DescribeSecurityGroupsRequest.ts +21 -21
- package/src/models/DescribeSecurityGroupsResponseBody.ts +4 -4
- package/src/models/DescribeSendFileResultsRequest.ts +21 -25
- package/src/models/DescribeSendFileResultsResponseBody.ts +3 -3
- package/src/models/DescribeSnapshotsRequest.ts +48 -63
- package/src/models/DescribeSnapshotsResponseBody.ts +4 -8
- package/src/models/DescribeSpotPriceHistoryRequest.ts +22 -28
- package/src/models/DescribeSpotPriceHistoryResponseBody.ts +7 -3
- package/src/models/DescribeTerminalSessionsRequest.ts +3 -3
- package/src/models/DescribeTerminalSessionsResponseBody.ts +1 -1
- package/src/models/DescribeZonesRequest.ts +20 -30
- package/src/models/DescribeZonesResponseBody.ts +1 -1
- package/src/models/GetInstanceConsoleOutputRequest.ts +1 -1
- package/src/models/GetInstanceConsoleOutputResponseBody.ts +2 -2
- package/src/models/ModifyHpcClusterAttributeRequest.ts +1 -1
- package/src/models/ModifyInstanceAttributeRequest.ts +80 -108
- package/src/models/ModifyInstanceNetworkSpecRequest.ts +14 -14
- package/src/models/ModifyInstanceNetworkSpecResponseBody.ts +1 -1
- package/src/models/ModifyInstanceSpecRequest.ts +16 -16
- package/src/models/ModifyPlanMaintenanceWindowRequest.ts +4 -4
- package/src/models/ModifyPrepayInstanceSpecRequest.ts +28 -46
- package/src/models/ModifyPrepayInstanceSpecResponseBody.ts +2 -2
- package/src/models/ModifySecurityGroupEgressRuleRequest.ts +47 -46
- package/src/models/ModifySecurityGroupRuleRequest.ts +27 -24
- package/src/models/ModifySystemEventAttributeRequest.ts +64 -0
- package/src/models/ModifySystemEventAttributeResponse.ts +40 -0
- package/src/models/ModifySystemEventAttributeResponseBody.ts +31 -0
- package/src/models/RenewElasticityAssurancesRequest.ts +27 -23
- package/src/models/RenewElasticityAssurancesResponseBody.ts +1 -1
- package/src/models/RevokeSecurityGroupEgressRequest.ts +35 -37
- package/src/models/RevokeSecurityGroupRequest.ts +75 -93
- package/src/models/StartTerminalSessionRequest.ts +24 -32
- package/src/models/StartTerminalSessionResponseBody.ts +2 -2
- package/src/models/StartTerminalSessionShrinkRequest.ts +16 -18
- package/src/models/StopInstanceRequest.ts +21 -28
- package/src/models/StopInstancesRequest.ts +25 -36
- package/src/models/UnassignIpv6addressesRequest.ts +3 -3
- package/src/models/model.ts +4 -0
package/dist/client.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ export default class Client extends OpenApi {
|
|
|
9
9
|
[key: string]: string;
|
|
10
10
|
}, endpoint: string): string;
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Accepts and authorizes the execution of a system event operation. For system events in the Inquiring state, this operation accepts the default action of the system event and authorizes the system to execute the default action.
|
|
13
13
|
*
|
|
14
14
|
* @param request - AcceptInquiredSystemEventRequest
|
|
15
15
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -17,7 +17,7 @@ export default class Client extends OpenApi {
|
|
|
17
17
|
*/
|
|
18
18
|
acceptInquiredSystemEventWithOptions(request: $_model.AcceptInquiredSystemEventRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AcceptInquiredSystemEventResponse>;
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Accepts and authorizes the execution of a system event operation. For system events in the Inquiring state, this operation accepts the default action of the system event and authorizes the system to execute the default action.
|
|
21
21
|
*
|
|
22
22
|
* @param request - AcceptInquiredSystemEventRequest
|
|
23
23
|
* @returns AcceptInquiredSystemEventResponse
|
|
@@ -218,9 +218,9 @@ export default class Client extends OpenApi {
|
|
|
218
218
|
* You can specify IPv6 addresses from the CIDR block of the vSwitch to which the Elastic Network Interface (ENI) belongs, or specify the number of IPv6 addresses for automatic creation. Note the following items:
|
|
219
219
|
* - The vSwitch to which the ENI belongs must have IPv6 enabled. For more information, see [Enable an IPv6 CIDR block for an existing vSwitch](https://help.aliyun.com/document_detail/98923.html).
|
|
220
220
|
* - The ENI must be in the Active (Available) or InUse state.
|
|
221
|
-
* - When you operate
|
|
222
|
-
* - The number of IPv6 addresses that can be allocated to a single
|
|
223
|
-
* - If the ENI is in the Active (Available) state, up to 10 IPv6 addresses
|
|
221
|
+
* - When you operate a primary ENI, the instance to which the network interface controller (NIC) is attached must be in the Running or Stopped state.
|
|
222
|
+
* - The number of IPv6 addresses that can be allocated to a single network interface controller (NIC) depends on the instance type of the instance to which the ENI is attached.
|
|
223
|
+
* - If the ENI is in the Active (Available) state, you can allocate up to 10 IPv6 addresses to it.
|
|
224
224
|
* - If the ENI is attached to an instance, the number of IPv6 addresses that can be allocated is limited by the instance type. For more information, see [Instance family](https://help.aliyun.com/document_detail/25378.html).
|
|
225
225
|
* - After you successfully invoke this operation, you can obtain the allocated IPv6 address information from the response.
|
|
226
226
|
*
|
|
@@ -237,9 +237,9 @@ export default class Client extends OpenApi {
|
|
|
237
237
|
* You can specify IPv6 addresses from the CIDR block of the vSwitch to which the Elastic Network Interface (ENI) belongs, or specify the number of IPv6 addresses for automatic creation. Note the following items:
|
|
238
238
|
* - The vSwitch to which the ENI belongs must have IPv6 enabled. For more information, see [Enable an IPv6 CIDR block for an existing vSwitch](https://help.aliyun.com/document_detail/98923.html).
|
|
239
239
|
* - The ENI must be in the Active (Available) or InUse state.
|
|
240
|
-
* - When you operate
|
|
241
|
-
* - The number of IPv6 addresses that can be allocated to a single
|
|
242
|
-
* - If the ENI is in the Active (Available) state, up to 10 IPv6 addresses
|
|
240
|
+
* - When you operate a primary ENI, the instance to which the network interface controller (NIC) is attached must be in the Running or Stopped state.
|
|
241
|
+
* - The number of IPv6 addresses that can be allocated to a single network interface controller (NIC) depends on the instance type of the instance to which the ENI is attached.
|
|
242
|
+
* - If the ENI is in the Active (Available) state, you can allocate up to 10 IPv6 addresses to it.
|
|
243
243
|
* - If the ENI is attached to an instance, the number of IPv6 addresses that can be allocated is limited by the instance type. For more information, see [Instance family](https://help.aliyun.com/document_detail/25378.html).
|
|
244
244
|
* - After you successfully invoke this operation, you can obtain the allocated IPv6 address information from the response.
|
|
245
245
|
*
|
|
@@ -248,14 +248,14 @@ export default class Client extends OpenApi {
|
|
|
248
248
|
*/
|
|
249
249
|
assignIpv6Addresses(request: $_model.AssignIpv6AddressesRequest): Promise<$_model.AssignIpv6AddressesResponse>;
|
|
250
250
|
/**
|
|
251
|
-
*
|
|
251
|
+
* Allocates one or more secondary private IP addresses to an Elastic Network Interface (ENI). You can specify available private IP addresses from the vSwitch to which the ENI belongs, or automatically allocate private IP addresses by specifying the number of private endpoint addresses.
|
|
252
252
|
*
|
|
253
253
|
* @remarks
|
|
254
|
-
* ##
|
|
255
|
-
* -
|
|
256
|
-
* - When you
|
|
257
|
-
* - When an ENI is in the Available state, you can
|
|
258
|
-
* - After
|
|
254
|
+
* ## Operation description
|
|
255
|
+
* - Only ENIs in the Available or InUse state are supported.
|
|
256
|
+
* - When you operate a primary ENI, the instance to which the ENI is attached must be in the Running or Stopped state.
|
|
257
|
+
* - When an ENI is in the Available state, you can allocate up to 49 secondary private IP addresses to it. After the ENI is attached to an instance, the number of secondary private IP addresses that can be allocated is limited by the instance type. For more information, see [Instance families](https://help.aliyun.com/document_detail/25378.html).
|
|
258
|
+
* - After you call this operation, you can obtain the allocated secondary private IP address information from the response.
|
|
259
259
|
*
|
|
260
260
|
* @param request - AssignPrivateIpAddressesRequest
|
|
261
261
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -263,14 +263,14 @@ export default class Client extends OpenApi {
|
|
|
263
263
|
*/
|
|
264
264
|
assignPrivateIpAddressesWithOptions(request: $_model.AssignPrivateIpAddressesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AssignPrivateIpAddressesResponse>;
|
|
265
265
|
/**
|
|
266
|
-
*
|
|
266
|
+
* Allocates one or more secondary private IP addresses to an Elastic Network Interface (ENI). You can specify available private IP addresses from the vSwitch to which the ENI belongs, or automatically allocate private IP addresses by specifying the number of private endpoint addresses.
|
|
267
267
|
*
|
|
268
268
|
* @remarks
|
|
269
|
-
* ##
|
|
270
|
-
* -
|
|
271
|
-
* - When you
|
|
272
|
-
* - When an ENI is in the Available state, you can
|
|
273
|
-
* - After
|
|
269
|
+
* ## Operation description
|
|
270
|
+
* - Only ENIs in the Available or InUse state are supported.
|
|
271
|
+
* - When you operate a primary ENI, the instance to which the ENI is attached must be in the Running or Stopped state.
|
|
272
|
+
* - When an ENI is in the Available state, you can allocate up to 49 secondary private IP addresses to it. After the ENI is attached to an instance, the number of secondary private IP addresses that can be allocated is limited by the instance type. For more information, see [Instance families](https://help.aliyun.com/document_detail/25378.html).
|
|
273
|
+
* - After you call this operation, you can obtain the allocated secondary private IP address information from the response.
|
|
274
274
|
*
|
|
275
275
|
* @param request - AssignPrivateIpAddressesRequest
|
|
276
276
|
* @returns AssignPrivateIpAddressesResponse
|
|
@@ -445,21 +445,22 @@ export default class Client extends OpenApi {
|
|
|
445
445
|
*/
|
|
446
446
|
attachKeyPair(request: $_model.AttachKeyPairRequest): Promise<$_model.AttachKeyPairResponse>;
|
|
447
447
|
/**
|
|
448
|
-
*
|
|
448
|
+
* Calls the AttachNetworkInterface operation to attach an Elastic Network Interface (ENI) to a VPC-connected ECS instance. You can specify parameters such as NetworkInterfaceId, InstanceId, and NetworkCardIndex.
|
|
449
449
|
*
|
|
450
450
|
* @remarks
|
|
451
|
-
*
|
|
452
|
-
* - The ENI must be in the **
|
|
453
|
-
* - The instance must be in the Running or Stopped state.
|
|
454
|
-
*
|
|
455
|
-
* -
|
|
456
|
-
*
|
|
457
|
-
* -
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
462
|
-
*
|
|
451
|
+
* When you call this operation, take note of the following items:
|
|
452
|
+
* - The Elastic Network Interface (ENI) must be in the **active** (`Available`) state. An ENI can be attached to only one instance that resides in the same zone and VPC as the network interface controller (NIC).
|
|
453
|
+
* - The ECS instance must be in the Running or Stopped state. Some ECS instance types require the ECS instance to be in the Stopped state when you attach an Elastic Network Interface (ENI). For more information, see the section about ECS instance types that require the ECS instance to be stopped in [Attach an ENI](https://help.aliyun.com/document_detail/58503.html).
|
|
454
|
+
* > If the instance was last started before April 1, 2018 (including but not limited to starting a newly purchased instance, restarting, or powering on), you must invoke RebootInstance to restart the instance that has been in the Running state. Otherwise, the network interface controller (NIC) cannot be attached.
|
|
455
|
+
* - Multiple Elastic Network Interfaces (ENIs) can be attached to a single instance at the same time. For more information, see [ENI overview](https://help.aliyun.com/document_detail/58496.html).
|
|
456
|
+
*
|
|
457
|
+
* - The vSwitch to which the network interface controller (NIC) belongs must be in the same zone and VPC as the instance.
|
|
458
|
+
* - This is an asynchronous operation. After a successful invocation, you can check the Elastic Network Interface (ENI) status or listen for network interface controller (NIC) operation events to obtain the result. The ENI state machine is shown in the following figure:
|
|
459
|
+
* 
|
|
460
|
+
* - Attaching indicates that the request to attach the ENI was sent successfully and the ENI is being attached to the ECS instance.
|
|
461
|
+
* - InUse indicates that the ENI has been attached to the ECS instance.
|
|
462
|
+
* - Available indicates that the ENI failed to be attached to the ECS instance.
|
|
463
|
+
* **For details, see** [Attach a network interface controller (NIC)](https://help.aliyun.com/document_detail/471550.html).
|
|
463
464
|
*
|
|
464
465
|
* @param request - AttachNetworkInterfaceRequest
|
|
465
466
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -467,75 +468,76 @@ export default class Client extends OpenApi {
|
|
|
467
468
|
*/
|
|
468
469
|
attachNetworkInterfaceWithOptions(request: $_model.AttachNetworkInterfaceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AttachNetworkInterfaceResponse>;
|
|
469
470
|
/**
|
|
470
|
-
*
|
|
471
|
+
* Calls the AttachNetworkInterface operation to attach an Elastic Network Interface (ENI) to a VPC-connected ECS instance. You can specify parameters such as NetworkInterfaceId, InstanceId, and NetworkCardIndex.
|
|
471
472
|
*
|
|
472
473
|
* @remarks
|
|
473
|
-
*
|
|
474
|
-
* - The ENI must be in the **
|
|
475
|
-
* - The instance must be in the Running or Stopped state.
|
|
476
|
-
*
|
|
477
|
-
* -
|
|
478
|
-
*
|
|
479
|
-
* -
|
|
480
|
-
*
|
|
481
|
-
*
|
|
482
|
-
*
|
|
483
|
-
*
|
|
484
|
-
*
|
|
474
|
+
* When you call this operation, take note of the following items:
|
|
475
|
+
* - The Elastic Network Interface (ENI) must be in the **active** (`Available`) state. An ENI can be attached to only one instance that resides in the same zone and VPC as the network interface controller (NIC).
|
|
476
|
+
* - The ECS instance must be in the Running or Stopped state. Some ECS instance types require the ECS instance to be in the Stopped state when you attach an Elastic Network Interface (ENI). For more information, see the section about ECS instance types that require the ECS instance to be stopped in [Attach an ENI](https://help.aliyun.com/document_detail/58503.html).
|
|
477
|
+
* > If the instance was last started before April 1, 2018 (including but not limited to starting a newly purchased instance, restarting, or powering on), you must invoke RebootInstance to restart the instance that has been in the Running state. Otherwise, the network interface controller (NIC) cannot be attached.
|
|
478
|
+
* - Multiple Elastic Network Interfaces (ENIs) can be attached to a single instance at the same time. For more information, see [ENI overview](https://help.aliyun.com/document_detail/58496.html).
|
|
479
|
+
*
|
|
480
|
+
* - The vSwitch to which the network interface controller (NIC) belongs must be in the same zone and VPC as the instance.
|
|
481
|
+
* - This is an asynchronous operation. After a successful invocation, you can check the Elastic Network Interface (ENI) status or listen for network interface controller (NIC) operation events to obtain the result. The ENI state machine is shown in the following figure:
|
|
482
|
+
* 
|
|
483
|
+
* - Attaching indicates that the request to attach the ENI was sent successfully and the ENI is being attached to the ECS instance.
|
|
484
|
+
* - InUse indicates that the ENI has been attached to the ECS instance.
|
|
485
|
+
* - Available indicates that the ENI failed to be attached to the ECS instance.
|
|
486
|
+
* **For details, see** [Attach a network interface controller (NIC)](https://help.aliyun.com/document_detail/471550.html).
|
|
485
487
|
*
|
|
486
488
|
* @param request - AttachNetworkInterfaceRequest
|
|
487
489
|
* @returns AttachNetworkInterfaceResponse
|
|
488
490
|
*/
|
|
489
491
|
attachNetworkInterface(request: $_model.AttachNetworkInterfaceRequest): Promise<$_model.AttachNetworkInterfaceResponse>;
|
|
490
492
|
/**
|
|
491
|
-
*
|
|
493
|
+
* Adds one or more inbound rules to a security group. You can use this operation to specify inbound access permissions for a security group, allowing or denying other devices from sending inbound traffic to instances in the security group, which enables fine-grained network access control.
|
|
492
494
|
*
|
|
493
495
|
* @remarks
|
|
494
|
-
* ###
|
|
495
|
-
* -
|
|
496
|
-
* -
|
|
497
|
-
* ###
|
|
498
|
-
*
|
|
499
|
-
* ###
|
|
500
|
-
*
|
|
501
|
-
* -
|
|
502
|
-
* -
|
|
503
|
-
* -
|
|
504
|
-
* -
|
|
505
|
-
* >
|
|
506
|
-
* ###
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
*
|
|
512
|
-
*
|
|
513
|
-
*
|
|
514
|
-
*
|
|
515
|
-
*
|
|
516
|
-
*
|
|
517
|
-
*
|
|
518
|
-
*
|
|
519
|
-
*
|
|
520
|
-
*
|
|
521
|
-
*
|
|
522
|
-
*
|
|
523
|
-
*
|
|
524
|
-
*
|
|
525
|
-
*
|
|
526
|
-
*
|
|
527
|
-
*
|
|
528
|
-
*
|
|
529
|
-
*
|
|
530
|
-
*
|
|
531
|
-
*
|
|
532
|
-
*
|
|
533
|
-
*
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
*
|
|
496
|
+
* ### Before you begin
|
|
497
|
+
* - **Quantity limit:** The total number of security group rules (including inbound rules and outbound rules) across all security groups associated with a single network interface controller (NIC) cannot exceed 1,000. For more information, see [Security group limits](~~25412#SecurityGroupQuota1~~).
|
|
498
|
+
* - **Priority settings:** The priority (Priority) of inbound security group rules ranges from 1 to 100. A smaller number indicates a higher priority. If two security group rules have the same priority, the deny (drop) rule takes precedence. Access is denied first.
|
|
499
|
+
* ### Notes
|
|
500
|
+
* If the specified security group rule already exists, the call succeeds but no rule is added.
|
|
501
|
+
* ### How to determine a rule
|
|
502
|
+
* The following parameters are required to determine an inbound security group rule:
|
|
503
|
+
* - Source settings: Specify one of the following: SourceCidrIp (IPv4 address), Ipv6SourceCidrIp (IPv6 address), SourcePrefixListId (prefix list ID), or SourceGroupId (source security group).
|
|
504
|
+
* - Destination port range: PortRange.
|
|
505
|
+
* - Protocol type: IpProtocol.
|
|
506
|
+
* - Access policy: Policy.
|
|
507
|
+
* > Advanced security groups do not support authorization for access from other security groups. Basic security groups support a maximum of 20 authorized security groups.
|
|
508
|
+
* ### Request examples
|
|
509
|
+
* The following examples show how to add inbound rules with different sources to a security group in the China (Hangzhou) region:
|
|
510
|
+
* - Add access permissions for a specified IP address range.
|
|
511
|
+
* ```
|
|
512
|
+
* "RegionId":"cn-hangzhou", // Specify the region.
|
|
513
|
+
* "SecurityGroupId":"sg-bp67acfmxazb4p****", // Specify the security group.
|
|
514
|
+
* "Permissions":[
|
|
515
|
+
* {
|
|
516
|
+
* "SourceCidrIp":"10.0.0.0/8", // Specify the source IPv4 address.
|
|
517
|
+
* "PortRange":"22/22", // Specify the port range.
|
|
518
|
+
* "IpProtocol":"TCP", // Specify the protocol type.
|
|
519
|
+
* "Policy":"Accept" // Specify the access policy.
|
|
520
|
+
* }
|
|
521
|
+
* ]
|
|
522
|
+
* ```
|
|
523
|
+
* - Add access permissions for another security group and a prefix list.
|
|
524
|
+
* ```
|
|
525
|
+
* "RegionId":"cn-hangzhou",
|
|
526
|
+
* "SecurityGroupId":"sg-bp67acfmxazb4p****",
|
|
527
|
+
* "Permissions":[
|
|
528
|
+
* {
|
|
529
|
+
* "SourceGroupId":"sg-bp17vs63txqxbd****", // Specify the source security group.
|
|
530
|
+
* "PortRange":"22/22",
|
|
531
|
+
* "IpProtocol":"TCP",
|
|
532
|
+
* "Policy":"Drop"
|
|
533
|
+
* },{
|
|
534
|
+
* "SourcePrefixListId":"pl-x1j1k5ykzqlixdcy****", // Specify the source prefix list.
|
|
535
|
+
* "PortRange":"22/22",
|
|
536
|
+
* "IpProtocol":"TCP",
|
|
537
|
+
* "Policy":"Drop"
|
|
538
|
+
* }
|
|
539
|
+
* ]
|
|
540
|
+
* ```
|
|
539
541
|
*
|
|
540
542
|
* @param request - AuthorizeSecurityGroupRequest
|
|
541
543
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -543,108 +545,108 @@ export default class Client extends OpenApi {
|
|
|
543
545
|
*/
|
|
544
546
|
authorizeSecurityGroupWithOptions(request: $_model.AuthorizeSecurityGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AuthorizeSecurityGroupResponse>;
|
|
545
547
|
/**
|
|
546
|
-
*
|
|
548
|
+
* Adds one or more inbound rules to a security group. You can use this operation to specify inbound access permissions for a security group, allowing or denying other devices from sending inbound traffic to instances in the security group, which enables fine-grained network access control.
|
|
547
549
|
*
|
|
548
550
|
* @remarks
|
|
549
|
-
* ###
|
|
550
|
-
* -
|
|
551
|
-
* -
|
|
552
|
-
* ###
|
|
553
|
-
*
|
|
554
|
-
* ###
|
|
555
|
-
*
|
|
556
|
-
* -
|
|
557
|
-
* -
|
|
558
|
-
* -
|
|
559
|
-
* -
|
|
560
|
-
* >
|
|
561
|
-
* ###
|
|
562
|
-
*
|
|
563
|
-
*
|
|
564
|
-
*
|
|
565
|
-
*
|
|
566
|
-
*
|
|
567
|
-
*
|
|
568
|
-
*
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
*
|
|
572
|
-
*
|
|
573
|
-
*
|
|
574
|
-
*
|
|
575
|
-
*
|
|
576
|
-
*
|
|
577
|
-
*
|
|
578
|
-
*
|
|
579
|
-
*
|
|
580
|
-
*
|
|
581
|
-
*
|
|
582
|
-
*
|
|
583
|
-
*
|
|
584
|
-
*
|
|
585
|
-
*
|
|
586
|
-
*
|
|
587
|
-
*
|
|
588
|
-
*
|
|
589
|
-
*
|
|
590
|
-
*
|
|
591
|
-
*
|
|
592
|
-
*
|
|
593
|
-
*
|
|
551
|
+
* ### Before you begin
|
|
552
|
+
* - **Quantity limit:** The total number of security group rules (including inbound rules and outbound rules) across all security groups associated with a single network interface controller (NIC) cannot exceed 1,000. For more information, see [Security group limits](~~25412#SecurityGroupQuota1~~).
|
|
553
|
+
* - **Priority settings:** The priority (Priority) of inbound security group rules ranges from 1 to 100. A smaller number indicates a higher priority. If two security group rules have the same priority, the deny (drop) rule takes precedence. Access is denied first.
|
|
554
|
+
* ### Notes
|
|
555
|
+
* If the specified security group rule already exists, the call succeeds but no rule is added.
|
|
556
|
+
* ### How to determine a rule
|
|
557
|
+
* The following parameters are required to determine an inbound security group rule:
|
|
558
|
+
* - Source settings: Specify one of the following: SourceCidrIp (IPv4 address), Ipv6SourceCidrIp (IPv6 address), SourcePrefixListId (prefix list ID), or SourceGroupId (source security group).
|
|
559
|
+
* - Destination port range: PortRange.
|
|
560
|
+
* - Protocol type: IpProtocol.
|
|
561
|
+
* - Access policy: Policy.
|
|
562
|
+
* > Advanced security groups do not support authorization for access from other security groups. Basic security groups support a maximum of 20 authorized security groups.
|
|
563
|
+
* ### Request examples
|
|
564
|
+
* The following examples show how to add inbound rules with different sources to a security group in the China (Hangzhou) region:
|
|
565
|
+
* - Add access permissions for a specified IP address range.
|
|
566
|
+
* ```
|
|
567
|
+
* "RegionId":"cn-hangzhou", // Specify the region.
|
|
568
|
+
* "SecurityGroupId":"sg-bp67acfmxazb4p****", // Specify the security group.
|
|
569
|
+
* "Permissions":[
|
|
570
|
+
* {
|
|
571
|
+
* "SourceCidrIp":"10.0.0.0/8", // Specify the source IPv4 address.
|
|
572
|
+
* "PortRange":"22/22", // Specify the port range.
|
|
573
|
+
* "IpProtocol":"TCP", // Specify the protocol type.
|
|
574
|
+
* "Policy":"Accept" // Specify the access policy.
|
|
575
|
+
* }
|
|
576
|
+
* ]
|
|
577
|
+
* ```
|
|
578
|
+
* - Add access permissions for another security group and a prefix list.
|
|
579
|
+
* ```
|
|
580
|
+
* "RegionId":"cn-hangzhou",
|
|
581
|
+
* "SecurityGroupId":"sg-bp67acfmxazb4p****",
|
|
582
|
+
* "Permissions":[
|
|
583
|
+
* {
|
|
584
|
+
* "SourceGroupId":"sg-bp17vs63txqxbd****", // Specify the source security group.
|
|
585
|
+
* "PortRange":"22/22",
|
|
586
|
+
* "IpProtocol":"TCP",
|
|
587
|
+
* "Policy":"Drop"
|
|
588
|
+
* },{
|
|
589
|
+
* "SourcePrefixListId":"pl-x1j1k5ykzqlixdcy****", // Specify the source prefix list.
|
|
590
|
+
* "PortRange":"22/22",
|
|
591
|
+
* "IpProtocol":"TCP",
|
|
592
|
+
* "Policy":"Drop"
|
|
593
|
+
* }
|
|
594
|
+
* ]
|
|
595
|
+
* ```
|
|
594
596
|
*
|
|
595
597
|
* @param request - AuthorizeSecurityGroupRequest
|
|
596
598
|
* @returns AuthorizeSecurityGroupResponse
|
|
597
599
|
*/
|
|
598
600
|
authorizeSecurityGroup(request: $_model.AuthorizeSecurityGroupRequest): Promise<$_model.AuthorizeSecurityGroupResponse>;
|
|
599
601
|
/**
|
|
600
|
-
*
|
|
602
|
+
* Adds one or more outbound rules to a security group. You can use this operation to specify outbound access permissions for a security group, allowing or denying instances in the security group from sending outbound traffic to other devices, which enables fine-grained network access control.
|
|
601
603
|
*
|
|
602
604
|
* @remarks
|
|
603
|
-
* ###
|
|
604
|
-
* -
|
|
605
|
-
* -
|
|
606
|
-
* ###
|
|
607
|
-
*
|
|
608
|
-
* ###
|
|
609
|
-
*
|
|
610
|
-
* -
|
|
611
|
-
* -
|
|
612
|
-
* -
|
|
613
|
-
* -
|
|
614
|
-
* >
|
|
615
|
-
* ###
|
|
616
|
-
*
|
|
617
|
-
*
|
|
618
|
-
*
|
|
619
|
-
*
|
|
620
|
-
*
|
|
621
|
-
*
|
|
622
|
-
*
|
|
623
|
-
*
|
|
624
|
-
*
|
|
625
|
-
*
|
|
626
|
-
*
|
|
627
|
-
*
|
|
628
|
-
*
|
|
629
|
-
*
|
|
630
|
-
*
|
|
631
|
-
*
|
|
632
|
-
*
|
|
633
|
-
*
|
|
634
|
-
*
|
|
635
|
-
*
|
|
636
|
-
*
|
|
637
|
-
*
|
|
638
|
-
*
|
|
639
|
-
*
|
|
640
|
-
*
|
|
641
|
-
*
|
|
642
|
-
*
|
|
643
|
-
*
|
|
644
|
-
*
|
|
645
|
-
*
|
|
646
|
-
*
|
|
647
|
-
*
|
|
605
|
+
* ### Before you begin
|
|
606
|
+
* - **Quantity limit:** The total number of rules (including both inbound rules and outbound rules) across all security groups associated with a single network interface controller (NIC) cannot exceed 1,000. For more information, see [Security group limits](~~25412#SecurityGroupQuota1~~).
|
|
607
|
+
* - **Priority settings:** The priority (Priority) of outbound security group rules ranges from 1 to 100. A smaller number indicates a higher priority. If two security group rules have the same priority, the deny (drop) rule takes precedence.
|
|
608
|
+
* ### Notes
|
|
609
|
+
* If the specified security group rule already exists, the call succeeds but no rule is added.
|
|
610
|
+
* ### How to determine a rule
|
|
611
|
+
* The following parameters are required to determine an outbound rule:
|
|
612
|
+
* - Destination settings: Specify one of the following: DestCidrIp (IPv4 address), Ipv6DestCidrIp (IPv6 address), DestPrefixListId (prefix list ID), or DestGroupId (destination security group).
|
|
613
|
+
* - Destination port range: PortRange.
|
|
614
|
+
* - Protocol type: IpProtocol.
|
|
615
|
+
* - Access policy: Policy.
|
|
616
|
+
* > Advanced security groups do not support authorization of other security groups for access. Custom security groups support a maximum of 20 authorized security groups.
|
|
617
|
+
* ### Request examples
|
|
618
|
+
* The following examples show how to add outbound rules with different destinations to a security group in the China (Hangzhou) region:
|
|
619
|
+
* - Add access permissions for a specified IP address range.
|
|
620
|
+
* ```
|
|
621
|
+
* "RegionId":"ap-southeast-1", // Specify the region.
|
|
622
|
+
* "SecurityGroupId":"sg-bp17vs63txqxbds9***", // Specify the security group.
|
|
623
|
+
* "Permissions":[
|
|
624
|
+
* {
|
|
625
|
+
* "DestCidrIp":"10.0.0.0/8", // Specify the destination IPv4 address.
|
|
626
|
+
* "PortRange":"-1/-1", // Specify the port range.
|
|
627
|
+
* "IpProtocol":"ICMP", // Specify the protocol type.
|
|
628
|
+
* "Policy":"Accept" // Specify the access policy.
|
|
629
|
+
* }
|
|
630
|
+
* ]
|
|
631
|
+
* ```
|
|
632
|
+
* - Add access permissions for another security group and a prefix list.
|
|
633
|
+
* ```
|
|
634
|
+
* "RegionId":"ap-southeast-1",
|
|
635
|
+
* "SecurityGroupId":"sg-bp17vs63txqxbds9***",
|
|
636
|
+
* "Permissions":[
|
|
637
|
+
* {
|
|
638
|
+
* "DestGroupId":"sg-bp67acfmxazb4pi***", // Specify the destination security group.
|
|
639
|
+
* "PortRange":"22/22",
|
|
640
|
+
* "IpProtocol":"TCP",
|
|
641
|
+
* "Policy":"Drop"
|
|
642
|
+
* },{
|
|
643
|
+
* "DestPrefixListId":"pl-x1j1k5ykzqlixdcy****", // Specify the destination prefix list.
|
|
644
|
+
* "PortRange":"22/22",
|
|
645
|
+
* "IpProtocol":"TCP",
|
|
646
|
+
* "Policy":"Drop"
|
|
647
|
+
* }
|
|
648
|
+
* ]
|
|
649
|
+
* ```
|
|
648
650
|
*
|
|
649
651
|
* @param request - AuthorizeSecurityGroupEgressRequest
|
|
650
652
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -652,54 +654,54 @@ export default class Client extends OpenApi {
|
|
|
652
654
|
*/
|
|
653
655
|
authorizeSecurityGroupEgressWithOptions(request: $_model.AuthorizeSecurityGroupEgressRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AuthorizeSecurityGroupEgressResponse>;
|
|
654
656
|
/**
|
|
655
|
-
*
|
|
657
|
+
* Adds one or more outbound rules to a security group. You can use this operation to specify outbound access permissions for a security group, allowing or denying instances in the security group from sending outbound traffic to other devices, which enables fine-grained network access control.
|
|
656
658
|
*
|
|
657
659
|
* @remarks
|
|
658
|
-
* ###
|
|
659
|
-
* -
|
|
660
|
-
* -
|
|
661
|
-
* ###
|
|
662
|
-
*
|
|
663
|
-
* ###
|
|
664
|
-
*
|
|
665
|
-
* -
|
|
666
|
-
* -
|
|
667
|
-
* -
|
|
668
|
-
* -
|
|
669
|
-
* >
|
|
670
|
-
* ###
|
|
671
|
-
*
|
|
672
|
-
*
|
|
673
|
-
*
|
|
674
|
-
*
|
|
675
|
-
*
|
|
676
|
-
*
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
*
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
*
|
|
685
|
-
*
|
|
686
|
-
*
|
|
687
|
-
*
|
|
688
|
-
*
|
|
689
|
-
*
|
|
690
|
-
*
|
|
691
|
-
*
|
|
692
|
-
*
|
|
693
|
-
*
|
|
694
|
-
*
|
|
695
|
-
*
|
|
696
|
-
*
|
|
697
|
-
*
|
|
698
|
-
*
|
|
699
|
-
*
|
|
700
|
-
*
|
|
701
|
-
*
|
|
702
|
-
*
|
|
660
|
+
* ### Before you begin
|
|
661
|
+
* - **Quantity limit:** The total number of rules (including both inbound rules and outbound rules) across all security groups associated with a single network interface controller (NIC) cannot exceed 1,000. For more information, see [Security group limits](~~25412#SecurityGroupQuota1~~).
|
|
662
|
+
* - **Priority settings:** The priority (Priority) of outbound security group rules ranges from 1 to 100. A smaller number indicates a higher priority. If two security group rules have the same priority, the deny (drop) rule takes precedence.
|
|
663
|
+
* ### Notes
|
|
664
|
+
* If the specified security group rule already exists, the call succeeds but no rule is added.
|
|
665
|
+
* ### How to determine a rule
|
|
666
|
+
* The following parameters are required to determine an outbound rule:
|
|
667
|
+
* - Destination settings: Specify one of the following: DestCidrIp (IPv4 address), Ipv6DestCidrIp (IPv6 address), DestPrefixListId (prefix list ID), or DestGroupId (destination security group).
|
|
668
|
+
* - Destination port range: PortRange.
|
|
669
|
+
* - Protocol type: IpProtocol.
|
|
670
|
+
* - Access policy: Policy.
|
|
671
|
+
* > Advanced security groups do not support authorization of other security groups for access. Custom security groups support a maximum of 20 authorized security groups.
|
|
672
|
+
* ### Request examples
|
|
673
|
+
* The following examples show how to add outbound rules with different destinations to a security group in the China (Hangzhou) region:
|
|
674
|
+
* - Add access permissions for a specified IP address range.
|
|
675
|
+
* ```
|
|
676
|
+
* "RegionId":"ap-southeast-1", // Specify the region.
|
|
677
|
+
* "SecurityGroupId":"sg-bp17vs63txqxbds9***", // Specify the security group.
|
|
678
|
+
* "Permissions":[
|
|
679
|
+
* {
|
|
680
|
+
* "DestCidrIp":"10.0.0.0/8", // Specify the destination IPv4 address.
|
|
681
|
+
* "PortRange":"-1/-1", // Specify the port range.
|
|
682
|
+
* "IpProtocol":"ICMP", // Specify the protocol type.
|
|
683
|
+
* "Policy":"Accept" // Specify the access policy.
|
|
684
|
+
* }
|
|
685
|
+
* ]
|
|
686
|
+
* ```
|
|
687
|
+
* - Add access permissions for another security group and a prefix list.
|
|
688
|
+
* ```
|
|
689
|
+
* "RegionId":"ap-southeast-1",
|
|
690
|
+
* "SecurityGroupId":"sg-bp17vs63txqxbds9***",
|
|
691
|
+
* "Permissions":[
|
|
692
|
+
* {
|
|
693
|
+
* "DestGroupId":"sg-bp67acfmxazb4pi***", // Specify the destination security group.
|
|
694
|
+
* "PortRange":"22/22",
|
|
695
|
+
* "IpProtocol":"TCP",
|
|
696
|
+
* "Policy":"Drop"
|
|
697
|
+
* },{
|
|
698
|
+
* "DestPrefixListId":"pl-x1j1k5ykzqlixdcy****", // Specify the destination prefix list.
|
|
699
|
+
* "PortRange":"22/22",
|
|
700
|
+
* "IpProtocol":"TCP",
|
|
701
|
+
* "Policy":"Drop"
|
|
702
|
+
* }
|
|
703
|
+
* ]
|
|
704
|
+
* ```
|
|
703
705
|
*
|
|
704
706
|
* @param request - AuthorizeSecurityGroupEgressRequest
|
|
705
707
|
* @returns AuthorizeSecurityGroupEgressResponse
|
|
@@ -746,10 +748,10 @@ export default class Client extends OpenApi {
|
|
|
746
748
|
*/
|
|
747
749
|
cancelCopyImage(request: $_model.CancelCopyImageRequest): Promise<$_model.CancelCopyImageResponse>;
|
|
748
750
|
/**
|
|
749
|
-
* Cancels an image
|
|
751
|
+
* Cancels an image build task.
|
|
750
752
|
*
|
|
751
753
|
* @remarks
|
|
752
|
-
* Before you call
|
|
754
|
+
* Before you call this operation, make sure that the image build task you want to cancel is in the PREPARING, REPAIRING, or BUILDING state.
|
|
753
755
|
*
|
|
754
756
|
* @param request - CancelImagePipelineExecutionRequest
|
|
755
757
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -757,10 +759,10 @@ export default class Client extends OpenApi {
|
|
|
757
759
|
*/
|
|
758
760
|
cancelImagePipelineExecutionWithOptions(request: $_model.CancelImagePipelineExecutionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CancelImagePipelineExecutionResponse>;
|
|
759
761
|
/**
|
|
760
|
-
* Cancels an image
|
|
762
|
+
* Cancels an image build task.
|
|
761
763
|
*
|
|
762
764
|
* @remarks
|
|
763
|
-
* Before you call
|
|
765
|
+
* Before you call this operation, make sure that the image build task you want to cancel is in the PREPARING, REPAIRING, or BUILDING state.
|
|
764
766
|
*
|
|
765
767
|
* @param request - CancelImagePipelineExecutionRequest
|
|
766
768
|
* @returns CancelImagePipelineExecutionResponse
|
|
@@ -816,29 +818,29 @@ export default class Client extends OpenApi {
|
|
|
816
818
|
*/
|
|
817
819
|
cancelTask(request: $_model.CancelTaskRequest): Promise<$_model.CancelTaskResponse>;
|
|
818
820
|
/**
|
|
819
|
-
*
|
|
821
|
+
* Disk cloning allows you to quickly create a new disk with the same data as the source disk in the same zone. The new disk supports custom capacity, type, and encryption attributes. After the new disk is attached to an instance, you can quickly replicate business data or horizontally scale your services.
|
|
820
822
|
*
|
|
821
823
|
* @remarks
|
|
822
|
-
* > The
|
|
823
|
-
* ###
|
|
824
|
-
* - This is an asynchronous operation. After a successful call,
|
|
824
|
+
* > The disk cloning feature itself is free of charge, but the new disk generated by cloning is billed based on block storage billing rules. Billable items vary by disk type and include disk capacity fees, provisioned performance fees, and performance burst fees. Except for performance burst fees, which are billed after a burst occurs, all other fees start to accrue after the disk is created, regardless of whether the disk is attached to an instance.
|
|
825
|
+
* ### How to use
|
|
826
|
+
* - This is an asynchronous operation. After a successful call, use the taskGroupId and call the DescribeTasks operation to obtain the execution result.
|
|
825
827
|
* ### Features
|
|
826
|
-
* -
|
|
827
|
-
* -
|
|
828
|
-
* - Local disks and elastic ephemeral disks
|
|
829
|
-
* - You can specify the type and performance level
|
|
830
|
-
* - You can specify the capacity
|
|
831
|
-
* - You can configure provisioned performance and burst
|
|
832
|
-
* - You can
|
|
833
|
-
* - You can use a subscription
|
|
834
|
-
* -
|
|
835
|
-
* -
|
|
836
|
-
* - `
|
|
837
|
-
* - The `source disk`
|
|
838
|
-
* - The `source disk`
|
|
839
|
-
* - A disk undergoing a
|
|
840
|
-
* - A disk
|
|
841
|
-
* -
|
|
828
|
+
* - Cloning supports only ESSD series disks (cloud_essd, cloud_auto, cloud_essd_entry, cloud_regional_disk_auto) as the source, and the `new disk` can only be an ESSD series disk type.
|
|
829
|
+
* - Non-regional disks can only be cloned to non-regional disk types. Regional disks can only be cloned to regional disk types.
|
|
830
|
+
* - Local disks and elastic ephemeral disks cannot be cloned or used as clone sources.
|
|
831
|
+
* - You can specify the `new disk` type and performance level (PL) during cloning.
|
|
832
|
+
* - You can specify the `new disk` capacity during cloning, but the new disk capacity must be greater than or equal to the `source disk` capacity.
|
|
833
|
+
* - You can configure provisioned performance and performance burst for the `new disk`, provided that the destination disk type supports provisioned performance and performance burst.
|
|
834
|
+
* - You can specify encryption for the `new disk` and change the encryption key. If the `source disk` is encrypted, you cannot clone it into an unencrypted disk, but you can change the encryption key.
|
|
835
|
+
* - You can use a subscription disk as the `source disk`. Even if the subscription disk has expired, it can still be used as the `source disk`.
|
|
836
|
+
* - The `new disk` created by cloning does not support reinitialization.
|
|
837
|
+
* - Cloning does not support storage sets or dedicated block storage clusters, but disks in them can be used as the `source disk`. The cloned disk will not be in the storage set or dedicated block storage cluster.
|
|
838
|
+
* - `Source disk` status restrictions:
|
|
839
|
+
* - The `source disk` status is "In Use" and the corresponding instance status is "Running" or "Stopped".
|
|
840
|
+
* - The `source disk` status is "Available" and the disk has been previously attached.
|
|
841
|
+
* - A disk undergoing a specification change cannot be used as the `source disk`.
|
|
842
|
+
* - A disk undergoing expansion cannot be used as the `source disk`.
|
|
843
|
+
* - Disk cloning is not supported for instance hibernation scenarios. If a disk is on a hibernated instance, it cannot be used as the `source disk`.
|
|
842
844
|
*
|
|
843
845
|
* @param request - CloneDisksRequest
|
|
844
846
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -846,29 +848,29 @@ export default class Client extends OpenApi {
|
|
|
846
848
|
*/
|
|
847
849
|
cloneDisksWithOptions(request: $_model.CloneDisksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CloneDisksResponse>;
|
|
848
850
|
/**
|
|
849
|
-
*
|
|
851
|
+
* Disk cloning allows you to quickly create a new disk with the same data as the source disk in the same zone. The new disk supports custom capacity, type, and encryption attributes. After the new disk is attached to an instance, you can quickly replicate business data or horizontally scale your services.
|
|
850
852
|
*
|
|
851
853
|
* @remarks
|
|
852
|
-
* > The
|
|
853
|
-
* ###
|
|
854
|
-
* - This is an asynchronous operation. After a successful call,
|
|
854
|
+
* > The disk cloning feature itself is free of charge, but the new disk generated by cloning is billed based on block storage billing rules. Billable items vary by disk type and include disk capacity fees, provisioned performance fees, and performance burst fees. Except for performance burst fees, which are billed after a burst occurs, all other fees start to accrue after the disk is created, regardless of whether the disk is attached to an instance.
|
|
855
|
+
* ### How to use
|
|
856
|
+
* - This is an asynchronous operation. After a successful call, use the taskGroupId and call the DescribeTasks operation to obtain the execution result.
|
|
855
857
|
* ### Features
|
|
856
|
-
* -
|
|
857
|
-
* -
|
|
858
|
-
* - Local disks and elastic ephemeral disks
|
|
859
|
-
* - You can specify the type and performance level
|
|
860
|
-
* - You can specify the capacity
|
|
861
|
-
* - You can configure provisioned performance and burst
|
|
862
|
-
* - You can
|
|
863
|
-
* - You can use a subscription
|
|
864
|
-
* -
|
|
865
|
-
* -
|
|
866
|
-
* - `
|
|
867
|
-
* - The `source disk`
|
|
868
|
-
* - The `source disk`
|
|
869
|
-
* - A disk undergoing a
|
|
870
|
-
* - A disk
|
|
871
|
-
* -
|
|
858
|
+
* - Cloning supports only ESSD series disks (cloud_essd, cloud_auto, cloud_essd_entry, cloud_regional_disk_auto) as the source, and the `new disk` can only be an ESSD series disk type.
|
|
859
|
+
* - Non-regional disks can only be cloned to non-regional disk types. Regional disks can only be cloned to regional disk types.
|
|
860
|
+
* - Local disks and elastic ephemeral disks cannot be cloned or used as clone sources.
|
|
861
|
+
* - You can specify the `new disk` type and performance level (PL) during cloning.
|
|
862
|
+
* - You can specify the `new disk` capacity during cloning, but the new disk capacity must be greater than or equal to the `source disk` capacity.
|
|
863
|
+
* - You can configure provisioned performance and performance burst for the `new disk`, provided that the destination disk type supports provisioned performance and performance burst.
|
|
864
|
+
* - You can specify encryption for the `new disk` and change the encryption key. If the `source disk` is encrypted, you cannot clone it into an unencrypted disk, but you can change the encryption key.
|
|
865
|
+
* - You can use a subscription disk as the `source disk`. Even if the subscription disk has expired, it can still be used as the `source disk`.
|
|
866
|
+
* - The `new disk` created by cloning does not support reinitialization.
|
|
867
|
+
* - Cloning does not support storage sets or dedicated block storage clusters, but disks in them can be used as the `source disk`. The cloned disk will not be in the storage set or dedicated block storage cluster.
|
|
868
|
+
* - `Source disk` status restrictions:
|
|
869
|
+
* - The `source disk` status is "In Use" and the corresponding instance status is "Running" or "Stopped".
|
|
870
|
+
* - The `source disk` status is "Available" and the disk has been previously attached.
|
|
871
|
+
* - A disk undergoing a specification change cannot be used as the `source disk`.
|
|
872
|
+
* - A disk undergoing expansion cannot be used as the `source disk`.
|
|
873
|
+
* - Disk cloning is not supported for instance hibernation scenarios. If a disk is on a hibernated instance, it cannot be used as the `source disk`.
|
|
872
874
|
*
|
|
873
875
|
* @param request - CloneDisksRequest
|
|
874
876
|
* @returns CloneDisksResponse
|
|
@@ -991,12 +993,12 @@ export default class Client extends OpenApi {
|
|
|
991
993
|
*/
|
|
992
994
|
copySnapshot(request: $_model.CopySnapshotRequest): Promise<$_model.CopySnapshotResponse>;
|
|
993
995
|
/**
|
|
994
|
-
*
|
|
996
|
+
* Creates an activation code that is used to register non-Alibaba Cloud servers as Alibaba Cloud managed instances.
|
|
995
997
|
*
|
|
996
998
|
* @remarks
|
|
997
|
-
* ##
|
|
998
|
-
* After you register a non-Alibaba Cloud server as an Alibaba Cloud managed instance
|
|
999
|
-
* The operating system of the non-
|
|
999
|
+
* ## Operation description
|
|
1000
|
+
* After you use an activation code to register a non-Alibaba Cloud server as an Alibaba Cloud managed instance, you can use various online services provided by Alibaba Cloud in the managed instance, such as Cloud Assistant, CloudOps Orchestration Service, and Alibaba Cloud DevOps.
|
|
1001
|
+
* The operating system of the non-Elastic Compute Service (ECS) server must meet the following version requirements, and the server must have Internet access to be registered as an Alibaba Cloud managed instance.
|
|
1000
1002
|
* - Alibaba Cloud Linux 2/3 and later
|
|
1001
1003
|
* - CentOS 6/7/8 and later
|
|
1002
1004
|
* - Debian 8/9/10 and later
|
|
@@ -1005,9 +1007,9 @@ export default class Client extends OpenApi {
|
|
|
1005
1007
|
* - OpenSUSE
|
|
1006
1008
|
* - RedHat 5/6/7 and later
|
|
1007
1009
|
* - SUSE Linux Enterprise Server 11/12/15 and later
|
|
1008
|
-
* -
|
|
1009
|
-
* In each Alibaba Cloud
|
|
1010
|
-
* >
|
|
1010
|
+
* - Window Server 2012/2016/2019 and later
|
|
1011
|
+
* In each Alibaba Cloud region, you can have up to 10 managed instance activation codes. Each activation code can be used to register up to 10 instances, and each activation code is valid for up to 4 hours.
|
|
1012
|
+
* > On the **ECS Cloud Assistant** page, click the **Managed Instances** tab, and then click **Register New Instance** to view the usage data of activation codes.
|
|
1011
1013
|
*
|
|
1012
1014
|
* @param request - CreateActivationRequest
|
|
1013
1015
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1015,12 +1017,12 @@ export default class Client extends OpenApi {
|
|
|
1015
1017
|
*/
|
|
1016
1018
|
createActivationWithOptions(request: $_model.CreateActivationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateActivationResponse>;
|
|
1017
1019
|
/**
|
|
1018
|
-
*
|
|
1020
|
+
* Creates an activation code that is used to register non-Alibaba Cloud servers as Alibaba Cloud managed instances.
|
|
1019
1021
|
*
|
|
1020
1022
|
* @remarks
|
|
1021
|
-
* ##
|
|
1022
|
-
* After you register a non-Alibaba Cloud server as an Alibaba Cloud managed instance
|
|
1023
|
-
* The operating system of the non-
|
|
1023
|
+
* ## Operation description
|
|
1024
|
+
* After you use an activation code to register a non-Alibaba Cloud server as an Alibaba Cloud managed instance, you can use various online services provided by Alibaba Cloud in the managed instance, such as Cloud Assistant, CloudOps Orchestration Service, and Alibaba Cloud DevOps.
|
|
1025
|
+
* The operating system of the non-Elastic Compute Service (ECS) server must meet the following version requirements, and the server must have Internet access to be registered as an Alibaba Cloud managed instance.
|
|
1024
1026
|
* - Alibaba Cloud Linux 2/3 and later
|
|
1025
1027
|
* - CentOS 6/7/8 and later
|
|
1026
1028
|
* - Debian 8/9/10 and later
|
|
@@ -1029,22 +1031,22 @@ export default class Client extends OpenApi {
|
|
|
1029
1031
|
* - OpenSUSE
|
|
1030
1032
|
* - RedHat 5/6/7 and later
|
|
1031
1033
|
* - SUSE Linux Enterprise Server 11/12/15 and later
|
|
1032
|
-
* -
|
|
1033
|
-
* In each Alibaba Cloud
|
|
1034
|
-
* >
|
|
1034
|
+
* - Window Server 2012/2016/2019 and later
|
|
1035
|
+
* In each Alibaba Cloud region, you can have up to 10 managed instance activation codes. Each activation code can be used to register up to 10 instances, and each activation code is valid for up to 4 hours.
|
|
1036
|
+
* > On the **ECS Cloud Assistant** page, click the **Managed Instances** tab, and then click **Register New Instance** to view the usage data of activation codes.
|
|
1035
1037
|
*
|
|
1036
1038
|
* @param request - CreateActivationRequest
|
|
1037
1039
|
* @returns CreateActivationResponse
|
|
1038
1040
|
*/
|
|
1039
1041
|
createActivation(request: $_model.CreateActivationRequest): Promise<$_model.CreateActivationResponse>;
|
|
1040
1042
|
/**
|
|
1041
|
-
*
|
|
1043
|
+
* Creates an auto provisioning group.
|
|
1042
1044
|
*
|
|
1043
1045
|
* @remarks
|
|
1044
|
-
* - Auto provisioning is a solution that uses spot instances and pay-as-you-go instances to quickly deploy instance clusters. It supports one-click deployment of instance clusters across billing methods, zones, and instance families. For more information, see [Use the auto provisioning group API to create
|
|
1045
|
-
* - Auto provisioning
|
|
1046
|
-
* - Auto provisioning is a free feature
|
|
1047
|
-
* -
|
|
1046
|
+
* - Auto provisioning is a solution that uses spot instances and pay-as-you-go instances to quickly deploy instance clusters. It supports one-click deployment of instance clusters across billing methods, zones, and instance families. For more information, see [Use the auto provisioning group API to create ECS instances in batches](https://help.aliyun.com/document_detail/200772.html).
|
|
1047
|
+
* - Auto provisioning uses provisioning groups to schedule and maintain compute resources. You can use an auto provisioning group to steadily provide computing power and mitigate the instability caused by the reclaim mechanism of spot instances.
|
|
1048
|
+
* - Auto provisioning is a free feature, but you are charged for the instance resources created by the auto provisioning group. For more information, see [Spot instance billing](https://help.aliyun.com/document_detail/52088.html) and [Pay-as-you-go](https://help.aliyun.com/document_detail/40653.html).
|
|
1049
|
+
* - If you specify both a launch template (`LaunchTemplateId`) and launch configuration information (`LaunchConfiguration.*`), the launch template takes precedence.
|
|
1048
1050
|
*
|
|
1049
1051
|
* @param tmpReq - CreateAutoProvisioningGroupRequest
|
|
1050
1052
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1052,13 +1054,13 @@ export default class Client extends OpenApi {
|
|
|
1052
1054
|
*/
|
|
1053
1055
|
createAutoProvisioningGroupWithOptions(tmpReq: $_model.CreateAutoProvisioningGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAutoProvisioningGroupResponse>;
|
|
1054
1056
|
/**
|
|
1055
|
-
*
|
|
1057
|
+
* Creates an auto provisioning group.
|
|
1056
1058
|
*
|
|
1057
1059
|
* @remarks
|
|
1058
|
-
* - Auto provisioning is a solution that uses spot instances and pay-as-you-go instances to quickly deploy instance clusters. It supports one-click deployment of instance clusters across billing methods, zones, and instance families. For more information, see [Use the auto provisioning group API to create
|
|
1059
|
-
* - Auto provisioning
|
|
1060
|
-
* - Auto provisioning is a free feature
|
|
1061
|
-
* -
|
|
1060
|
+
* - Auto provisioning is a solution that uses spot instances and pay-as-you-go instances to quickly deploy instance clusters. It supports one-click deployment of instance clusters across billing methods, zones, and instance families. For more information, see [Use the auto provisioning group API to create ECS instances in batches](https://help.aliyun.com/document_detail/200772.html).
|
|
1061
|
+
* - Auto provisioning uses provisioning groups to schedule and maintain compute resources. You can use an auto provisioning group to steadily provide computing power and mitigate the instability caused by the reclaim mechanism of spot instances.
|
|
1062
|
+
* - Auto provisioning is a free feature, but you are charged for the instance resources created by the auto provisioning group. For more information, see [Spot instance billing](https://help.aliyun.com/document_detail/52088.html) and [Pay-as-you-go](https://help.aliyun.com/document_detail/40653.html).
|
|
1063
|
+
* - If you specify both a launch template (`LaunchTemplateId`) and launch configuration information (`LaunchConfiguration.*`), the launch template takes precedence.
|
|
1062
1064
|
*
|
|
1063
1065
|
* @param request - CreateAutoProvisioningGroupRequest
|
|
1064
1066
|
* @returns CreateAutoProvisioningGroupResponse
|
|
@@ -1129,23 +1131,23 @@ export default class Client extends OpenApi {
|
|
|
1129
1131
|
*/
|
|
1130
1132
|
createCapacityReservation(request: $_model.CreateCapacityReservationRequest): Promise<$_model.CreateCapacityReservationResponse>;
|
|
1131
1133
|
/**
|
|
1132
|
-
*
|
|
1134
|
+
* Creates a Cloud Assistant command of the Shell, PowerShell, or Bat script type.
|
|
1133
1135
|
*
|
|
1134
1136
|
* @remarks
|
|
1135
|
-
* ##
|
|
1136
|
-
* - You can create
|
|
1137
|
-
*
|
|
1138
|
-
*
|
|
1139
|
-
*
|
|
1140
|
-
* - You can specify the Timeout parameter to set the maximum timeout
|
|
1141
|
-
*
|
|
1142
|
-
*
|
|
1143
|
-
*
|
|
1144
|
-
*
|
|
1145
|
-
*
|
|
1146
|
-
* -
|
|
1147
|
-
* - You can
|
|
1148
|
-
* - You can enable the
|
|
1137
|
+
* ## Operation description
|
|
1138
|
+
* - You can create the following types of commands:
|
|
1139
|
+
* - Bat scripts for Windows instances (RunBatScript).
|
|
1140
|
+
* - PowerShell scripts for Windows instances (RunPowerShellScript).
|
|
1141
|
+
* - Shell scripts for Linux instances (RunShellScript).
|
|
1142
|
+
* - You can specify the Timeout parameter to set the maximum timeout period for a command to run on an ECS instance. If the command times out, [Cloud Assistant Agent](https://help.aliyun.com/document_detail/64921.html) forcefully terminates the command process by canceling the PID of the command.
|
|
1143
|
+
* - For a one-time execution, after the command times out, the execution status ([InvokeRecordStatus](https://help.aliyun.com/document_detail/64845.html)) of the command on the specified ECS instance changes to Failed.
|
|
1144
|
+
* - For a scheduled execution:
|
|
1145
|
+
* - The timeout period takes effect for each execution record.
|
|
1146
|
+
* - After a specific execution times out, the status ([InvokeRecordStatus](https://help.aliyun.com/document_detail/64845.html)) of that execution record changes to Failed.
|
|
1147
|
+
* - The timeout of a previous execution does not affect the next execution.
|
|
1148
|
+
* - You can retain up to 500 to 50,000 Cloud Assistant commands in a region. You can also request a quota increase. For information about how to query and increase quotas, refer to [Quota management](https://help.aliyun.com/document_detail/184116.html).
|
|
1149
|
+
* - You can specify the WorkingDir parameter to set the execution path of a command. For Linux instances, the default path is the home directory of the root user, which is `/root`. For Windows instances, the default path is the directory where the Cloud Assistant Agent process is located, such as `C:\\Windows\\System32`.
|
|
1150
|
+
* - You can set EnableParameter to true to enable the custom parameter feature. When you set CommandContent, you can define custom parameters in the {{parameter}} format and pass in custom parameter key-value pairs when you run the command by calling [InvokeCommand](https://help.aliyun.com/document_detail/64841.html). For example, if you create the command `echo {{name}}` and pass in the key-value pair `<name, Jack>` through the Parameters parameter when you call InvokeCommand, the custom parameter is automatically replaced. The resulting command `echo Jack` is then run on the instance.
|
|
1149
1151
|
*
|
|
1150
1152
|
* @param request - CreateCommandRequest
|
|
1151
1153
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1153,23 +1155,23 @@ export default class Client extends OpenApi {
|
|
|
1153
1155
|
*/
|
|
1154
1156
|
createCommandWithOptions(request: $_model.CreateCommandRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCommandResponse>;
|
|
1155
1157
|
/**
|
|
1156
|
-
*
|
|
1158
|
+
* Creates a Cloud Assistant command of the Shell, PowerShell, or Bat script type.
|
|
1157
1159
|
*
|
|
1158
1160
|
* @remarks
|
|
1159
|
-
* ##
|
|
1160
|
-
* - You can create
|
|
1161
|
-
*
|
|
1162
|
-
*
|
|
1163
|
-
*
|
|
1164
|
-
* - You can specify the Timeout parameter to set the maximum timeout
|
|
1165
|
-
*
|
|
1166
|
-
*
|
|
1167
|
-
*
|
|
1168
|
-
*
|
|
1169
|
-
*
|
|
1170
|
-
* -
|
|
1171
|
-
* - You can
|
|
1172
|
-
* - You can enable the
|
|
1161
|
+
* ## Operation description
|
|
1162
|
+
* - You can create the following types of commands:
|
|
1163
|
+
* - Bat scripts for Windows instances (RunBatScript).
|
|
1164
|
+
* - PowerShell scripts for Windows instances (RunPowerShellScript).
|
|
1165
|
+
* - Shell scripts for Linux instances (RunShellScript).
|
|
1166
|
+
* - You can specify the Timeout parameter to set the maximum timeout period for a command to run on an ECS instance. If the command times out, [Cloud Assistant Agent](https://help.aliyun.com/document_detail/64921.html) forcefully terminates the command process by canceling the PID of the command.
|
|
1167
|
+
* - For a one-time execution, after the command times out, the execution status ([InvokeRecordStatus](https://help.aliyun.com/document_detail/64845.html)) of the command on the specified ECS instance changes to Failed.
|
|
1168
|
+
* - For a scheduled execution:
|
|
1169
|
+
* - The timeout period takes effect for each execution record.
|
|
1170
|
+
* - After a specific execution times out, the status ([InvokeRecordStatus](https://help.aliyun.com/document_detail/64845.html)) of that execution record changes to Failed.
|
|
1171
|
+
* - The timeout of a previous execution does not affect the next execution.
|
|
1172
|
+
* - You can retain up to 500 to 50,000 Cloud Assistant commands in a region. You can also request a quota increase. For information about how to query and increase quotas, refer to [Quota management](https://help.aliyun.com/document_detail/184116.html).
|
|
1173
|
+
* - You can specify the WorkingDir parameter to set the execution path of a command. For Linux instances, the default path is the home directory of the root user, which is `/root`. For Windows instances, the default path is the directory where the Cloud Assistant Agent process is located, such as `C:\\Windows\\System32`.
|
|
1174
|
+
* - You can set EnableParameter to true to enable the custom parameter feature. When you set CommandContent, you can define custom parameters in the {{parameter}} format and pass in custom parameter key-value pairs when you run the command by calling [InvokeCommand](https://help.aliyun.com/document_detail/64841.html). For example, if you create the command `echo {{name}}` and pass in the key-value pair `<name, Jack>` through the Parameters parameter when you call InvokeCommand, the custom parameter is automatically replaced. The resulting command `echo Jack` is then run on the instance.
|
|
1173
1175
|
*
|
|
1174
1176
|
* @param request - CreateCommandRequest
|
|
1175
1177
|
* @returns CreateCommandResponse
|
|
@@ -1239,14 +1241,14 @@ export default class Client extends OpenApi {
|
|
|
1239
1241
|
* Creates a pay-as-you-go or subscription data disk.
|
|
1240
1242
|
*
|
|
1241
1243
|
* @remarks
|
|
1242
|
-
* - When
|
|
1243
|
-
* -
|
|
1244
|
-
* -
|
|
1245
|
-
* - Creating a disk
|
|
1246
|
-
* - Default settings when
|
|
1247
|
-
* - Automatic snapshots of the disk are deleted when the disk is deleted
|
|
1248
|
-
* - When
|
|
1249
|
-
* - The billing method is pay-as-you-go,
|
|
1244
|
+
* - When you create a disk, you can enable the multi-attach feature (`MultiAttach`). Learn about this attribute and its limits before you use it. For more information, see [ESSD cloud disks that support NVMe](https://help.aliyun.com/document_detail/256487.html) and [Use the multi-attach feature](https://help.aliyun.com/document_detail/262105.html).
|
|
1245
|
+
* - The following disk types can be created: basic disks, ultra disks, standard SSDs, enterprise SSDs, ESSD Entry disks, regional Enterprise SSDs (ESSDs), ESSD AutoPL disks, elastic ephemeral disks - Standard Edition, and elastic ephemeral disks - Premium Edition.
|
|
1246
|
+
* - To create a disk, complete [real-name registration](https://account.console.aliyun.com/#/auth/home).
|
|
1247
|
+
* - Creating a disk incurs fees. Learn about the billing method of Elastic Compute Service (ECS) in advance. For more information, see [Billing overview](https://help.aliyun.com/document_detail/25398.html).
|
|
1248
|
+
* - Default settings when you create a disk:
|
|
1249
|
+
* - Automatic snapshots of the disk are deleted when the disk is deleted. That is, `DeleteAutoSnapshot` is set to `true`. You can call [DescribeDisks](https://help.aliyun.com/document_detail/2679767.html) to query the parameter settings, and call [ModifyDiskAttribute](https://help.aliyun.com/document_detail/25517.html) to modify the property.
|
|
1250
|
+
* - When you create an enterprise SSD, if you do not configure a performance level, the default level is PL1. You can call [ModifyDiskSpec](https://help.aliyun.com/document_detail/123780.html) to change the performance level.
|
|
1251
|
+
* - The billing method is pay-as-you-go, which means the `Portable` property defaults to `true`.
|
|
1250
1252
|
*
|
|
1251
1253
|
* @param request - CreateDiskRequest
|
|
1252
1254
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1257,14 +1259,14 @@ export default class Client extends OpenApi {
|
|
|
1257
1259
|
* Creates a pay-as-you-go or subscription data disk.
|
|
1258
1260
|
*
|
|
1259
1261
|
* @remarks
|
|
1260
|
-
* - When
|
|
1261
|
-
* -
|
|
1262
|
-
* -
|
|
1263
|
-
* - Creating a disk
|
|
1264
|
-
* - Default settings when
|
|
1265
|
-
* - Automatic snapshots of the disk are deleted when the disk is deleted
|
|
1266
|
-
* - When
|
|
1267
|
-
* - The billing method is pay-as-you-go,
|
|
1262
|
+
* - When you create a disk, you can enable the multi-attach feature (`MultiAttach`). Learn about this attribute and its limits before you use it. For more information, see [ESSD cloud disks that support NVMe](https://help.aliyun.com/document_detail/256487.html) and [Use the multi-attach feature](https://help.aliyun.com/document_detail/262105.html).
|
|
1263
|
+
* - The following disk types can be created: basic disks, ultra disks, standard SSDs, enterprise SSDs, ESSD Entry disks, regional Enterprise SSDs (ESSDs), ESSD AutoPL disks, elastic ephemeral disks - Standard Edition, and elastic ephemeral disks - Premium Edition.
|
|
1264
|
+
* - To create a disk, complete [real-name registration](https://account.console.aliyun.com/#/auth/home).
|
|
1265
|
+
* - Creating a disk incurs fees. Learn about the billing method of Elastic Compute Service (ECS) in advance. For more information, see [Billing overview](https://help.aliyun.com/document_detail/25398.html).
|
|
1266
|
+
* - Default settings when you create a disk:
|
|
1267
|
+
* - Automatic snapshots of the disk are deleted when the disk is deleted. That is, `DeleteAutoSnapshot` is set to `true`. You can call [DescribeDisks](https://help.aliyun.com/document_detail/2679767.html) to query the parameter settings, and call [ModifyDiskAttribute](https://help.aliyun.com/document_detail/25517.html) to modify the property.
|
|
1268
|
+
* - When you create an enterprise SSD, if you do not configure a performance level, the default level is PL1. You can call [ModifyDiskSpec](https://help.aliyun.com/document_detail/123780.html) to change the performance level.
|
|
1269
|
+
* - The billing method is pay-as-you-go, which means the `Portable` property defaults to `true`.
|
|
1268
1270
|
*
|
|
1269
1271
|
* @param request - CreateDiskRequest
|
|
1270
1272
|
* @returns CreateDiskResponse
|
|
@@ -1336,7 +1338,7 @@ export default class Client extends OpenApi {
|
|
|
1336
1338
|
*/
|
|
1337
1339
|
createHaVip(request: $_model.CreateHaVipRequest): Promise<$_model.CreateHaVipResponse>;
|
|
1338
1340
|
/**
|
|
1339
|
-
* Creates
|
|
1341
|
+
* Creates an HPC cluster by calling CreateHpcCluster.
|
|
1340
1342
|
*
|
|
1341
1343
|
* @param request - CreateHpcClusterRequest
|
|
1342
1344
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1344,33 +1346,32 @@ export default class Client extends OpenApi {
|
|
|
1344
1346
|
*/
|
|
1345
1347
|
createHpcClusterWithOptions(request: $_model.CreateHpcClusterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateHpcClusterResponse>;
|
|
1346
1348
|
/**
|
|
1347
|
-
* Creates
|
|
1349
|
+
* Creates an HPC cluster by calling CreateHpcCluster.
|
|
1348
1350
|
*
|
|
1349
1351
|
* @param request - CreateHpcClusterRequest
|
|
1350
1352
|
* @returns CreateHpcClusterResponse
|
|
1351
1353
|
*/
|
|
1352
1354
|
createHpcCluster(request: $_model.CreateHpcClusterRequest): Promise<$_model.CreateHpcClusterResponse>;
|
|
1353
1355
|
/**
|
|
1354
|
-
*
|
|
1356
|
+
* Creates a custom image. You can use the created custom image to create ECS instances (RunInstances) or replace the system disk of an instance (ReplaceSystemDisk).
|
|
1355
1357
|
*
|
|
1356
1358
|
* @remarks
|
|
1357
|
-
* ###
|
|
1358
|
-
* - This
|
|
1359
|
-
* -
|
|
1360
|
-
* -
|
|
1361
|
-
*
|
|
1359
|
+
* ### Before you begin
|
|
1360
|
+
* - This is an asynchronous operation. After a request to create a custom image is sent, the image ID is returned. However, the image creation is not immediately complete. Call [DescribeImage](https://help.aliyun.com/document_detail/2679797.html) to query the image information. When the status in the response is `Available`, the image is created and ready for use. For more information, see [Custom image overview](https://help.aliyun.com/document_detail/172789.html).
|
|
1361
|
+
* - When you query ECS instance information, if the response contains {"OperationLocks": {"LockReason" : "security"}}, you cannot create a custom image.
|
|
1362
|
+
* - Configure the image detection parameter `DetectionStrategy` when creating an image to help the system optimize your image. For more information, see [Image detection overview](https://help.aliyun.com/document_detail/439819.html).
|
|
1363
|
+
* The following describes three methods to create a custom image by calling this operation. The priority of request parameters is: InstanceId > DiskDeviceMapping > SnapshotId. If your request contains two or more of these parameters, the image is created based on the parameter with the highest priority.
|
|
1362
1364
|
* - **Create a custom image from an instance**: Specify the instance ID (`InstanceId`).
|
|
1363
|
-
* - The instance must be in the `Running` or `Stopped` state.
|
|
1364
|
-
* -
|
|
1365
|
-
* >Notice:
|
|
1366
|
-
*
|
|
1367
|
-
*
|
|
1368
|
-
*
|
|
1369
|
-
*
|
|
1370
|
-
*
|
|
1371
|
-
*
|
|
1372
|
-
*
|
|
1373
|
-
* > When you release an instance, the system retains its system disk and converts it to a pay-as-you-go data disk. You cannot use snapshots of this disk to create custom images. If you need a custom image, create it before you release the instance.
|
|
1365
|
+
* - The instance must be in the Running (`Running`) or Stopped (`Stopped`) state.
|
|
1366
|
+
* - After the operation is called, a new snapshot is created for each disk of the instance.
|
|
1367
|
+
* >Notice: Because a running instance may have cached data that has not been written to disks, the data of the created custom image may be inconsistent with the instance data. Stop the instance ([StopInstances](https://help.aliyun.com/document_detail/155372.html)) before creating the image.
|
|
1368
|
+
* - **Create a custom image from a snapshot (the specified snapshot cannot be one created on or before July 15, 2013.)**
|
|
1369
|
+
* - **Create a custom image from a system disk snapshot**: Specify only the snapshot ID of the instance system disk (`SnapshotId`).
|
|
1370
|
+
* - **Create a custom image from system disk and data disk snapshots**: Establish data associations among multiple disks (`DiskDeviceMapping`).
|
|
1371
|
+
* - Only one system disk snapshot can be specified.
|
|
1372
|
+
* - You can specify multiple data disk snapshots, up to a maximum of 16. If `DiskDeviceMapping.N.SnapshotId` is not specified, an empty data disk with the default capacity is created.
|
|
1373
|
+
*
|
|
1374
|
+
* > When an instance is released, the system disk is retained as a pay-as-you-go data disk. Snapshots created from this disk do not support creating custom images. Create a custom image before releasing the instance as needed.
|
|
1374
1375
|
*
|
|
1375
1376
|
* @param request - CreateImageRequest
|
|
1376
1377
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1378,39 +1379,38 @@ export default class Client extends OpenApi {
|
|
|
1378
1379
|
*/
|
|
1379
1380
|
createImageWithOptions(request: $_model.CreateImageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateImageResponse>;
|
|
1380
1381
|
/**
|
|
1381
|
-
*
|
|
1382
|
+
* Creates a custom image. You can use the created custom image to create ECS instances (RunInstances) or replace the system disk of an instance (ReplaceSystemDisk).
|
|
1382
1383
|
*
|
|
1383
1384
|
* @remarks
|
|
1384
|
-
* ###
|
|
1385
|
-
* - This
|
|
1386
|
-
* -
|
|
1387
|
-
* -
|
|
1388
|
-
*
|
|
1385
|
+
* ### Before you begin
|
|
1386
|
+
* - This is an asynchronous operation. After a request to create a custom image is sent, the image ID is returned. However, the image creation is not immediately complete. Call [DescribeImage](https://help.aliyun.com/document_detail/2679797.html) to query the image information. When the status in the response is `Available`, the image is created and ready for use. For more information, see [Custom image overview](https://help.aliyun.com/document_detail/172789.html).
|
|
1387
|
+
* - When you query ECS instance information, if the response contains {"OperationLocks": {"LockReason" : "security"}}, you cannot create a custom image.
|
|
1388
|
+
* - Configure the image detection parameter `DetectionStrategy` when creating an image to help the system optimize your image. For more information, see [Image detection overview](https://help.aliyun.com/document_detail/439819.html).
|
|
1389
|
+
* The following describes three methods to create a custom image by calling this operation. The priority of request parameters is: InstanceId > DiskDeviceMapping > SnapshotId. If your request contains two or more of these parameters, the image is created based on the parameter with the highest priority.
|
|
1389
1390
|
* - **Create a custom image from an instance**: Specify the instance ID (`InstanceId`).
|
|
1390
|
-
* - The instance must be in the `Running` or `Stopped` state.
|
|
1391
|
-
* -
|
|
1392
|
-
* >Notice:
|
|
1393
|
-
*
|
|
1394
|
-
*
|
|
1395
|
-
*
|
|
1396
|
-
*
|
|
1397
|
-
*
|
|
1398
|
-
*
|
|
1399
|
-
*
|
|
1400
|
-
* > When you release an instance, the system retains its system disk and converts it to a pay-as-you-go data disk. You cannot use snapshots of this disk to create custom images. If you need a custom image, create it before you release the instance.
|
|
1391
|
+
* - The instance must be in the Running (`Running`) or Stopped (`Stopped`) state.
|
|
1392
|
+
* - After the operation is called, a new snapshot is created for each disk of the instance.
|
|
1393
|
+
* >Notice: Because a running instance may have cached data that has not been written to disks, the data of the created custom image may be inconsistent with the instance data. Stop the instance ([StopInstances](https://help.aliyun.com/document_detail/155372.html)) before creating the image.
|
|
1394
|
+
* - **Create a custom image from a snapshot (the specified snapshot cannot be one created on or before July 15, 2013.)**
|
|
1395
|
+
* - **Create a custom image from a system disk snapshot**: Specify only the snapshot ID of the instance system disk (`SnapshotId`).
|
|
1396
|
+
* - **Create a custom image from system disk and data disk snapshots**: Establish data associations among multiple disks (`DiskDeviceMapping`).
|
|
1397
|
+
* - Only one system disk snapshot can be specified.
|
|
1398
|
+
* - You can specify multiple data disk snapshots, up to a maximum of 16. If `DiskDeviceMapping.N.SnapshotId` is not specified, an empty data disk with the default capacity is created.
|
|
1399
|
+
*
|
|
1400
|
+
* > When an instance is released, the system disk is retained as a pay-as-you-go data disk. Snapshots created from this disk do not support creating custom images. Create a custom image before releasing the instance as needed.
|
|
1401
1401
|
*
|
|
1402
1402
|
* @param request - CreateImageRequest
|
|
1403
1403
|
* @returns CreateImageResponse
|
|
1404
1404
|
*/
|
|
1405
1405
|
createImage(request: $_model.CreateImageRequest): Promise<$_model.CreateImageResponse>;
|
|
1406
1406
|
/**
|
|
1407
|
-
* Creates an image component. Image components store commonly used build template commands for image building.
|
|
1407
|
+
* Creates an image component. Image components are used to store commonly used build template commands for image building.
|
|
1408
1408
|
*
|
|
1409
1409
|
* @remarks
|
|
1410
1410
|
* ## Operation description
|
|
1411
1411
|
* Before you create an image component, take note of the following items:
|
|
1412
|
-
* -
|
|
1413
|
-
* - Component version numbers must be unique for
|
|
1412
|
+
* - Only custom image components can be created.
|
|
1413
|
+
* - Component version numbers must be unique for the same component name. When using a component in a template, you can reference it by name and version number.
|
|
1414
1414
|
* - The content size of an image component cannot exceed 16 KB. For details about supported commands, see [Commands supported by Image Builder](https://help.aliyun.com/document_detail/200206.html).
|
|
1415
1415
|
* For more information, see [Image Builder overview](https://help.aliyun.com/document_detail/197410.html).
|
|
1416
1416
|
*
|
|
@@ -1420,13 +1420,13 @@ export default class Client extends OpenApi {
|
|
|
1420
1420
|
*/
|
|
1421
1421
|
createImageComponentWithOptions(request: $_model.CreateImageComponentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateImageComponentResponse>;
|
|
1422
1422
|
/**
|
|
1423
|
-
* Creates an image component. Image components store commonly used build template commands for image building.
|
|
1423
|
+
* Creates an image component. Image components are used to store commonly used build template commands for image building.
|
|
1424
1424
|
*
|
|
1425
1425
|
* @remarks
|
|
1426
1426
|
* ## Operation description
|
|
1427
1427
|
* Before you create an image component, take note of the following items:
|
|
1428
|
-
* -
|
|
1429
|
-
* - Component version numbers must be unique for
|
|
1428
|
+
* - Only custom image components can be created.
|
|
1429
|
+
* - Component version numbers must be unique for the same component name. When using a component in a template, you can reference it by name and version number.
|
|
1430
1430
|
* - The content size of an image component cannot exceed 16 KB. For details about supported commands, see [Commands supported by Image Builder](https://help.aliyun.com/document_detail/200206.html).
|
|
1431
1431
|
* For more information, see [Image Builder overview](https://help.aliyun.com/document_detail/197410.html).
|
|
1432
1432
|
*
|
|
@@ -1472,31 +1472,32 @@ export default class Client extends OpenApi {
|
|
|
1472
1472
|
*/
|
|
1473
1473
|
createImagePipeline(request: $_model.CreateImagePipelineRequest): Promise<$_model.CreateImagePipelineResponse>;
|
|
1474
1474
|
/**
|
|
1475
|
-
*
|
|
1475
|
+
* Creates a subscription or pay-as-you-go Elastic Compute Service (ECS) instance with customizable parameters.
|
|
1476
1476
|
*
|
|
1477
1477
|
* @remarks
|
|
1478
|
-
* > This
|
|
1478
|
+
* > This operation is no longer maintained. Use [RunInstances](https://help.aliyun.com/document_detail/2679677.html) instead.
|
|
1479
1479
|
* <props="china">
|
|
1480
|
-
* **Before
|
|
1480
|
+
* **Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of ECS.**
|
|
1481
1481
|
* <props="intl">
|
|
1482
|
-
* **Before
|
|
1483
|
-
*
|
|
1484
|
-
* ###
|
|
1482
|
+
* **Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/zh/pricing-calculator#/commodity/vm_intl) of ECS.**
|
|
1483
|
+
* This is an asynchronous operation. After a request to create an instance is sent, the instance ID is returned. The instance is not immediately created. Call [DescribeInstanceStatus](https://help.aliyun.com/document_detail/2679688.html) to query the instance status. When the status is `Stopped`, the instance is created. Then you can call [StartInstance](https://help.aliyun.com/document_detail/2679679.html) to start the instance.
|
|
1484
|
+
* ### Before you begin
|
|
1485
1485
|
* <props="china">
|
|
1486
|
-
* - Make sure that your account has passed real-name
|
|
1487
|
-
* - Creating an instance incurs charges. Make sure that you understand the
|
|
1488
|
-
*
|
|
1489
|
-
* -
|
|
1490
|
-
*
|
|
1491
|
-
*
|
|
1492
|
-
* -
|
|
1493
|
-
* -
|
|
1494
|
-
* -
|
|
1495
|
-
*
|
|
1486
|
+
* - Make sure that your account has passed real-name registration. For more information, see [Real-name registration documentation](https://help.aliyun.com/document_detail/48263.html).
|
|
1487
|
+
* - Creating an instance incurs charges. Make sure that you understand the billable methods of Elastic Computing Service (ECS). For more information, see [Billing overview](https://help.aliyun.com/document_detail/25398.html).
|
|
1488
|
+
*
|
|
1489
|
+
* - Make sure that the total number of instances or the total number of vCPUs across all instance types does not exceed the quota. For more information, see [Quota Center](https://quotas.console.aliyun.com/products/ecs/quotas).
|
|
1490
|
+
* - Before creating a VPC-connected instance, create a VPC in the corresponding region. For more information, see [Create a VPC](https://help.aliyun.com/document_detail/65430.html).
|
|
1491
|
+
* ### Before you begin
|
|
1492
|
+
* - When you invoke this operation, the system does not send notifications (including text messages, emails, or internal messages) about instance creation.
|
|
1493
|
+
* - If the billable methods of the instance is subscription (`PrePaid`), active coupon in your account are used by default during payment.
|
|
1494
|
+
* - If the instance memory is 512 MiB, you cannot use Windows Server images except through the half-year channel. If the instance memory is 4 GiB or more, you cannot use 32-bit operating system images.
|
|
1495
|
+
* - Instances created by invoking this operation are not assigned Internet IP addresses. If the public bandwidth is greater than 0, invoke [AllocatePublicIpAddress](https://help.aliyun.com/document_detail/25544.html) to assign a public IP address. If the public bandwidth is 0, invoke [ModifyInstanceNetworkSpec](https://help.aliyun.com/document_detail/2679879.html) to adjust the bandwidth and then invoke [AllocatePublicIpAddress](https://help.aliyun.com/document_detail/25544.html) to assign a public IP address.
|
|
1496
|
+
* > In a single region, the total peak pay-by-bandwidth Internet bandwidth for a single Alibaba Cloud account is limited. For more information, see [Public bandwidth limits](~~25412#BandwidthQuota~~).
|
|
1496
1497
|
* ### Recommendations
|
|
1497
|
-
* - **
|
|
1498
|
-
* - **Check
|
|
1499
|
-
* - **User data**: If
|
|
1498
|
+
* - **Instance type selection**: See [Instance family](https://help.aliyun.com/document_detail/25378.html) or invoke [DescribeInstanceTypes](https://help.aliyun.com/document_detail/25620.html) to query the performance data of the target instance type. You can also see [Settings for instance type selection](https://help.aliyun.com/document_detail/58291.html) to learn how to select an instance type.
|
|
1499
|
+
* - **Check active resources**: Invoke [DescribeAvailableResource](https://help.aliyun.com/document_detail/66186.html) to query active resources in a specific region or zone.
|
|
1500
|
+
* - **User data**: If the instance meets the requirements for [instance user data](https://help.aliyun.com/document_detail/49121.html), you can pass in UserData. The `UserData` data is not encrypted when the API request is sent. Do not send confidential information such as passwords or private keys in plaintext. If you must pass in such information, encrypt it and use Base64 encoding before passing it in. Then perform decryption inside the instance.
|
|
1500
1501
|
*
|
|
1501
1502
|
* @param request - CreateInstanceRequest
|
|
1502
1503
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1504,31 +1505,32 @@ export default class Client extends OpenApi {
|
|
|
1504
1505
|
*/
|
|
1505
1506
|
createInstanceWithOptions(request: $_model.CreateInstanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateInstanceResponse>;
|
|
1506
1507
|
/**
|
|
1507
|
-
*
|
|
1508
|
+
* Creates a subscription or pay-as-you-go Elastic Compute Service (ECS) instance with customizable parameters.
|
|
1508
1509
|
*
|
|
1509
1510
|
* @remarks
|
|
1510
|
-
* > This
|
|
1511
|
+
* > This operation is no longer maintained. Use [RunInstances](https://help.aliyun.com/document_detail/2679677.html) instead.
|
|
1511
1512
|
* <props="china">
|
|
1512
|
-
* **Before
|
|
1513
|
+
* **Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of ECS.**
|
|
1513
1514
|
* <props="intl">
|
|
1514
|
-
* **Before
|
|
1515
|
-
*
|
|
1516
|
-
* ###
|
|
1515
|
+
* **Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/zh/pricing-calculator#/commodity/vm_intl) of ECS.**
|
|
1516
|
+
* This is an asynchronous operation. After a request to create an instance is sent, the instance ID is returned. The instance is not immediately created. Call [DescribeInstanceStatus](https://help.aliyun.com/document_detail/2679688.html) to query the instance status. When the status is `Stopped`, the instance is created. Then you can call [StartInstance](https://help.aliyun.com/document_detail/2679679.html) to start the instance.
|
|
1517
|
+
* ### Before you begin
|
|
1517
1518
|
* <props="china">
|
|
1518
|
-
* - Make sure that your account has passed real-name
|
|
1519
|
-
* - Creating an instance incurs charges. Make sure that you understand the
|
|
1520
|
-
*
|
|
1521
|
-
* -
|
|
1522
|
-
*
|
|
1523
|
-
*
|
|
1524
|
-
* -
|
|
1525
|
-
* -
|
|
1526
|
-
* -
|
|
1527
|
-
*
|
|
1519
|
+
* - Make sure that your account has passed real-name registration. For more information, see [Real-name registration documentation](https://help.aliyun.com/document_detail/48263.html).
|
|
1520
|
+
* - Creating an instance incurs charges. Make sure that you understand the billable methods of Elastic Computing Service (ECS). For more information, see [Billing overview](https://help.aliyun.com/document_detail/25398.html).
|
|
1521
|
+
*
|
|
1522
|
+
* - Make sure that the total number of instances or the total number of vCPUs across all instance types does not exceed the quota. For more information, see [Quota Center](https://quotas.console.aliyun.com/products/ecs/quotas).
|
|
1523
|
+
* - Before creating a VPC-connected instance, create a VPC in the corresponding region. For more information, see [Create a VPC](https://help.aliyun.com/document_detail/65430.html).
|
|
1524
|
+
* ### Before you begin
|
|
1525
|
+
* - When you invoke this operation, the system does not send notifications (including text messages, emails, or internal messages) about instance creation.
|
|
1526
|
+
* - If the billable methods of the instance is subscription (`PrePaid`), active coupon in your account are used by default during payment.
|
|
1527
|
+
* - If the instance memory is 512 MiB, you cannot use Windows Server images except through the half-year channel. If the instance memory is 4 GiB or more, you cannot use 32-bit operating system images.
|
|
1528
|
+
* - Instances created by invoking this operation are not assigned Internet IP addresses. If the public bandwidth is greater than 0, invoke [AllocatePublicIpAddress](https://help.aliyun.com/document_detail/25544.html) to assign a public IP address. If the public bandwidth is 0, invoke [ModifyInstanceNetworkSpec](https://help.aliyun.com/document_detail/2679879.html) to adjust the bandwidth and then invoke [AllocatePublicIpAddress](https://help.aliyun.com/document_detail/25544.html) to assign a public IP address.
|
|
1529
|
+
* > In a single region, the total peak pay-by-bandwidth Internet bandwidth for a single Alibaba Cloud account is limited. For more information, see [Public bandwidth limits](~~25412#BandwidthQuota~~).
|
|
1528
1530
|
* ### Recommendations
|
|
1529
|
-
* - **
|
|
1530
|
-
* - **Check
|
|
1531
|
-
* - **User data**: If
|
|
1531
|
+
* - **Instance type selection**: See [Instance family](https://help.aliyun.com/document_detail/25378.html) or invoke [DescribeInstanceTypes](https://help.aliyun.com/document_detail/25620.html) to query the performance data of the target instance type. You can also see [Settings for instance type selection](https://help.aliyun.com/document_detail/58291.html) to learn how to select an instance type.
|
|
1532
|
+
* - **Check active resources**: Invoke [DescribeAvailableResource](https://help.aliyun.com/document_detail/66186.html) to query active resources in a specific region or zone.
|
|
1533
|
+
* - **User data**: If the instance meets the requirements for [instance user data](https://help.aliyun.com/document_detail/49121.html), you can pass in UserData. The `UserData` data is not encrypted when the API request is sent. Do not send confidential information such as passwords or private keys in plaintext. If you must pass in such information, encrypt it and use Base64 encoding before passing it in. Then perform decryption inside the instance.
|
|
1532
1534
|
*
|
|
1533
1535
|
* @param request - CreateInstanceRequest
|
|
1534
1536
|
* @returns CreateInstanceResponse
|
|
@@ -1558,15 +1560,15 @@ export default class Client extends OpenApi {
|
|
|
1558
1560
|
*/
|
|
1559
1561
|
createKeyPair(request: $_model.CreateKeyPairRequest): Promise<$_model.CreateKeyPairResponse>;
|
|
1560
1562
|
/**
|
|
1561
|
-
*
|
|
1563
|
+
* Creates an ECS instance launch template. A launch template eliminates the need to configure a large number of parameters every time you create an instance.
|
|
1562
1564
|
*
|
|
1563
1565
|
* @remarks
|
|
1564
|
-
* After you
|
|
1565
|
-
* A launch template version
|
|
1566
|
-
* When
|
|
1567
|
-
* -
|
|
1568
|
-
* -
|
|
1569
|
-
* -
|
|
1566
|
+
* After you call CreateLaunchTemplate to create a template, a default version with version number 1 is automatically generated. You can then create multiple versions based on this template (`CreateLaunchTemplateVersion`), with version numbers incrementing sequentially from 1. If you do not specify a template version when creating instances ([RunInstances](https://help.aliyun.com/document_detail/63440.html)), the default version is used.
|
|
1567
|
+
* A launch template version contains the configurations for creating instances, such as the region, image ID, instance type, security group ID, and public bandwidth. If a specific configuration is not specified in the version, you must specify it when you create instances.
|
|
1568
|
+
* When you call this operation, take note of the following items:
|
|
1569
|
+
* - Each account can create up to 30 launch templates per region, and each template can have up to 30 versions.
|
|
1570
|
+
* - Most parameters in a launch template are optional. When you create a template, Alibaba Cloud does not verify the existence or validity of parameter values. The validity of parameter values is verified only when you create instances.
|
|
1571
|
+
* - If a configuration is specified in the launch template, it cannot be filtered out when you create instances ([RunInstances](https://help.aliyun.com/document_detail/63440.html)). For example, if the template specifies `HostName=LocalHost` and the `HostName` value is left empty in `RunInstances`, the hostname of the instance is still `LocalHost`. To override the `HostName=LocalHost` configuration, set `HostName=MyHost` or another value in `RunInstances`.
|
|
1570
1572
|
*
|
|
1571
1573
|
* @param request - CreateLaunchTemplateRequest
|
|
1572
1574
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1574,26 +1576,26 @@ export default class Client extends OpenApi {
|
|
|
1574
1576
|
*/
|
|
1575
1577
|
createLaunchTemplateWithOptions(request: $_model.CreateLaunchTemplateRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateLaunchTemplateResponse>;
|
|
1576
1578
|
/**
|
|
1577
|
-
*
|
|
1579
|
+
* Creates an ECS instance launch template. A launch template eliminates the need to configure a large number of parameters every time you create an instance.
|
|
1578
1580
|
*
|
|
1579
1581
|
* @remarks
|
|
1580
|
-
* After you
|
|
1581
|
-
* A launch template version
|
|
1582
|
-
* When
|
|
1583
|
-
* -
|
|
1584
|
-
* -
|
|
1585
|
-
* -
|
|
1582
|
+
* After you call CreateLaunchTemplate to create a template, a default version with version number 1 is automatically generated. You can then create multiple versions based on this template (`CreateLaunchTemplateVersion`), with version numbers incrementing sequentially from 1. If you do not specify a template version when creating instances ([RunInstances](https://help.aliyun.com/document_detail/63440.html)), the default version is used.
|
|
1583
|
+
* A launch template version contains the configurations for creating instances, such as the region, image ID, instance type, security group ID, and public bandwidth. If a specific configuration is not specified in the version, you must specify it when you create instances.
|
|
1584
|
+
* When you call this operation, take note of the following items:
|
|
1585
|
+
* - Each account can create up to 30 launch templates per region, and each template can have up to 30 versions.
|
|
1586
|
+
* - Most parameters in a launch template are optional. When you create a template, Alibaba Cloud does not verify the existence or validity of parameter values. The validity of parameter values is verified only when you create instances.
|
|
1587
|
+
* - If a configuration is specified in the launch template, it cannot be filtered out when you create instances ([RunInstances](https://help.aliyun.com/document_detail/63440.html)). For example, if the template specifies `HostName=LocalHost` and the `HostName` value is left empty in `RunInstances`, the hostname of the instance is still `LocalHost`. To override the `HostName=LocalHost` configuration, set `HostName=MyHost` or another value in `RunInstances`.
|
|
1586
1588
|
*
|
|
1587
1589
|
* @param request - CreateLaunchTemplateRequest
|
|
1588
1590
|
* @returns CreateLaunchTemplateResponse
|
|
1589
1591
|
*/
|
|
1590
1592
|
createLaunchTemplate(request: $_model.CreateLaunchTemplateRequest): Promise<$_model.CreateLaunchTemplateResponse>;
|
|
1591
1593
|
/**
|
|
1592
|
-
*
|
|
1594
|
+
* Creates a new version in a specified ECS launch template for subsequent creation of ECS instances, elastic scaling groups, or auto provisioning groups.
|
|
1593
1595
|
*
|
|
1594
1596
|
* @remarks
|
|
1595
|
-
* ##
|
|
1596
|
-
*
|
|
1597
|
+
* ## Operation description
|
|
1598
|
+
* To modify the parameters of a specific version, create a new template version. Each instance launch template supports a maximum of 30 versions.
|
|
1597
1599
|
*
|
|
1598
1600
|
* @param request - CreateLaunchTemplateVersionRequest
|
|
1599
1601
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1601,11 +1603,11 @@ export default class Client extends OpenApi {
|
|
|
1601
1603
|
*/
|
|
1602
1604
|
createLaunchTemplateVersionWithOptions(request: $_model.CreateLaunchTemplateVersionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateLaunchTemplateVersionResponse>;
|
|
1603
1605
|
/**
|
|
1604
|
-
*
|
|
1606
|
+
* Creates a new version in a specified ECS launch template for subsequent creation of ECS instances, elastic scaling groups, or auto provisioning groups.
|
|
1605
1607
|
*
|
|
1606
1608
|
* @remarks
|
|
1607
|
-
* ##
|
|
1608
|
-
*
|
|
1609
|
+
* ## Operation description
|
|
1610
|
+
* To modify the parameters of a specific version, create a new template version. Each instance launch template supports a maximum of 30 versions.
|
|
1609
1611
|
*
|
|
1610
1612
|
* @param request - CreateLaunchTemplateVersionRequest
|
|
1611
1613
|
* @returns CreateLaunchTemplateVersionResponse
|
|
@@ -1865,10 +1867,10 @@ export default class Client extends OpenApi {
|
|
|
1865
1867
|
* Creates a security group.
|
|
1866
1868
|
*
|
|
1867
1869
|
* @remarks
|
|
1868
|
-
* -
|
|
1869
|
-
* -
|
|
1870
|
-
* -
|
|
1871
|
-
* -
|
|
1870
|
+
* - The default internal connectivity policy for a basic security group created by this operation is **intra-group connectivity**. You can modify this policy by calling [ModifySecurityGroupPolicy](https://help.aliyun.com/document_detail/2679846.html).
|
|
1871
|
+
* - The default internal connectivity policy for an advanced security group created by this operation is **internal isolation**, and this policy cannot be modified.
|
|
1872
|
+
* - The number of security groups in a single region is limited. You can create a minimum of 100 security groups. For more information, see [Security group limits](~~25412#SecurityGroupQuota1~~).
|
|
1873
|
+
* - To create a security group of the VPC type, you must specify the VpcId parameter.
|
|
1872
1874
|
*
|
|
1873
1875
|
* @param request - CreateSecurityGroupRequest
|
|
1874
1876
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1879,10 +1881,10 @@ export default class Client extends OpenApi {
|
|
|
1879
1881
|
* Creates a security group.
|
|
1880
1882
|
*
|
|
1881
1883
|
* @remarks
|
|
1882
|
-
* -
|
|
1883
|
-
* -
|
|
1884
|
-
* -
|
|
1885
|
-
* -
|
|
1884
|
+
* - The default internal connectivity policy for a basic security group created by this operation is **intra-group connectivity**. You can modify this policy by calling [ModifySecurityGroupPolicy](https://help.aliyun.com/document_detail/2679846.html).
|
|
1885
|
+
* - The default internal connectivity policy for an advanced security group created by this operation is **internal isolation**, and this policy cannot be modified.
|
|
1886
|
+
* - The number of security groups in a single region is limited. You can create a minimum of 100 security groups. For more information, see [Security group limits](~~25412#SecurityGroupQuota1~~).
|
|
1887
|
+
* - To create a security group of the VPC type, you must specify the VpcId parameter.
|
|
1886
1888
|
*
|
|
1887
1889
|
* @param request - CreateSecurityGroupRequest
|
|
1888
1890
|
* @returns CreateSecurityGroupResponse
|
|
@@ -2358,7 +2360,7 @@ export default class Client extends OpenApi {
|
|
|
2358
2360
|
*/
|
|
2359
2361
|
deleteHaVip(request: $_model.DeleteHaVipRequest): Promise<$_model.DeleteHaVipResponse>;
|
|
2360
2362
|
/**
|
|
2361
|
-
*
|
|
2363
|
+
* Calls DeleteHpcCluster to delete an HPC cluster.
|
|
2362
2364
|
*
|
|
2363
2365
|
* @param request - DeleteHpcClusterRequest
|
|
2364
2366
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2366,7 +2368,7 @@ export default class Client extends OpenApi {
|
|
|
2366
2368
|
*/
|
|
2367
2369
|
deleteHpcClusterWithOptions(request: $_model.DeleteHpcClusterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteHpcClusterResponse>;
|
|
2368
2370
|
/**
|
|
2369
|
-
*
|
|
2371
|
+
* Calls DeleteHpcCluster to delete an HPC cluster.
|
|
2370
2372
|
*
|
|
2371
2373
|
* @param request - DeleteHpcClusterRequest
|
|
2372
2374
|
* @returns DeleteHpcClusterResponse
|
|
@@ -2420,7 +2422,7 @@ export default class Client extends OpenApi {
|
|
|
2420
2422
|
* Deletes an image template.
|
|
2421
2423
|
*
|
|
2422
2424
|
* @remarks
|
|
2423
|
-
* If a build task is running, you cannot directly delete the template. Wait until the build task reaches a desired state: SUCCESS, FAILED, TEST_FAILED, PARTITION_SUCCESS, or CANCELLED. You can call [DescribeImagePipelineExecutions](https://help.aliyun.com/document_detail/25609.html) to query the details of build tasks.
|
|
2425
|
+
* If a build task is currently running, you cannot directly delete the template. Wait until the build task reaches a desired state: SUCCESS, FAILED, TEST_FAILED, PARTITION_SUCCESS, or CANCELLED. You can call [DescribeImagePipelineExecutions](https://help.aliyun.com/document_detail/25609.html) to query the details of build tasks.
|
|
2424
2426
|
*
|
|
2425
2427
|
* @param request - DeleteImagePipelineRequest
|
|
2426
2428
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2431,7 +2433,7 @@ export default class Client extends OpenApi {
|
|
|
2431
2433
|
* Deletes an image template.
|
|
2432
2434
|
*
|
|
2433
2435
|
* @remarks
|
|
2434
|
-
* If a build task is running, you cannot directly delete the template. Wait until the build task reaches a desired state: SUCCESS, FAILED, TEST_FAILED, PARTITION_SUCCESS, or CANCELLED. You can call [DescribeImagePipelineExecutions](https://help.aliyun.com/document_detail/25609.html) to query the details of build tasks.
|
|
2436
|
+
* If a build task is currently running, you cannot directly delete the template. Wait until the build task reaches a desired state: SUCCESS, FAILED, TEST_FAILED, PARTITION_SUCCESS, or CANCELLED. You can call [DescribeImagePipelineExecutions](https://help.aliyun.com/document_detail/25609.html) to query the details of build tasks.
|
|
2435
2437
|
*
|
|
2436
2438
|
* @param request - DeleteImagePipelineRequest
|
|
2437
2439
|
* @returns DeleteImagePipelineResponse
|
|
@@ -2719,10 +2721,10 @@ export default class Client extends OpenApi {
|
|
|
2719
2721
|
*/
|
|
2720
2722
|
deletePortRangeList(request: $_model.DeletePortRangeListRequest): Promise<$_model.DeletePortRangeListResponse>;
|
|
2721
2723
|
/**
|
|
2722
|
-
*
|
|
2724
|
+
* Calls DeletePrefixList to delete a specified prefix list and all entries in the prefix list.
|
|
2723
2725
|
*
|
|
2724
2726
|
* @remarks
|
|
2725
|
-
* If a prefix list is associated with other resources, you cannot directly delete it. Dissociate the prefix list from the resources first, and then delete it. You can call [DescribePrefixListAssociations](https://help.aliyun.com/document_detail/204724.html) to query the resources
|
|
2727
|
+
* If a prefix list is associated with other resources, you cannot directly delete it. Dissociate the prefix list from the other resources first, and then delete it. You can call [DescribePrefixListAssociations](https://help.aliyun.com/document_detail/204724.html) to query the resources associated with a specified prefix list.
|
|
2726
2728
|
*
|
|
2727
2729
|
* @param request - DeletePrefixListRequest
|
|
2728
2730
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2730,10 +2732,10 @@ export default class Client extends OpenApi {
|
|
|
2730
2732
|
*/
|
|
2731
2733
|
deletePrefixListWithOptions(request: $_model.DeletePrefixListRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeletePrefixListResponse>;
|
|
2732
2734
|
/**
|
|
2733
|
-
*
|
|
2735
|
+
* Calls DeletePrefixList to delete a specified prefix list and all entries in the prefix list.
|
|
2734
2736
|
*
|
|
2735
2737
|
* @remarks
|
|
2736
|
-
* If a prefix list is associated with other resources, you cannot directly delete it. Dissociate the prefix list from the resources first, and then delete it. You can call [DescribePrefixListAssociations](https://help.aliyun.com/document_detail/204724.html) to query the resources
|
|
2738
|
+
* If a prefix list is associated with other resources, you cannot directly delete it. Dissociate the prefix list from the other resources first, and then delete it. You can call [DescribePrefixListAssociations](https://help.aliyun.com/document_detail/204724.html) to query the resources associated with a specified prefix list.
|
|
2737
2739
|
*
|
|
2738
2740
|
* @param request - DeletePrefixListRequest
|
|
2739
2741
|
* @returns DeletePrefixListResponse
|
|
@@ -3051,7 +3053,7 @@ export default class Client extends OpenApi {
|
|
|
3051
3053
|
*/
|
|
3052
3054
|
describeAutoProvisioningGroupHistory(request: $_model.DescribeAutoProvisioningGroupHistoryRequest): Promise<$_model.DescribeAutoProvisioningGroupHistoryResponse>;
|
|
3053
3055
|
/**
|
|
3054
|
-
* Queries information about
|
|
3056
|
+
* Queries information about instances in an auto provisioning group.
|
|
3055
3057
|
*
|
|
3056
3058
|
* @param request - DescribeAutoProvisioningGroupInstancesRequest
|
|
3057
3059
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3059,7 +3061,7 @@ export default class Client extends OpenApi {
|
|
|
3059
3061
|
*/
|
|
3060
3062
|
describeAutoProvisioningGroupInstancesWithOptions(request: $_model.DescribeAutoProvisioningGroupInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAutoProvisioningGroupInstancesResponse>;
|
|
3061
3063
|
/**
|
|
3062
|
-
* Queries information about
|
|
3064
|
+
* Queries information about instances in an auto provisioning group.
|
|
3063
3065
|
*
|
|
3064
3066
|
* @param request - DescribeAutoProvisioningGroupInstancesRequest
|
|
3065
3067
|
* @returns DescribeAutoProvisioningGroupInstancesResponse
|
|
@@ -3096,7 +3098,7 @@ export default class Client extends OpenApi {
|
|
|
3096
3098
|
*/
|
|
3097
3099
|
describeAutoSnapshotPolicyAssociations(request: $_model.DescribeAutoSnapshotPolicyAssociationsRequest): Promise<$_model.DescribeAutoSnapshotPolicyAssociationsResponse>;
|
|
3098
3100
|
/**
|
|
3099
|
-
* Queries the details of automatic snapshot policies that are created in a
|
|
3101
|
+
* Queries the details of automatic snapshot policies that are created in a specified region.
|
|
3100
3102
|
*
|
|
3101
3103
|
* @param request - DescribeAutoSnapshotPolicyExRequest
|
|
3102
3104
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3104,50 +3106,44 @@ export default class Client extends OpenApi {
|
|
|
3104
3106
|
*/
|
|
3105
3107
|
describeAutoSnapshotPolicyExWithOptions(request: $_model.DescribeAutoSnapshotPolicyExRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAutoSnapshotPolicyExResponse>;
|
|
3106
3108
|
/**
|
|
3107
|
-
* Queries the details of automatic snapshot policies that are created in a
|
|
3109
|
+
* Queries the details of automatic snapshot policies that are created in a specified region.
|
|
3108
3110
|
*
|
|
3109
3111
|
* @param request - DescribeAutoSnapshotPolicyExRequest
|
|
3110
3112
|
* @returns DescribeAutoSnapshotPolicyExResponse
|
|
3111
3113
|
*/
|
|
3112
3114
|
describeAutoSnapshotPolicyEx(request: $_model.DescribeAutoSnapshotPolicyExRequest): Promise<$_model.DescribeAutoSnapshotPolicyExResponse>;
|
|
3113
3115
|
/**
|
|
3114
|
-
*
|
|
3116
|
+
* Queries the inventory status of resources in a specified zone. This operation is primarily used to check whether target resources, such as instance types and system disk types, are available in a specific zone before you create instances (RunInstances) or modify instance specifications (ModifyInstanceSpec).
|
|
3115
3117
|
*
|
|
3116
3118
|
* @remarks
|
|
3117
|
-
* The
|
|
3118
|
-
* - Value
|
|
3119
|
+
* The DestinationResource parameter has different logic and requirements depending on its value. In the following ordered list, a lower-ranked value requires more parameters to be set. You cannot use a lower-ranked value to filter resources of a higher-ranked category.
|
|
3120
|
+
* - Value order: `Zone > IoOptimized > InstanceType = Network = ddh > SystemDisk > DataDisk`
|
|
3119
3121
|
* - Examples:
|
|
3120
|
-
*
|
|
3121
|
-
*
|
|
3122
|
-
*
|
|
3123
|
-
*
|
|
3124
|
-
*
|
|
3125
|
-
*
|
|
3126
|
-
*
|
|
3122
|
+
* - If DestinationResource is set to `DataDisk`:
|
|
3123
|
+
* - If `ResourceType` is set to `disk`, the operation queries data disk types that are not associated with a specific ECS instance type. In this case, the InstanceType parameter is optional.
|
|
3124
|
+
* - If `ResourceType` is set to `instance`, the operation queries data disk types that can be attached to an ECS instance. Because instance types impose restrictions on data disks, you must specify both `InstanceType` and `DataDiskCategory`.
|
|
3125
|
+
* - If DestinationResource is set to `SystemDisk` and `ResourceType` is set to `instance`, you must specify the InstanceType parameter because ECS instance types impose restrictions on system disks.
|
|
3126
|
+
* - If DestinationResource is set to `InstanceType`, specify the IoOptimized and InstanceType parameters.
|
|
3127
|
+
* - Query the inventory of ecs.g5.large across all zones in a specified region: `RegionId=ap-southeast-1 &DestinationResource=InstanceType &IoOptimized=optimized &InstanceType=ecs.g5.large`.
|
|
3128
|
+
* - Query the zones in a specified region where ecs.g5.large is available: `RegionId=ap-southeast-1 &DestinationResource=Zone &IoOptimized=optimized &InstanceType=ecs.g5.large`.
|
|
3127
3129
|
* <details>
|
|
3128
|
-
* <summary>
|
|
3129
|
-
* Query for availability zones in the China (Hangzhou) region that have the `ecs.g5.large` instance type.
|
|
3130
|
-
* </summary>
|
|
3130
|
+
* <summary>Query the zones in the China (Hangzhou) region where the ecs.g5.large instance type is available.</summary>
|
|
3131
3131
|
* ```
|
|
3132
3132
|
* "RegionId": "cn-hangzhou",
|
|
3133
|
-
* "DestinationResource": "Zone"
|
|
3133
|
+
* "DestinationResource": "Zone",
|
|
3134
3134
|
* "InstanceType": "ecs.g5.large"
|
|
3135
3135
|
* ```
|
|
3136
3136
|
* </details>
|
|
3137
3137
|
* <details>
|
|
3138
|
-
* <summary>
|
|
3139
|
-
* Query the inventory of the `ecs.g5.large` instance type across all availability zones in the China (Hangzhou) region.
|
|
3140
|
-
* </summary>
|
|
3138
|
+
* <summary>Query the inventory of the ecs.g5.large instance type across all zones in the China (Hangzhou) region.</summary>
|
|
3141
3139
|
* ```
|
|
3142
3140
|
* "RegionId": "cn-hangzhou",
|
|
3143
|
-
* "DestinationResource": "InstanceType"
|
|
3141
|
+
* "DestinationResource": "InstanceType",
|
|
3144
3142
|
* "InstanceType": "ecs.g5.large"
|
|
3145
3143
|
* ```
|
|
3146
3144
|
* </details>
|
|
3147
3145
|
* <details>
|
|
3148
|
-
* <summary>
|
|
3149
|
-
* Query the inventory of `cloud_efficiency` data disks in availability zone b of the China (Hangzhou) region, independent of any ECS instance type.
|
|
3150
|
-
* </summary>
|
|
3146
|
+
* <summary>[Purchase only a data disk] Query the inventory of the cloud_efficiency data disk type in Zone B of the China (Hangzhou) region.</summary>
|
|
3151
3147
|
* ```
|
|
3152
3148
|
* "RegionId": "cn-hangzhou",
|
|
3153
3149
|
* "ZoneId": "cn-hangzhou-b",
|
|
@@ -3156,9 +3152,7 @@ export default class Client extends OpenApi {
|
|
|
3156
3152
|
* ```
|
|
3157
3153
|
* </details>
|
|
3158
3154
|
* <details>
|
|
3159
|
-
* <summary>
|
|
3160
|
-
* Query the inventory of `cloud_essd` system disks for the `ecs.g7.large` instance type in availability zone b of the China (Hangzhou) region.
|
|
3161
|
-
* </summary>
|
|
3155
|
+
* <summary>[Purchase an ECS instance and a system disk] Query the inventory of the ecs.g7.large instance type with the cloud_essd system disk type in Zone B of the China (Hangzhou) region.</summary>
|
|
3162
3156
|
* ```
|
|
3163
3157
|
* "RegionId": "cn-hangzhou",
|
|
3164
3158
|
* "ZoneId": "cn-hangzhou-b",
|
|
@@ -3175,43 +3169,37 @@ export default class Client extends OpenApi {
|
|
|
3175
3169
|
*/
|
|
3176
3170
|
describeAvailableResourceWithOptions(request: $_model.DescribeAvailableResourceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAvailableResourceResponse>;
|
|
3177
3171
|
/**
|
|
3178
|
-
*
|
|
3172
|
+
* Queries the inventory status of resources in a specified zone. This operation is primarily used to check whether target resources, such as instance types and system disk types, are available in a specific zone before you create instances (RunInstances) or modify instance specifications (ModifyInstanceSpec).
|
|
3179
3173
|
*
|
|
3180
3174
|
* @remarks
|
|
3181
|
-
* The
|
|
3182
|
-
* - Value
|
|
3175
|
+
* The DestinationResource parameter has different logic and requirements depending on its value. In the following ordered list, a lower-ranked value requires more parameters to be set. You cannot use a lower-ranked value to filter resources of a higher-ranked category.
|
|
3176
|
+
* - Value order: `Zone > IoOptimized > InstanceType = Network = ddh > SystemDisk > DataDisk`
|
|
3183
3177
|
* - Examples:
|
|
3184
|
-
*
|
|
3185
|
-
*
|
|
3186
|
-
*
|
|
3187
|
-
*
|
|
3188
|
-
*
|
|
3189
|
-
*
|
|
3190
|
-
*
|
|
3178
|
+
* - If DestinationResource is set to `DataDisk`:
|
|
3179
|
+
* - If `ResourceType` is set to `disk`, the operation queries data disk types that are not associated with a specific ECS instance type. In this case, the InstanceType parameter is optional.
|
|
3180
|
+
* - If `ResourceType` is set to `instance`, the operation queries data disk types that can be attached to an ECS instance. Because instance types impose restrictions on data disks, you must specify both `InstanceType` and `DataDiskCategory`.
|
|
3181
|
+
* - If DestinationResource is set to `SystemDisk` and `ResourceType` is set to `instance`, you must specify the InstanceType parameter because ECS instance types impose restrictions on system disks.
|
|
3182
|
+
* - If DestinationResource is set to `InstanceType`, specify the IoOptimized and InstanceType parameters.
|
|
3183
|
+
* - Query the inventory of ecs.g5.large across all zones in a specified region: `RegionId=ap-southeast-1 &DestinationResource=InstanceType &IoOptimized=optimized &InstanceType=ecs.g5.large`.
|
|
3184
|
+
* - Query the zones in a specified region where ecs.g5.large is available: `RegionId=ap-southeast-1 &DestinationResource=Zone &IoOptimized=optimized &InstanceType=ecs.g5.large`.
|
|
3191
3185
|
* <details>
|
|
3192
|
-
* <summary>
|
|
3193
|
-
* Query for availability zones in the China (Hangzhou) region that have the `ecs.g5.large` instance type.
|
|
3194
|
-
* </summary>
|
|
3186
|
+
* <summary>Query the zones in the China (Hangzhou) region where the ecs.g5.large instance type is available.</summary>
|
|
3195
3187
|
* ```
|
|
3196
3188
|
* "RegionId": "cn-hangzhou",
|
|
3197
|
-
* "DestinationResource": "Zone"
|
|
3189
|
+
* "DestinationResource": "Zone",
|
|
3198
3190
|
* "InstanceType": "ecs.g5.large"
|
|
3199
3191
|
* ```
|
|
3200
3192
|
* </details>
|
|
3201
3193
|
* <details>
|
|
3202
|
-
* <summary>
|
|
3203
|
-
* Query the inventory of the `ecs.g5.large` instance type across all availability zones in the China (Hangzhou) region.
|
|
3204
|
-
* </summary>
|
|
3194
|
+
* <summary>Query the inventory of the ecs.g5.large instance type across all zones in the China (Hangzhou) region.</summary>
|
|
3205
3195
|
* ```
|
|
3206
3196
|
* "RegionId": "cn-hangzhou",
|
|
3207
|
-
* "DestinationResource": "InstanceType"
|
|
3197
|
+
* "DestinationResource": "InstanceType",
|
|
3208
3198
|
* "InstanceType": "ecs.g5.large"
|
|
3209
3199
|
* ```
|
|
3210
3200
|
* </details>
|
|
3211
3201
|
* <details>
|
|
3212
|
-
* <summary>
|
|
3213
|
-
* Query the inventory of `cloud_efficiency` data disks in availability zone b of the China (Hangzhou) region, independent of any ECS instance type.
|
|
3214
|
-
* </summary>
|
|
3202
|
+
* <summary>[Purchase only a data disk] Query the inventory of the cloud_efficiency data disk type in Zone B of the China (Hangzhou) region.</summary>
|
|
3215
3203
|
* ```
|
|
3216
3204
|
* "RegionId": "cn-hangzhou",
|
|
3217
3205
|
* "ZoneId": "cn-hangzhou-b",
|
|
@@ -3220,9 +3208,7 @@ export default class Client extends OpenApi {
|
|
|
3220
3208
|
* ```
|
|
3221
3209
|
* </details>
|
|
3222
3210
|
* <details>
|
|
3223
|
-
* <summary>
|
|
3224
|
-
* Query the inventory of `cloud_essd` system disks for the `ecs.g7.large` instance type in availability zone b of the China (Hangzhou) region.
|
|
3225
|
-
* </summary>
|
|
3211
|
+
* <summary>[Purchase an ECS instance and a system disk] Query the inventory of the ecs.g7.large instance type with the cloud_essd system disk type in Zone B of the China (Hangzhou) region.</summary>
|
|
3226
3212
|
* ```
|
|
3227
3213
|
* "RegionId": "cn-hangzhou",
|
|
3228
3214
|
* "ZoneId": "cn-hangzhou-b",
|
|
@@ -3664,14 +3650,14 @@ export default class Client extends OpenApi {
|
|
|
3664
3650
|
*/
|
|
3665
3651
|
describeDiskMonitorData(request: $_model.DescribeDiskMonitorDataRequest): Promise<$_model.DescribeDiskMonitorDataResponse>;
|
|
3666
3652
|
/**
|
|
3667
|
-
* Queries information about one or more created block storage devices, including disks, local disks, and elastic ephemeral disks.
|
|
3653
|
+
* Queries information about one or more created block storage devices, including cloud disks, local disks, and elastic ephemeral disks.
|
|
3668
3654
|
*
|
|
3669
3655
|
* @remarks
|
|
3670
|
-
* - The request parameters RegionId, ZoneId, DiskIds, and InstanceId are filters.
|
|
3671
|
-
* - The DiskIds request parameter is a JSON format array. If
|
|
3672
|
-
* - Token-based paged query is supported. Set NextToken to the NextToken value returned in the previous call of DescribeDisks
|
|
3673
|
-
* - A disk with the multi-attach feature enabled can be attached to multiple instances. You can
|
|
3674
|
-
* When you
|
|
3656
|
+
* - The request parameters RegionId, ZoneId, DiskIds, and InstanceId are filters. These parameters have a logical AND relationship.
|
|
3657
|
+
* - The DiskIds request parameter is a JSON format array. If this parameter is empty, the filter does not take effect. However, if DiskIds is an empty array, the filter is considered valid and an empty result is returned.
|
|
3658
|
+
* - Token-based paged query is supported. Set the NextToken parameter to specify the query token. Its value is the NextToken value returned in the previous call of DescribeDisks. Use MaxResults to settings the maximum number of entries per page.
|
|
3659
|
+
* - A cloud disk with the multi-attach feature enabled can be attached to multiple instances. You can view all attachment information for the disk from the Attachment list in the response.
|
|
3660
|
+
* When you invoke an API operation by using Cloud Assistant CLI, specify request parameters of different data types in the required formats. For more information, see [Parameter format overview](https://help.aliyun.com/document_detail/110340.html).
|
|
3675
3661
|
*
|
|
3676
3662
|
* @param request - DescribeDisksRequest
|
|
3677
3663
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3679,14 +3665,14 @@ export default class Client extends OpenApi {
|
|
|
3679
3665
|
*/
|
|
3680
3666
|
describeDisksWithOptions(request: $_model.DescribeDisksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDisksResponse>;
|
|
3681
3667
|
/**
|
|
3682
|
-
* Queries information about one or more created block storage devices, including disks, local disks, and elastic ephemeral disks.
|
|
3668
|
+
* Queries information about one or more created block storage devices, including cloud disks, local disks, and elastic ephemeral disks.
|
|
3683
3669
|
*
|
|
3684
3670
|
* @remarks
|
|
3685
|
-
* - The request parameters RegionId, ZoneId, DiskIds, and InstanceId are filters.
|
|
3686
|
-
* - The DiskIds request parameter is a JSON format array. If
|
|
3687
|
-
* - Token-based paged query is supported. Set NextToken to the NextToken value returned in the previous call of DescribeDisks
|
|
3688
|
-
* - A disk with the multi-attach feature enabled can be attached to multiple instances. You can
|
|
3689
|
-
* When you
|
|
3671
|
+
* - The request parameters RegionId, ZoneId, DiskIds, and InstanceId are filters. These parameters have a logical AND relationship.
|
|
3672
|
+
* - The DiskIds request parameter is a JSON format array. If this parameter is empty, the filter does not take effect. However, if DiskIds is an empty array, the filter is considered valid and an empty result is returned.
|
|
3673
|
+
* - Token-based paged query is supported. Set the NextToken parameter to specify the query token. Its value is the NextToken value returned in the previous call of DescribeDisks. Use MaxResults to settings the maximum number of entries per page.
|
|
3674
|
+
* - A cloud disk with the multi-attach feature enabled can be attached to multiple instances. You can view all attachment information for the disk from the Attachment list in the response.
|
|
3675
|
+
* When you invoke an API operation by using Cloud Assistant CLI, specify request parameters of different data types in the required formats. For more information, see [Parameter format overview](https://help.aliyun.com/document_detail/110340.html).
|
|
3690
3676
|
*
|
|
3691
3677
|
* @param request - DescribeDisksRequest
|
|
3692
3678
|
* @returns DescribeDisksResponse
|
|
@@ -3888,7 +3874,7 @@ export default class Client extends OpenApi {
|
|
|
3888
3874
|
* Queries the details of one or more image components.
|
|
3889
3875
|
*
|
|
3890
3876
|
* @remarks
|
|
3891
|
-
* You can set
|
|
3877
|
+
* You can set NextToken to the value of NextToken returned by the previous call to DescribeImageComponents, and set MaxResults to specify the maximum number of entries per page.
|
|
3892
3878
|
*
|
|
3893
3879
|
* @param request - DescribeImageComponentsRequest
|
|
3894
3880
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3899,7 +3885,7 @@ export default class Client extends OpenApi {
|
|
|
3899
3885
|
* Queries the details of one or more image components.
|
|
3900
3886
|
*
|
|
3901
3887
|
* @remarks
|
|
3902
|
-
* You can set
|
|
3888
|
+
* You can set NextToken to the value of NextToken returned by the previous call to DescribeImageComponents, and set MaxResults to specify the maximum number of entries per page.
|
|
3903
3889
|
*
|
|
3904
3890
|
* @param request - DescribeImageComponentsRequest
|
|
3905
3891
|
* @returns DescribeImageComponentsResponse
|
|
@@ -4007,13 +3993,13 @@ export default class Client extends OpenApi {
|
|
|
4007
3993
|
*/
|
|
4008
3994
|
describeImageSupportInstanceTypes(request: $_model.DescribeImageSupportInstanceTypesRequest): Promise<$_model.DescribeImageSupportInstanceTypesResponse>;
|
|
4009
3995
|
/**
|
|
4010
|
-
*
|
|
3996
|
+
* Queries the list of available image resources based on specified parameters such as ImageId, image usage scenarios, and filter conditions.
|
|
4011
3997
|
*
|
|
4012
3998
|
* @remarks
|
|
4013
|
-
* -
|
|
4014
|
-
* -
|
|
4015
|
-
* - When
|
|
4016
|
-
* - When
|
|
3999
|
+
* - Image resources that you can query include your custom images, public images provided by Alibaba Cloud, Alibaba Cloud Marketplace images, and shared images that other Alibaba Cloud users have shared with you.
|
|
4000
|
+
* - Paging is supported. The query results include the total number of available image resources and the image resources on the current page. The default number of entries per page is 10.
|
|
4001
|
+
* - When you invoke an API operation by using Cloud Assistant CLI, request parameters of different data types must comply with format requirements. For more information, see [CLI parameter format](https://help.aliyun.com/document_detail/110340.html).
|
|
4002
|
+
* - When you query images provided by Alibaba Cloud or shared images (ImageOwnerAlias is set to system or others), the request can bypass RAM authentication rules. For more information, see [Authentication rules](https://help.aliyun.com/document_detail/25497.html).
|
|
4017
4003
|
*
|
|
4018
4004
|
* @param request - DescribeImagesRequest
|
|
4019
4005
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4021,13 +4007,13 @@ export default class Client extends OpenApi {
|
|
|
4021
4007
|
*/
|
|
4022
4008
|
describeImagesWithOptions(request: $_model.DescribeImagesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeImagesResponse>;
|
|
4023
4009
|
/**
|
|
4024
|
-
*
|
|
4010
|
+
* Queries the list of available image resources based on specified parameters such as ImageId, image usage scenarios, and filter conditions.
|
|
4025
4011
|
*
|
|
4026
4012
|
* @remarks
|
|
4027
|
-
* -
|
|
4028
|
-
* -
|
|
4029
|
-
* - When
|
|
4030
|
-
* - When
|
|
4013
|
+
* - Image resources that you can query include your custom images, public images provided by Alibaba Cloud, Alibaba Cloud Marketplace images, and shared images that other Alibaba Cloud users have shared with you.
|
|
4014
|
+
* - Paging is supported. The query results include the total number of available image resources and the image resources on the current page. The default number of entries per page is 10.
|
|
4015
|
+
* - When you invoke an API operation by using Cloud Assistant CLI, request parameters of different data types must comply with format requirements. For more information, see [CLI parameter format](https://help.aliyun.com/document_detail/110340.html).
|
|
4016
|
+
* - When you query images provided by Alibaba Cloud or shared images (ImageOwnerAlias is set to system or others), the request can bypass RAM authentication rules. For more information, see [Authentication rules](https://help.aliyun.com/document_detail/25497.html).
|
|
4031
4017
|
*
|
|
4032
4018
|
* @param request - DescribeImagesRequest
|
|
4033
4019
|
* @returns DescribeImagesResponse
|
|
@@ -4059,7 +4045,7 @@ export default class Client extends OpenApi {
|
|
|
4059
4045
|
*/
|
|
4060
4046
|
describeInstanceAttachmentAttributes(request: $_model.DescribeInstanceAttachmentAttributesRequest): Promise<$_model.DescribeInstanceAttachmentAttributesResponse>;
|
|
4061
4047
|
/**
|
|
4062
|
-
*
|
|
4048
|
+
* Queries the attribute information of a specified ECS instance.
|
|
4063
4049
|
*
|
|
4064
4050
|
* @param request - DescribeInstanceAttributeRequest
|
|
4065
4051
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4067,7 +4053,7 @@ export default class Client extends OpenApi {
|
|
|
4067
4053
|
*/
|
|
4068
4054
|
describeInstanceAttributeWithOptions(request: $_model.DescribeInstanceAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeInstanceAttributeResponse>;
|
|
4069
4055
|
/**
|
|
4070
|
-
*
|
|
4056
|
+
* Queries the attribute information of a specified ECS instance.
|
|
4071
4057
|
*
|
|
4072
4058
|
* @param request - DescribeInstanceAttributeRequest
|
|
4073
4059
|
* @returns DescribeInstanceAttributeResponse
|
|
@@ -4097,12 +4083,12 @@ export default class Client extends OpenApi {
|
|
|
4097
4083
|
*/
|
|
4098
4084
|
describeInstanceAutoRenewAttribute(request: $_model.DescribeInstanceAutoRenewAttributeRequest): Promise<$_model.DescribeInstanceAutoRenewAttributeResponse>;
|
|
4099
4085
|
/**
|
|
4100
|
-
*
|
|
4086
|
+
* Queries system event information for a specified instance by calling the DescribeInstanceHistoryEvents operation. You can specify parameters such as InstanceId and EventType. By default, this operation queries historical system events in inactive states.
|
|
4101
4087
|
*
|
|
4102
4088
|
* @remarks
|
|
4103
|
-
* - You can query completed historical system events from
|
|
4104
|
-
* -
|
|
4105
|
-
* - By specifying the InstanceEventCycleStatus parameter, you can also query system events in the Scheduled
|
|
4089
|
+
* - You can query completed historical system events from the last 30 days. There is no time limit for querying uncompleted system events.
|
|
4090
|
+
* - If neither EventCycleStatus nor InstanceEventCycleStatus is specified, the query results include only system events in the Avoided, Executed, Canceled, and Failed states by default.
|
|
4091
|
+
* - By specifying the InstanceEventCycleStatus parameter, you can also query system events in the Scheduled, Executing, and Inquiring states.
|
|
4106
4092
|
*
|
|
4107
4093
|
* @param request - DescribeInstanceHistoryEventsRequest
|
|
4108
4094
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4110,12 +4096,12 @@ export default class Client extends OpenApi {
|
|
|
4110
4096
|
*/
|
|
4111
4097
|
describeInstanceHistoryEventsWithOptions(request: $_model.DescribeInstanceHistoryEventsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeInstanceHistoryEventsResponse>;
|
|
4112
4098
|
/**
|
|
4113
|
-
*
|
|
4099
|
+
* Queries system event information for a specified instance by calling the DescribeInstanceHistoryEvents operation. You can specify parameters such as InstanceId and EventType. By default, this operation queries historical system events in inactive states.
|
|
4114
4100
|
*
|
|
4115
4101
|
* @remarks
|
|
4116
|
-
* - You can query completed historical system events from
|
|
4117
|
-
* -
|
|
4118
|
-
* - By specifying the InstanceEventCycleStatus parameter, you can also query system events in the Scheduled
|
|
4102
|
+
* - You can query completed historical system events from the last 30 days. There is no time limit for querying uncompleted system events.
|
|
4103
|
+
* - If neither EventCycleStatus nor InstanceEventCycleStatus is specified, the query results include only system events in the Avoided, Executed, Canceled, and Failed states by default.
|
|
4104
|
+
* - By specifying the InstanceEventCycleStatus parameter, you can also query system events in the Scheduled, Executing, and Inquiring states.
|
|
4119
4105
|
*
|
|
4120
4106
|
* @param request - DescribeInstanceHistoryEventsRequest
|
|
4121
4107
|
* @returns DescribeInstanceHistoryEventsResponse
|
|
@@ -4393,14 +4379,14 @@ export default class Client extends OpenApi {
|
|
|
4393
4379
|
*/
|
|
4394
4380
|
describeInstanceVncUrl(request: $_model.DescribeInstanceVncUrlRequest): Promise<$_model.DescribeInstanceVncUrlResponse>;
|
|
4395
4381
|
/**
|
|
4396
|
-
*
|
|
4382
|
+
* Queries a list of instances based on specified request conditions and returns the associated detailed information of the instances.
|
|
4397
4383
|
*
|
|
4398
4384
|
* @remarks
|
|
4385
|
+
* ### Before you begin
|
|
4386
|
+
* - When you invoke API operations by using Cloud Assistant CLI, make sure that request parameters of different data types are in the required formats. For more information, see [CLI parameter format](https://help.aliyun.com/document_detail/110340.html).
|
|
4399
4387
|
* ### Usage notes
|
|
4400
|
-
* -
|
|
4401
|
-
*
|
|
4402
|
-
* - We recommend that you perform a dry run by setting the DryRun parameter to check parameter validity and authorization status.
|
|
4403
|
-
* - To query the first page of results, set the `MaxResults` parameter to limit the number of entries returned. Use the `NextToken` value in the response to retrieve subsequent pages. For subsequent page queries, set the `NextToken` parameter to the value from the previous response and set `MaxResults` to limit the number of entries returned.
|
|
4388
|
+
* - Send a dry run request by using the DryRun request parameter to check the validity of parameters and authorization.
|
|
4389
|
+
* - When performing a paging query for the first page of results, set only `MaxResults` to limit the number of entries to return. The `NextToken` value in the response is used as the credential for querying subsequent pages. When performing a paging query for subsequent pages, set `NextToken` to the `NextToken` value obtained from the previous response and set `MaxResults` to limit the number of entries to return.
|
|
4404
4390
|
*
|
|
4405
4391
|
* @param request - DescribeInstancesRequest
|
|
4406
4392
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4408,14 +4394,14 @@ export default class Client extends OpenApi {
|
|
|
4408
4394
|
*/
|
|
4409
4395
|
describeInstancesWithOptions(request: $_model.DescribeInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeInstancesResponse>;
|
|
4410
4396
|
/**
|
|
4411
|
-
*
|
|
4397
|
+
* Queries a list of instances based on specified request conditions and returns the associated detailed information of the instances.
|
|
4412
4398
|
*
|
|
4413
4399
|
* @remarks
|
|
4400
|
+
* ### Before you begin
|
|
4401
|
+
* - When you invoke API operations by using Cloud Assistant CLI, make sure that request parameters of different data types are in the required formats. For more information, see [CLI parameter format](https://help.aliyun.com/document_detail/110340.html).
|
|
4414
4402
|
* ### Usage notes
|
|
4415
|
-
* -
|
|
4416
|
-
*
|
|
4417
|
-
* - We recommend that you perform a dry run by setting the DryRun parameter to check parameter validity and authorization status.
|
|
4418
|
-
* - To query the first page of results, set the `MaxResults` parameter to limit the number of entries returned. Use the `NextToken` value in the response to retrieve subsequent pages. For subsequent page queries, set the `NextToken` parameter to the value from the previous response and set `MaxResults` to limit the number of entries returned.
|
|
4403
|
+
* - Send a dry run request by using the DryRun request parameter to check the validity of parameters and authorization.
|
|
4404
|
+
* - When performing a paging query for the first page of results, set only `MaxResults` to limit the number of entries to return. The `NextToken` value in the response is used as the credential for querying subsequent pages. When performing a paging query for subsequent pages, set `NextToken` to the `NextToken` value obtained from the previous response and set `MaxResults` to limit the number of entries to return.
|
|
4419
4405
|
*
|
|
4420
4406
|
* @param request - DescribeInstancesRequest
|
|
4421
4407
|
* @returns DescribeInstancesResponse
|
|
@@ -4447,22 +4433,22 @@ export default class Client extends OpenApi {
|
|
|
4447
4433
|
*/
|
|
4448
4434
|
describeInstancesFullStatus(request: $_model.DescribeInstancesFullStatusRequest): Promise<$_model.DescribeInstancesFullStatusResponse>;
|
|
4449
4435
|
/**
|
|
4450
|
-
*
|
|
4436
|
+
* Queries the execution results of one or more Cloud Assistant commands, which are the actual execution results on ECS instances.
|
|
4451
4437
|
*
|
|
4452
4438
|
* @remarks
|
|
4453
|
-
* ##
|
|
4454
|
-
* - After you
|
|
4455
|
-
* - You can query execution information from the last
|
|
4456
|
-
* - You can
|
|
4457
|
-
* - When
|
|
4439
|
+
* ## Operation description
|
|
4440
|
+
* - After you run a command, the command is not guaranteed to succeed or produce the expected results. Call this operation to view the actual execution results based on the actual output.
|
|
4441
|
+
* - You can query execution information from the last 30 days. A maximum of 10,000 entries of execution information can be retained.
|
|
4442
|
+
* - You can use [Cloud Assistant task status event subscription](https://help.aliyun.com/document_detail/2669130.html) to obtain task results through events, which avoids frequent polling and improves efficiency.
|
|
4443
|
+
* - When paged query the first page, set only MaxResults to limit the number of entries to return. The NextToken value in the response serves as the token for querying subsequent pages. When paged query subsequent pages, set NextToken to the NextToken value obtained from the previous response and set MaxResults to limit the number of entries to return.
|
|
4458
4444
|
* - Differences between `DescribeInvocations` and `DescribeInvocationResults`:
|
|
4459
|
-
*
|
|
4460
|
-
*
|
|
4461
|
-
*
|
|
4462
|
-
*
|
|
4463
|
-
*
|
|
4464
|
-
*
|
|
4465
|
-
*
|
|
4445
|
+
* - When a single `RunCommand`/`InvokeCommand` call specifies multiple instances:
|
|
4446
|
+
* - `DescribeInvocations` returns the execution status on each instance and the aggregated status across all instances.
|
|
4447
|
+
* - `DescribeInvocationResults` returns only the individual execution status on each instance, without the aggregated status across instances.
|
|
4448
|
+
* - When a single `RunCommand`/`InvokeCommand` call specifies one instance:
|
|
4449
|
+
* - `DescribeInvocations` and `DescribeInvocationResults` are largely interchangeable.
|
|
4450
|
+
* - When you want to view the execution history of scheduled (periodic) tasks or tasks that run at each system startup (`RepeatMode=Period, EveryReboot`), only `DescribeInvocationResults` can return historical execution records (you must specify `IncludeHistory=true`). `DescribeInvocations` returns only the latest task status.
|
|
4451
|
+
* - When you want to view the command content and parameters, only `DescribeInvocations` returns `CommandContent`.
|
|
4466
4452
|
*
|
|
4467
4453
|
* @param request - DescribeInvocationResultsRequest
|
|
4468
4454
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4470,43 +4456,43 @@ export default class Client extends OpenApi {
|
|
|
4470
4456
|
*/
|
|
4471
4457
|
describeInvocationResultsWithOptions(request: $_model.DescribeInvocationResultsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeInvocationResultsResponse>;
|
|
4472
4458
|
/**
|
|
4473
|
-
*
|
|
4459
|
+
* Queries the execution results of one or more Cloud Assistant commands, which are the actual execution results on ECS instances.
|
|
4474
4460
|
*
|
|
4475
4461
|
* @remarks
|
|
4476
|
-
* ##
|
|
4477
|
-
* - After you
|
|
4478
|
-
* - You can query execution information from the last
|
|
4479
|
-
* - You can
|
|
4480
|
-
* - When
|
|
4462
|
+
* ## Operation description
|
|
4463
|
+
* - After you run a command, the command is not guaranteed to succeed or produce the expected results. Call this operation to view the actual execution results based on the actual output.
|
|
4464
|
+
* - You can query execution information from the last 30 days. A maximum of 10,000 entries of execution information can be retained.
|
|
4465
|
+
* - You can use [Cloud Assistant task status event subscription](https://help.aliyun.com/document_detail/2669130.html) to obtain task results through events, which avoids frequent polling and improves efficiency.
|
|
4466
|
+
* - When paged query the first page, set only MaxResults to limit the number of entries to return. The NextToken value in the response serves as the token for querying subsequent pages. When paged query subsequent pages, set NextToken to the NextToken value obtained from the previous response and set MaxResults to limit the number of entries to return.
|
|
4481
4467
|
* - Differences between `DescribeInvocations` and `DescribeInvocationResults`:
|
|
4482
|
-
*
|
|
4483
|
-
*
|
|
4484
|
-
*
|
|
4485
|
-
*
|
|
4486
|
-
*
|
|
4487
|
-
*
|
|
4488
|
-
*
|
|
4468
|
+
* - When a single `RunCommand`/`InvokeCommand` call specifies multiple instances:
|
|
4469
|
+
* - `DescribeInvocations` returns the execution status on each instance and the aggregated status across all instances.
|
|
4470
|
+
* - `DescribeInvocationResults` returns only the individual execution status on each instance, without the aggregated status across instances.
|
|
4471
|
+
* - When a single `RunCommand`/`InvokeCommand` call specifies one instance:
|
|
4472
|
+
* - `DescribeInvocations` and `DescribeInvocationResults` are largely interchangeable.
|
|
4473
|
+
* - When you want to view the execution history of scheduled (periodic) tasks or tasks that run at each system startup (`RepeatMode=Period, EveryReboot`), only `DescribeInvocationResults` can return historical execution records (you must specify `IncludeHistory=true`). `DescribeInvocations` returns only the latest task status.
|
|
4474
|
+
* - When you want to view the command content and parameters, only `DescribeInvocations` returns `CommandContent`.
|
|
4489
4475
|
*
|
|
4490
4476
|
* @param request - DescribeInvocationResultsRequest
|
|
4491
4477
|
* @returns DescribeInvocationResultsResponse
|
|
4492
4478
|
*/
|
|
4493
4479
|
describeInvocationResults(request: $_model.DescribeInvocationResultsRequest): Promise<$_model.DescribeInvocationResultsResponse>;
|
|
4494
4480
|
/**
|
|
4495
|
-
*
|
|
4481
|
+
* Queries the execution list and status of Cloud Assistant commands.
|
|
4496
4482
|
*
|
|
4497
4483
|
* @remarks
|
|
4498
|
-
* - After you
|
|
4499
|
-
* - You can query execution information from the
|
|
4500
|
-
* - You can subscribe to [Cloud Assistant task status
|
|
4501
|
-
* - When
|
|
4484
|
+
* - After you run a command, the command does not necessarily run successfully or produce the expected results. You must check the actual execution results based on the return values of this operation. The actual output takes precedence.
|
|
4485
|
+
* - You can query execution information from the last 30 days. A maximum of 10,000 execution records are retained.
|
|
4486
|
+
* - You can subscribe to [Cloud Assistant task status events](https://help.aliyun.com/document_detail/2669130.html) to obtain task results through events, which avoids frequent polling and improves efficiency.
|
|
4487
|
+
* - When paged query the first page, set only MaxResults to limit the number of entries to return. The NextToken value in the response serves as the token for querying subsequent pages. When paged query subsequent pages, set NextToken to the NextToken value obtained from the previous response and set MaxResults to limit the number of entries to return.
|
|
4502
4488
|
* - Differences between `DescribeInvocations` and `DescribeInvocationResults`:
|
|
4503
|
-
*
|
|
4504
|
-
*
|
|
4505
|
-
*
|
|
4506
|
-
*
|
|
4507
|
-
*
|
|
4508
|
-
*
|
|
4509
|
-
*
|
|
4489
|
+
* - When a single `RunCommand`/`InvokeCommand` call specifies multiple instances:
|
|
4490
|
+
* - `DescribeInvocations` returns the execution status on each instance and the aggregated status across all instances.
|
|
4491
|
+
* - `DescribeInvocationResults` returns only the individual execution status on each instance, without the aggregated status.
|
|
4492
|
+
* - When a single `RunCommand`/`InvokeCommand` call specifies one instance:
|
|
4493
|
+
* - `DescribeInvocations` and `DescribeInvocationResults` are largely interchangeable.
|
|
4494
|
+
* - To view the execution details of each run for scheduled (periodic) or boot-triggered tasks (`RepeatMode=Period, EveryReboot`), only `DescribeInvocationResults` can return historical execution records (with `IncludeHistory=true` specified). `DescribeInvocations` returns only the latest task status.
|
|
4495
|
+
* - To view the command content and parameters, only `DescribeInvocations` returns `CommandContent`.
|
|
4510
4496
|
*
|
|
4511
4497
|
* @param request - DescribeInvocationsRequest
|
|
4512
4498
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4514,21 +4500,21 @@ export default class Client extends OpenApi {
|
|
|
4514
4500
|
*/
|
|
4515
4501
|
describeInvocationsWithOptions(request: $_model.DescribeInvocationsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeInvocationsResponse>;
|
|
4516
4502
|
/**
|
|
4517
|
-
*
|
|
4503
|
+
* Queries the execution list and status of Cloud Assistant commands.
|
|
4518
4504
|
*
|
|
4519
4505
|
* @remarks
|
|
4520
|
-
* - After you
|
|
4521
|
-
* - You can query execution information from the
|
|
4522
|
-
* - You can subscribe to [Cloud Assistant task status
|
|
4523
|
-
* - When
|
|
4506
|
+
* - After you run a command, the command does not necessarily run successfully or produce the expected results. You must check the actual execution results based on the return values of this operation. The actual output takes precedence.
|
|
4507
|
+
* - You can query execution information from the last 30 days. A maximum of 10,000 execution records are retained.
|
|
4508
|
+
* - You can subscribe to [Cloud Assistant task status events](https://help.aliyun.com/document_detail/2669130.html) to obtain task results through events, which avoids frequent polling and improves efficiency.
|
|
4509
|
+
* - When paged query the first page, set only MaxResults to limit the number of entries to return. The NextToken value in the response serves as the token for querying subsequent pages. When paged query subsequent pages, set NextToken to the NextToken value obtained from the previous response and set MaxResults to limit the number of entries to return.
|
|
4524
4510
|
* - Differences between `DescribeInvocations` and `DescribeInvocationResults`:
|
|
4525
|
-
*
|
|
4526
|
-
*
|
|
4527
|
-
*
|
|
4528
|
-
*
|
|
4529
|
-
*
|
|
4530
|
-
*
|
|
4531
|
-
*
|
|
4511
|
+
* - When a single `RunCommand`/`InvokeCommand` call specifies multiple instances:
|
|
4512
|
+
* - `DescribeInvocations` returns the execution status on each instance and the aggregated status across all instances.
|
|
4513
|
+
* - `DescribeInvocationResults` returns only the individual execution status on each instance, without the aggregated status.
|
|
4514
|
+
* - When a single `RunCommand`/`InvokeCommand` call specifies one instance:
|
|
4515
|
+
* - `DescribeInvocations` and `DescribeInvocationResults` are largely interchangeable.
|
|
4516
|
+
* - To view the execution details of each run for scheduled (periodic) or boot-triggered tasks (`RepeatMode=Period, EveryReboot`), only `DescribeInvocationResults` can return historical execution records (with `IncludeHistory=true` specified). `DescribeInvocations` returns only the latest task status.
|
|
4517
|
+
* - To view the command content and parameters, only `DescribeInvocations` returns `CommandContent`.
|
|
4532
4518
|
*
|
|
4533
4519
|
* @param request - DescribeInvocationsRequest
|
|
4534
4520
|
* @returns DescribeInvocationsResponse
|
|
@@ -4550,7 +4536,7 @@ export default class Client extends OpenApi {
|
|
|
4550
4536
|
*/
|
|
4551
4537
|
describeKeyPairs(request: $_model.DescribeKeyPairsRequest): Promise<$_model.DescribeKeyPairsResponse>;
|
|
4552
4538
|
/**
|
|
4553
|
-
*
|
|
4539
|
+
* Queries information about launch template versions of ECS instances, such as the total number of launch templates, template names, and template version numbers.
|
|
4554
4540
|
*
|
|
4555
4541
|
* @param request - DescribeLaunchTemplateVersionsRequest
|
|
4556
4542
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4558,7 +4544,7 @@ export default class Client extends OpenApi {
|
|
|
4558
4544
|
*/
|
|
4559
4545
|
describeLaunchTemplateVersionsWithOptions(request: $_model.DescribeLaunchTemplateVersionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeLaunchTemplateVersionsResponse>;
|
|
4560
4546
|
/**
|
|
4561
|
-
*
|
|
4547
|
+
* Queries information about launch template versions of ECS instances, such as the total number of launch templates, template names, and template version numbers.
|
|
4562
4548
|
*
|
|
4563
4549
|
* @param request - DescribeLaunchTemplateVersionsRequest
|
|
4564
4550
|
* @returns DescribeLaunchTemplateVersionsResponse
|
|
@@ -4870,17 +4856,18 @@ export default class Client extends OpenApi {
|
|
|
4870
4856
|
*/
|
|
4871
4857
|
describePrefixLists(request: $_model.DescribePrefixListsRequest): Promise<$_model.DescribePrefixListsResponse>;
|
|
4872
4858
|
/**
|
|
4873
|
-
*
|
|
4859
|
+
* Queries the latest prices of specified resources. You can query the latest prices of ECS instances, disks, dedicated hosts, elasticity assurance services, and capacity reservation services based on resource type. The response includes promotion rules, prices, and discounts.
|
|
4874
4860
|
*
|
|
4875
4861
|
* @remarks
|
|
4876
|
-
*
|
|
4877
|
-
*
|
|
4878
|
-
*
|
|
4879
|
-
*
|
|
4880
|
-
* -
|
|
4881
|
-
*
|
|
4882
|
-
*
|
|
4883
|
-
*
|
|
4862
|
+
* The parameter settings vary based on the resource type:
|
|
4863
|
+
* - When `ResourceType=instance`, you must also specify `InstanceType`.
|
|
4864
|
+
* By default, the price of the pay-as-you-go (`PostPaid`) billing method (`ChargeType`) is queried. You can specify the `PriceUnit` parameter to query Elastic Compute Service (ECS) prices for different billing cycles.
|
|
4865
|
+
* - When `ResourceType=disk`, you must also specify `DataDisk.1.Category` and `DataDisk.1.Size`. When you query the price of `disk` resources, only the pay-as-you-go price of disks is returned. This means that the `PriceUnit` parameter can only be set to `Hour`.
|
|
4866
|
+
* - When `ResourceType=diskperformance`, you must also specify `DataDisk.1.Category` and `DataDisk.1.ProvisionedIops`.
|
|
4867
|
+
* - When `ResourceType=ddh`, you must also specify `DedicatedHostType`.
|
|
4868
|
+
* - When `ResourceType=ElasticityAssurance`, you must also specify `InstanceType`.
|
|
4869
|
+
* - When `ResourceType=CapacityReservation`, you must also specify `InstanceType`.
|
|
4870
|
+
* - When `ResourceType=bandwidth`, only the pay-by-traffic (`PayByTraffic`) price is returned.
|
|
4884
4871
|
*
|
|
4885
4872
|
* @param request - DescribePriceRequest
|
|
4886
4873
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4888,24 +4875,25 @@ export default class Client extends OpenApi {
|
|
|
4888
4875
|
*/
|
|
4889
4876
|
describePriceWithOptions(request: $_model.DescribePriceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePriceResponse>;
|
|
4890
4877
|
/**
|
|
4891
|
-
*
|
|
4878
|
+
* Queries the latest prices of specified resources. You can query the latest prices of ECS instances, disks, dedicated hosts, elasticity assurance services, and capacity reservation services based on resource type. The response includes promotion rules, prices, and discounts.
|
|
4892
4879
|
*
|
|
4893
4880
|
* @remarks
|
|
4894
|
-
*
|
|
4895
|
-
*
|
|
4896
|
-
*
|
|
4897
|
-
*
|
|
4898
|
-
* -
|
|
4899
|
-
*
|
|
4900
|
-
*
|
|
4901
|
-
*
|
|
4881
|
+
* The parameter settings vary based on the resource type:
|
|
4882
|
+
* - When `ResourceType=instance`, you must also specify `InstanceType`.
|
|
4883
|
+
* By default, the price of the pay-as-you-go (`PostPaid`) billing method (`ChargeType`) is queried. You can specify the `PriceUnit` parameter to query Elastic Compute Service (ECS) prices for different billing cycles.
|
|
4884
|
+
* - When `ResourceType=disk`, you must also specify `DataDisk.1.Category` and `DataDisk.1.Size`. When you query the price of `disk` resources, only the pay-as-you-go price of disks is returned. This means that the `PriceUnit` parameter can only be set to `Hour`.
|
|
4885
|
+
* - When `ResourceType=diskperformance`, you must also specify `DataDisk.1.Category` and `DataDisk.1.ProvisionedIops`.
|
|
4886
|
+
* - When `ResourceType=ddh`, you must also specify `DedicatedHostType`.
|
|
4887
|
+
* - When `ResourceType=ElasticityAssurance`, you must also specify `InstanceType`.
|
|
4888
|
+
* - When `ResourceType=CapacityReservation`, you must also specify `InstanceType`.
|
|
4889
|
+
* - When `ResourceType=bandwidth`, only the pay-by-traffic (`PayByTraffic`) price is returned.
|
|
4902
4890
|
*
|
|
4903
4891
|
* @param request - DescribePriceRequest
|
|
4904
4892
|
* @returns DescribePriceResponse
|
|
4905
4893
|
*/
|
|
4906
4894
|
describePrice(request: $_model.DescribePriceRequest): Promise<$_model.DescribePriceResponse>;
|
|
4907
4895
|
/**
|
|
4908
|
-
* Queries alternative instance types
|
|
4896
|
+
* (Beta) Queries one or more alternative instance types based on a specified instance type. For instance types that have been or will be retired, DescribeRecommendInstanceType lists all instance types that can serve as replacements.
|
|
4909
4897
|
*
|
|
4910
4898
|
* @param request - DescribeRecommendInstanceTypeRequest
|
|
4911
4899
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4913,7 +4901,7 @@ export default class Client extends OpenApi {
|
|
|
4913
4901
|
*/
|
|
4914
4902
|
describeRecommendInstanceTypeWithOptions(request: $_model.DescribeRecommendInstanceTypeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeRecommendInstanceTypeResponse>;
|
|
4915
4903
|
/**
|
|
4916
|
-
* Queries alternative instance types
|
|
4904
|
+
* (Beta) Queries one or more alternative instance types based on a specified instance type. For instance types that have been or will be retired, DescribeRecommendInstanceType lists all instance types that can serve as replacements.
|
|
4917
4905
|
*
|
|
4918
4906
|
* @param request - DescribeRecommendInstanceTypeRequest
|
|
4919
4907
|
* @returns DescribeRecommendInstanceTypeResponse
|
|
@@ -5059,42 +5047,42 @@ export default class Client extends OpenApi {
|
|
|
5059
5047
|
*/
|
|
5060
5048
|
describeResourceByTags(request: $_model.DescribeResourceByTagsRequest): Promise<$_model.DescribeResourceByTagsResponse>;
|
|
5061
5049
|
/**
|
|
5062
|
-
* Queries
|
|
5050
|
+
* Queries the inventory of instance types or system disk types in a zone before you change the instance type or system disk type of an instance.
|
|
5063
5051
|
*
|
|
5064
5052
|
* @remarks
|
|
5065
|
-
*
|
|
5066
|
-
* ###
|
|
5067
|
-
* Query the instance types to which
|
|
5053
|
+
* The following examples describe common change scenarios:
|
|
5054
|
+
* ### Example 1: Query instance types to which the current instance can be changed
|
|
5055
|
+
* Query the instance types to which instance i-bp67acfmxazb4p**** can be changed, and the inventory of the corresponding instance types in the zone where the instance resides.
|
|
5068
5056
|
* ```
|
|
5069
5057
|
* http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
|
|
5070
|
-
* &RegionId=
|
|
5058
|
+
* &RegionId=ap-southeast-1
|
|
5071
5059
|
* &ResourceId=i-bp67acfmxazb4p****
|
|
5072
5060
|
* &DestinationResource=InstanceType
|
|
5073
5061
|
* &OperationType=Upgrade
|
|
5074
|
-
*
|
|
5062
|
+
* &Common request parameters
|
|
5075
5063
|
* ```
|
|
5076
|
-
* ###
|
|
5077
|
-
* Query the instance types to which
|
|
5064
|
+
* ### Example 2: Query instance types available after changing the disk type of the current instance
|
|
5065
|
+
* Query the instance types to which instance i-bp67acfmxazb4p**** can be changed after the disk type is changed, and the inventory of the corresponding instance types in the zone where the instance resides.
|
|
5078
5066
|
* ```
|
|
5079
5067
|
* http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
|
|
5080
|
-
* &RegionId=
|
|
5068
|
+
* &RegionId=ap-southeast-1
|
|
5081
5069
|
* &ResourceId=i-bp67acfmxazb4p****
|
|
5082
5070
|
* &DestinationResource=InstanceType
|
|
5083
5071
|
* &OperationType=Upgrade
|
|
5084
5072
|
* &Conditions.0=DiskCategory
|
|
5085
|
-
*
|
|
5073
|
+
* &Common request parameters
|
|
5086
5074
|
* ```
|
|
5087
|
-
* ###
|
|
5088
|
-
* Query the
|
|
5089
|
-
* >
|
|
5075
|
+
* ### Example 3: Query the disk type required by the target instance type
|
|
5076
|
+
* Query the disk type required by the target instance type (for example, ecs.g7.large). The current instance i-bp67acfmxazb4p**** must be changed to this disk type before it can be changed to the target instance type. Also query the inventory of the disk type in the zone where the instance resides.
|
|
5077
|
+
* > The target instance type must be obtained by using Example 2.
|
|
5090
5078
|
* ```
|
|
5091
5079
|
* http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
|
|
5092
|
-
* &RegionId=
|
|
5080
|
+
* &RegionId=ap-southeast-1
|
|
5093
5081
|
* &ResourceId=i-bp67acfmxazb4p****
|
|
5094
5082
|
* &DestinationResource=SystemDisk
|
|
5095
5083
|
* &OperationType=Upgrade
|
|
5096
5084
|
* &InstanceType=ecs.g7.large
|
|
5097
|
-
*
|
|
5085
|
+
* &Common request parameters
|
|
5098
5086
|
* ```
|
|
5099
5087
|
*
|
|
5100
5088
|
* @param request - DescribeResourcesModificationRequest
|
|
@@ -5103,42 +5091,42 @@ export default class Client extends OpenApi {
|
|
|
5103
5091
|
*/
|
|
5104
5092
|
describeResourcesModificationWithOptions(request: $_model.DescribeResourcesModificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeResourcesModificationResponse>;
|
|
5105
5093
|
/**
|
|
5106
|
-
* Queries
|
|
5094
|
+
* Queries the inventory of instance types or system disk types in a zone before you change the instance type or system disk type of an instance.
|
|
5107
5095
|
*
|
|
5108
5096
|
* @remarks
|
|
5109
|
-
*
|
|
5110
|
-
* ###
|
|
5111
|
-
* Query the instance types to which
|
|
5097
|
+
* The following examples describe common change scenarios:
|
|
5098
|
+
* ### Example 1: Query instance types to which the current instance can be changed
|
|
5099
|
+
* Query the instance types to which instance i-bp67acfmxazb4p**** can be changed, and the inventory of the corresponding instance types in the zone where the instance resides.
|
|
5112
5100
|
* ```
|
|
5113
5101
|
* http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
|
|
5114
|
-
* &RegionId=
|
|
5102
|
+
* &RegionId=ap-southeast-1
|
|
5115
5103
|
* &ResourceId=i-bp67acfmxazb4p****
|
|
5116
5104
|
* &DestinationResource=InstanceType
|
|
5117
5105
|
* &OperationType=Upgrade
|
|
5118
|
-
*
|
|
5106
|
+
* &Common request parameters
|
|
5119
5107
|
* ```
|
|
5120
|
-
* ###
|
|
5121
|
-
* Query the instance types to which
|
|
5108
|
+
* ### Example 2: Query instance types available after changing the disk type of the current instance
|
|
5109
|
+
* Query the instance types to which instance i-bp67acfmxazb4p**** can be changed after the disk type is changed, and the inventory of the corresponding instance types in the zone where the instance resides.
|
|
5122
5110
|
* ```
|
|
5123
5111
|
* http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
|
|
5124
|
-
* &RegionId=
|
|
5112
|
+
* &RegionId=ap-southeast-1
|
|
5125
5113
|
* &ResourceId=i-bp67acfmxazb4p****
|
|
5126
5114
|
* &DestinationResource=InstanceType
|
|
5127
5115
|
* &OperationType=Upgrade
|
|
5128
5116
|
* &Conditions.0=DiskCategory
|
|
5129
|
-
*
|
|
5117
|
+
* &Common request parameters
|
|
5130
5118
|
* ```
|
|
5131
|
-
* ###
|
|
5132
|
-
* Query the
|
|
5133
|
-
* >
|
|
5119
|
+
* ### Example 3: Query the disk type required by the target instance type
|
|
5120
|
+
* Query the disk type required by the target instance type (for example, ecs.g7.large). The current instance i-bp67acfmxazb4p**** must be changed to this disk type before it can be changed to the target instance type. Also query the inventory of the disk type in the zone where the instance resides.
|
|
5121
|
+
* > The target instance type must be obtained by using Example 2.
|
|
5134
5122
|
* ```
|
|
5135
5123
|
* http(s)://ecs.aliyuncs.com/?Action=DescribeResourcesModification
|
|
5136
|
-
* &RegionId=
|
|
5124
|
+
* &RegionId=ap-southeast-1
|
|
5137
5125
|
* &ResourceId=i-bp67acfmxazb4p****
|
|
5138
5126
|
* &DestinationResource=SystemDisk
|
|
5139
5127
|
* &OperationType=Upgrade
|
|
5140
5128
|
* &InstanceType=ecs.g7.large
|
|
5141
|
-
*
|
|
5129
|
+
* &Common request parameters
|
|
5142
5130
|
* ```
|
|
5143
5131
|
*
|
|
5144
5132
|
* @param request - DescribeResourcesModificationRequest
|
|
@@ -5214,7 +5202,7 @@ export default class Client extends OpenApi {
|
|
|
5214
5202
|
*/
|
|
5215
5203
|
describeSavingsPlanPrice(request: $_model.DescribeSavingsPlanPriceRequest): Promise<$_model.DescribeSavingsPlanPriceResponse>;
|
|
5216
5204
|
/**
|
|
5217
|
-
* Queries the details of a specified security group
|
|
5205
|
+
* Queries the details of a specified security group, including the list of security group rules.
|
|
5218
5206
|
*
|
|
5219
5207
|
* @param request - DescribeSecurityGroupAttributeRequest
|
|
5220
5208
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5222,7 +5210,7 @@ export default class Client extends OpenApi {
|
|
|
5222
5210
|
*/
|
|
5223
5211
|
describeSecurityGroupAttributeWithOptions(request: $_model.DescribeSecurityGroupAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSecurityGroupAttributeResponse>;
|
|
5224
5212
|
/**
|
|
5225
|
-
* Queries the details of a specified security group
|
|
5213
|
+
* Queries the details of a specified security group, including the list of security group rules.
|
|
5226
5214
|
*
|
|
5227
5215
|
* @param request - DescribeSecurityGroupAttributeRequest
|
|
5228
5216
|
* @returns DescribeSecurityGroupAttributeResponse
|
|
@@ -5250,14 +5238,14 @@ export default class Client extends OpenApi {
|
|
|
5250
5238
|
*/
|
|
5251
5239
|
describeSecurityGroupReferences(request: $_model.DescribeSecurityGroupReferencesRequest): Promise<$_model.DescribeSecurityGroupReferencesResponse>;
|
|
5252
5240
|
/**
|
|
5253
|
-
*
|
|
5241
|
+
* Queries the basic information about security groups. You can filter results by region, security group ID, security group type, and other parameters through parameter query.
|
|
5254
5242
|
*
|
|
5255
5243
|
* @remarks
|
|
5256
|
-
* - **
|
|
5257
|
-
* -
|
|
5258
|
-
* -
|
|
5259
|
-
* -
|
|
5260
|
-
* - When
|
|
5244
|
+
* - **Paging query**: Use `MaxResults` and `NextToken` for paging query.
|
|
5245
|
+
* - If `NextToken` is not returned, the current page is the last page.
|
|
5246
|
+
* - For the first page, set only `MaxResults` to limit the number of entries to return. The `NextToken` value in the response is used to query subsequent pages.
|
|
5247
|
+
* - For subsequent pages, set `NextToken` to the `NextToken` value returned in the previous response and set `MaxResults` to limit the number of entries to return.
|
|
5248
|
+
* - When you invoke an API operation by using Cloud Assistant CLI, specify request parameters in the required format. For more information, see [Parameter format of CLI commands](https://help.aliyun.com/document_detail/110340.html).
|
|
5261
5249
|
*
|
|
5262
5250
|
* @param request - DescribeSecurityGroupsRequest
|
|
5263
5251
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5265,27 +5253,27 @@ export default class Client extends OpenApi {
|
|
|
5265
5253
|
*/
|
|
5266
5254
|
describeSecurityGroupsWithOptions(request: $_model.DescribeSecurityGroupsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSecurityGroupsResponse>;
|
|
5267
5255
|
/**
|
|
5268
|
-
*
|
|
5256
|
+
* Queries the basic information about security groups. You can filter results by region, security group ID, security group type, and other parameters through parameter query.
|
|
5269
5257
|
*
|
|
5270
5258
|
* @remarks
|
|
5271
|
-
* - **
|
|
5272
|
-
* -
|
|
5273
|
-
* -
|
|
5274
|
-
* -
|
|
5275
|
-
* - When
|
|
5259
|
+
* - **Paging query**: Use `MaxResults` and `NextToken` for paging query.
|
|
5260
|
+
* - If `NextToken` is not returned, the current page is the last page.
|
|
5261
|
+
* - For the first page, set only `MaxResults` to limit the number of entries to return. The `NextToken` value in the response is used to query subsequent pages.
|
|
5262
|
+
* - For subsequent pages, set `NextToken` to the `NextToken` value returned in the previous response and set `MaxResults` to limit the number of entries to return.
|
|
5263
|
+
* - When you invoke an API operation by using Cloud Assistant CLI, specify request parameters in the required format. For more information, see [Parameter format of CLI commands](https://help.aliyun.com/document_detail/110340.html).
|
|
5276
5264
|
*
|
|
5277
5265
|
* @param request - DescribeSecurityGroupsRequest
|
|
5278
5266
|
* @returns DescribeSecurityGroupsResponse
|
|
5279
5267
|
*/
|
|
5280
5268
|
describeSecurityGroups(request: $_model.DescribeSecurityGroupsRequest): Promise<$_model.DescribeSecurityGroupsResponse>;
|
|
5281
5269
|
/**
|
|
5282
|
-
* Queries the files sent by Cloud Assistant
|
|
5270
|
+
* Queries the list and status of files sent by Cloud Assistant by calling DescribeSendFileResults.
|
|
5283
5271
|
*
|
|
5284
5272
|
* @remarks
|
|
5285
|
-
* ##
|
|
5286
|
-
* -
|
|
5287
|
-
* - You can
|
|
5288
|
-
* -
|
|
5273
|
+
* ## Operation description:
|
|
5274
|
+
* - After you send a file, the file is not necessarily sent. You must check the actual sending result based on the return value of this operation.
|
|
5275
|
+
* - You can query execution information from the last 30 days. A maximum of 10,000 entries of execution information can be retained.
|
|
5276
|
+
* - When paged query the first page, set only MaxResults to limit the number of entries to return. The NextToken value returned in the result serves as the token for querying subsequent pages. When paged query subsequent pages, set NextToken to the value obtained from the previous response and set MaxResults to limit the number of entries to return.
|
|
5289
5277
|
*
|
|
5290
5278
|
* @param request - DescribeSendFileResultsRequest
|
|
5291
5279
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5293,13 +5281,13 @@ export default class Client extends OpenApi {
|
|
|
5293
5281
|
*/
|
|
5294
5282
|
describeSendFileResultsWithOptions(request: $_model.DescribeSendFileResultsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSendFileResultsResponse>;
|
|
5295
5283
|
/**
|
|
5296
|
-
* Queries the files sent by Cloud Assistant
|
|
5284
|
+
* Queries the list and status of files sent by Cloud Assistant by calling DescribeSendFileResults.
|
|
5297
5285
|
*
|
|
5298
5286
|
* @remarks
|
|
5299
|
-
* ##
|
|
5300
|
-
* -
|
|
5301
|
-
* - You can
|
|
5302
|
-
* -
|
|
5287
|
+
* ## Operation description:
|
|
5288
|
+
* - After you send a file, the file is not necessarily sent. You must check the actual sending result based on the return value of this operation.
|
|
5289
|
+
* - You can query execution information from the last 30 days. A maximum of 10,000 entries of execution information can be retained.
|
|
5290
|
+
* - When paged query the first page, set only MaxResults to limit the number of entries to return. The NextToken value returned in the result serves as the token for querying subsequent pages. When paged query subsequent pages, set NextToken to the value obtained from the previous response and set MaxResults to limit the number of entries to return.
|
|
5303
5291
|
*
|
|
5304
5292
|
* @param request - DescribeSendFileResultsRequest
|
|
5305
5293
|
* @returns DescribeSendFileResultsResponse
|
|
@@ -5396,47 +5384,39 @@ export default class Client extends OpenApi {
|
|
|
5396
5384
|
*/
|
|
5397
5385
|
describeSnapshotPackage(request: $_model.DescribeSnapshotPackageRequest): Promise<$_model.DescribeSnapshotPackageResponse>;
|
|
5398
5386
|
/**
|
|
5399
|
-
* Queries
|
|
5387
|
+
* Queries the snapshot list of a disk, including snapshot status, remaining time for a snapshot being created, and automatic snapshot retention days.
|
|
5400
5388
|
*
|
|
5401
5389
|
* @remarks
|
|
5402
|
-
*
|
|
5403
|
-
* When you
|
|
5390
|
+
* InstanceId, DiskId, and SnapshotIds are not required request parameters, but you can use them to build filter logic. These parameters are evaluated by using a logical AND.
|
|
5391
|
+
* When you invoke an API operation by using Cloud Assistant CLI, specify request parameter values in the required formats based on their data types. For details, see [CLI parameter format](https://help.aliyun.com/document_detail/110340.html).
|
|
5404
5392
|
* Request examples:
|
|
5405
5393
|
* <details>
|
|
5406
|
-
* <summary>
|
|
5407
|
-
* Query the snapshots of all cloud disks attached to an ECS instance in the China (Hangzhou) region
|
|
5408
|
-
* </summary>
|
|
5394
|
+
* <summary>Query the snapshot list of all disks attached to an ECS instance in the China (Hangzhou) region</summary>
|
|
5409
5395
|
* ```
|
|
5410
|
-
* RegionId: cn-hangzhou, //
|
|
5411
|
-
* InstanceId: i-bp1fh7by6d9mw7zr**** //
|
|
5396
|
+
* RegionId: cn-hangzhou, // Set the region to China (Hangzhou).
|
|
5397
|
+
* InstanceId: i-bp1fh7by6d9mw7zr**** // Set the instance ID to query.
|
|
5412
5398
|
* ```
|
|
5413
5399
|
* </details>
|
|
5414
5400
|
* <details>
|
|
5415
|
-
* <summary>
|
|
5416
|
-
* Query the snapshots of a cloud disk in the China (Hangzhou) region
|
|
5417
|
-
* </summary>
|
|
5401
|
+
* <summary>Query the snapshot information of a specific disk in the China (Hangzhou) region</summary>
|
|
5418
5402
|
* ```
|
|
5419
|
-
* RegionId: cn-hangzhou, //
|
|
5420
|
-
* DiskId: d-bp10e7ej8z743dmu**** //
|
|
5403
|
+
* RegionId: cn-hangzhou, // Set the region to China (Hangzhou).
|
|
5404
|
+
* DiskId: d-bp10e7ej8z743dmu**** // Set the disk ID to query.
|
|
5421
5405
|
* ```
|
|
5422
5406
|
* </details>
|
|
5423
5407
|
* <details>
|
|
5424
|
-
* <summary>
|
|
5425
|
-
* Query two snapshots in the China (Hangzhou) region by snapshot ID
|
|
5426
|
-
* </summary>
|
|
5408
|
+
* <summary>Query the information of two snapshots in the China (Hangzhou) region by snapshot ID</summary>
|
|
5427
5409
|
* ```
|
|
5428
|
-
* RegionId: cn-hangzhou, //
|
|
5429
|
-
* SnapshotIds: ["d-bp10e7ej8z743dmu****", "s-bp19vd1lorzgzt2s****"] //
|
|
5410
|
+
* RegionId: cn-hangzhou, // Set the region to China (Hangzhou).
|
|
5411
|
+
* SnapshotIds: ["d-bp10e7ej8z743dmu****", "s-bp19vd1lorzgzt2s****"] // Set the array of snapshot IDs to query.
|
|
5430
5412
|
* ```
|
|
5431
5413
|
* </details>
|
|
5432
5414
|
* <details>
|
|
5433
|
-
* <summary>
|
|
5434
|
-
* Query snapshots created after a specific time in the China (Hangzhou) region
|
|
5435
|
-
* </summary>
|
|
5415
|
+
* <summary>Query the snapshot information created after a specific point in time in the China (Hangzhou) region</summary>
|
|
5436
5416
|
* ```
|
|
5437
|
-
* RegionId: cn-hangzhou, //
|
|
5438
|
-
* Filter.1.Key: CreationStartTime, //
|
|
5439
|
-
* Filter.1.Value: 2024-11-27T00:00Z
|
|
5417
|
+
* RegionId: cn-hangzhou, // Set the region to China (Hangzhou).
|
|
5418
|
+
* Filter.1.Key: CreationStartTime, // Set the filter key for the creation start time.
|
|
5419
|
+
* Filter.1.Value: 2024-11-27T00:00Z.
|
|
5440
5420
|
* ```
|
|
5441
5421
|
* </details>
|
|
5442
5422
|
*
|
|
@@ -5446,47 +5426,39 @@ export default class Client extends OpenApi {
|
|
|
5446
5426
|
*/
|
|
5447
5427
|
describeSnapshotsWithOptions(request: $_model.DescribeSnapshotsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSnapshotsResponse>;
|
|
5448
5428
|
/**
|
|
5449
|
-
* Queries
|
|
5429
|
+
* Queries the snapshot list of a disk, including snapshot status, remaining time for a snapshot being created, and automatic snapshot retention days.
|
|
5450
5430
|
*
|
|
5451
5431
|
* @remarks
|
|
5452
|
-
*
|
|
5453
|
-
* When you
|
|
5432
|
+
* InstanceId, DiskId, and SnapshotIds are not required request parameters, but you can use them to build filter logic. These parameters are evaluated by using a logical AND.
|
|
5433
|
+
* When you invoke an API operation by using Cloud Assistant CLI, specify request parameter values in the required formats based on their data types. For details, see [CLI parameter format](https://help.aliyun.com/document_detail/110340.html).
|
|
5454
5434
|
* Request examples:
|
|
5455
5435
|
* <details>
|
|
5456
|
-
* <summary>
|
|
5457
|
-
* Query the snapshots of all cloud disks attached to an ECS instance in the China (Hangzhou) region
|
|
5458
|
-
* </summary>
|
|
5436
|
+
* <summary>Query the snapshot list of all disks attached to an ECS instance in the China (Hangzhou) region</summary>
|
|
5459
5437
|
* ```
|
|
5460
|
-
* RegionId: cn-hangzhou, //
|
|
5461
|
-
* InstanceId: i-bp1fh7by6d9mw7zr**** //
|
|
5438
|
+
* RegionId: cn-hangzhou, // Set the region to China (Hangzhou).
|
|
5439
|
+
* InstanceId: i-bp1fh7by6d9mw7zr**** // Set the instance ID to query.
|
|
5462
5440
|
* ```
|
|
5463
5441
|
* </details>
|
|
5464
5442
|
* <details>
|
|
5465
|
-
* <summary>
|
|
5466
|
-
* Query the snapshots of a cloud disk in the China (Hangzhou) region
|
|
5467
|
-
* </summary>
|
|
5443
|
+
* <summary>Query the snapshot information of a specific disk in the China (Hangzhou) region</summary>
|
|
5468
5444
|
* ```
|
|
5469
|
-
* RegionId: cn-hangzhou, //
|
|
5470
|
-
* DiskId: d-bp10e7ej8z743dmu**** //
|
|
5445
|
+
* RegionId: cn-hangzhou, // Set the region to China (Hangzhou).
|
|
5446
|
+
* DiskId: d-bp10e7ej8z743dmu**** // Set the disk ID to query.
|
|
5471
5447
|
* ```
|
|
5472
5448
|
* </details>
|
|
5473
5449
|
* <details>
|
|
5474
|
-
* <summary>
|
|
5475
|
-
* Query two snapshots in the China (Hangzhou) region by snapshot ID
|
|
5476
|
-
* </summary>
|
|
5450
|
+
* <summary>Query the information of two snapshots in the China (Hangzhou) region by snapshot ID</summary>
|
|
5477
5451
|
* ```
|
|
5478
|
-
* RegionId: cn-hangzhou, //
|
|
5479
|
-
* SnapshotIds: ["d-bp10e7ej8z743dmu****", "s-bp19vd1lorzgzt2s****"] //
|
|
5452
|
+
* RegionId: cn-hangzhou, // Set the region to China (Hangzhou).
|
|
5453
|
+
* SnapshotIds: ["d-bp10e7ej8z743dmu****", "s-bp19vd1lorzgzt2s****"] // Set the array of snapshot IDs to query.
|
|
5480
5454
|
* ```
|
|
5481
5455
|
* </details>
|
|
5482
5456
|
* <details>
|
|
5483
|
-
* <summary>
|
|
5484
|
-
* Query snapshots created after a specific time in the China (Hangzhou) region
|
|
5485
|
-
* </summary>
|
|
5457
|
+
* <summary>Query the snapshot information created after a specific point in time in the China (Hangzhou) region</summary>
|
|
5486
5458
|
* ```
|
|
5487
|
-
* RegionId: cn-hangzhou, //
|
|
5488
|
-
* Filter.1.Key: CreationStartTime, //
|
|
5489
|
-
* Filter.1.Value: 2024-11-27T00:00Z
|
|
5459
|
+
* RegionId: cn-hangzhou, // Set the region to China (Hangzhou).
|
|
5460
|
+
* Filter.1.Key: CreationStartTime, // Set the filter key for the creation start time.
|
|
5461
|
+
* Filter.1.Value: 2024-11-27T00:00Z.
|
|
5490
5462
|
* ```
|
|
5491
5463
|
* </details>
|
|
5492
5464
|
*
|
|
@@ -5549,11 +5521,11 @@ export default class Client extends OpenApi {
|
|
|
5549
5521
|
*/
|
|
5550
5522
|
describeSpotAdvice(request: $_model.DescribeSpotAdviceRequest): Promise<$_model.DescribeSpotAdviceResponse>;
|
|
5551
5523
|
/**
|
|
5552
|
-
* Queries the historical prices of spot instances
|
|
5524
|
+
* Queries the historical prices of spot instances. You can query price data from the last 30 days. The historical price data helps you set a reasonable maximum price for a spot instance.
|
|
5553
5525
|
*
|
|
5554
5526
|
* @remarks
|
|
5555
|
-
* -
|
|
5556
|
-
* - The data returned by
|
|
5527
|
+
* - Only I/O optimized spot instances are supported.
|
|
5528
|
+
* - The data returned by this operation may be paginated. If the response contains the `NextOffset` parameter, set the `Offset` request parameter to the value of `NextOffset` to query the next page of data.
|
|
5557
5529
|
*
|
|
5558
5530
|
* @param request - DescribeSpotPriceHistoryRequest
|
|
5559
5531
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5561,11 +5533,11 @@ export default class Client extends OpenApi {
|
|
|
5561
5533
|
*/
|
|
5562
5534
|
describeSpotPriceHistoryWithOptions(request: $_model.DescribeSpotPriceHistoryRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSpotPriceHistoryResponse>;
|
|
5563
5535
|
/**
|
|
5564
|
-
* Queries the historical prices of spot instances
|
|
5536
|
+
* Queries the historical prices of spot instances. You can query price data from the last 30 days. The historical price data helps you set a reasonable maximum price for a spot instance.
|
|
5565
5537
|
*
|
|
5566
5538
|
* @remarks
|
|
5567
|
-
* -
|
|
5568
|
-
* - The data returned by
|
|
5539
|
+
* - Only I/O optimized spot instances are supported.
|
|
5540
|
+
* - The data returned by this operation may be paginated. If the response contains the `NextOffset` parameter, set the `Offset` request parameter to the value of `NextOffset` to query the next page of data.
|
|
5569
5541
|
*
|
|
5570
5542
|
* @param request - DescribeSpotPriceHistoryRequest
|
|
5571
5543
|
* @returns DescribeSpotPriceHistoryResponse
|
|
@@ -5672,10 +5644,10 @@ export default class Client extends OpenApi {
|
|
|
5672
5644
|
*/
|
|
5673
5645
|
describeTasks(request: $_model.DescribeTasksRequest): Promise<$_model.DescribeTasksResponse>;
|
|
5674
5646
|
/**
|
|
5675
|
-
* Queries the session
|
|
5647
|
+
* Queries the session history of Session Manager.
|
|
5676
5648
|
*
|
|
5677
5649
|
* @remarks
|
|
5678
|
-
* You can query
|
|
5650
|
+
* You can query Session Manager session records created within the last 30 days. A maximum of 1,000 successful records are retained.
|
|
5679
5651
|
*
|
|
5680
5652
|
* @param request - DescribeTerminalSessionsRequest
|
|
5681
5653
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5683,10 +5655,10 @@ export default class Client extends OpenApi {
|
|
|
5683
5655
|
*/
|
|
5684
5656
|
describeTerminalSessionsWithOptions(request: $_model.DescribeTerminalSessionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeTerminalSessionsResponse>;
|
|
5685
5657
|
/**
|
|
5686
|
-
* Queries the session
|
|
5658
|
+
* Queries the session history of Session Manager.
|
|
5687
5659
|
*
|
|
5688
5660
|
* @remarks
|
|
5689
|
-
* You can query
|
|
5661
|
+
* You can query Session Manager session records created within the last 30 days. A maximum of 1,000 successful records are retained.
|
|
5690
5662
|
*
|
|
5691
5663
|
* @param request - DescribeTerminalSessionsRequest
|
|
5692
5664
|
* @returns DescribeTerminalSessionsResponse
|
|
@@ -5849,11 +5821,10 @@ export default class Client extends OpenApi {
|
|
|
5849
5821
|
*/
|
|
5850
5822
|
describeVscs(request: $_model.DescribeVscsRequest): Promise<$_model.DescribeVscsResponse>;
|
|
5851
5823
|
/**
|
|
5852
|
-
* Queries
|
|
5824
|
+
* Queries the list of active zones based on parameters such as region ID and billing method.
|
|
5853
5825
|
*
|
|
5854
5826
|
* @remarks
|
|
5855
|
-
*
|
|
5856
|
-
* When you call this operation, only a list of zones and some resource information of each zone are returned. If you want to query instance types and disk categories that are available for purchase in a specific zone, we recommend that you call the [DescribeAvailableResource](https://help.aliyun.com/document_detail/66186.html) operation.
|
|
5827
|
+
* DescribeZones only queries the list of zones provided by Alibaba Cloud and returns limited inventory information. To query the instance types and disk categories available for purchase in a specific zone, use [DescribeAvailableResource](https://help.aliyun.com/document_detail/66186.html).
|
|
5857
5828
|
*
|
|
5858
5829
|
* @param request - DescribeZonesRequest
|
|
5859
5830
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5861,11 +5832,10 @@ export default class Client extends OpenApi {
|
|
|
5861
5832
|
*/
|
|
5862
5833
|
describeZonesWithOptions(request: $_model.DescribeZonesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeZonesResponse>;
|
|
5863
5834
|
/**
|
|
5864
|
-
* Queries
|
|
5835
|
+
* Queries the list of active zones based on parameters such as region ID and billing method.
|
|
5865
5836
|
*
|
|
5866
5837
|
* @remarks
|
|
5867
|
-
*
|
|
5868
|
-
* When you call this operation, only a list of zones and some resource information of each zone are returned. If you want to query instance types and disk categories that are available for purchase in a specific zone, we recommend that you call the [DescribeAvailableResource](https://help.aliyun.com/document_detail/66186.html) operation.
|
|
5838
|
+
* DescribeZones only queries the list of zones provided by Alibaba Cloud and returns limited inventory information. To query the instance types and disk categories available for purchase in a specific zone, use [DescribeAvailableResource](https://help.aliyun.com/document_detail/66186.html).
|
|
5869
5839
|
*
|
|
5870
5840
|
* @param request - DescribeZonesRequest
|
|
5871
5841
|
* @returns DescribeZonesResponse
|
|
@@ -6282,7 +6252,7 @@ export default class Client extends OpenApi {
|
|
|
6282
6252
|
*/
|
|
6283
6253
|
exportSnapshot(request: $_model.ExportSnapshotRequest): Promise<$_model.ExportSnapshotResponse>;
|
|
6284
6254
|
/**
|
|
6285
|
-
* Retrieves the system command
|
|
6255
|
+
* Retrieves the system command-line output of an instance. The data is returned in Base64-encoded format.
|
|
6286
6256
|
*
|
|
6287
6257
|
* @remarks
|
|
6288
6258
|
* - Elastic Compute Service (ECS) is a virtualization-based cloud server that cannot be connected to display devices or manually screenshotted. However, Alibaba Cloud caches the system command line output from the last time an instance was started, restarted, or shut down. You can invoke GetInstanceConsoleOutput to retrieve this output.
|
|
@@ -6295,7 +6265,7 @@ export default class Client extends OpenApi {
|
|
|
6295
6265
|
*/
|
|
6296
6266
|
getInstanceConsoleOutputWithOptions(request: $_model.GetInstanceConsoleOutputRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetInstanceConsoleOutputResponse>;
|
|
6297
6267
|
/**
|
|
6298
|
-
* Retrieves the system command
|
|
6268
|
+
* Retrieves the system command-line output of an instance. The data is returned in Base64-encoded format.
|
|
6299
6269
|
*
|
|
6300
6270
|
* @remarks
|
|
6301
6271
|
* - Elastic Compute Service (ECS) is a virtualization-based cloud server that cannot be connected to display devices or manually screenshotted. However, Alibaba Cloud caches the system command line output from the last time an instance was started, restarted, or shut down. You can invoke GetInstanceConsoleOutput to retrieve this output.
|
|
@@ -6307,13 +6277,13 @@ export default class Client extends OpenApi {
|
|
|
6307
6277
|
*/
|
|
6308
6278
|
getInstanceConsoleOutput(request: $_model.GetInstanceConsoleOutputRequest): Promise<$_model.GetInstanceConsoleOutputResponse>;
|
|
6309
6279
|
/**
|
|
6310
|
-
* Calls GetInstanceScreenshot to
|
|
6280
|
+
* Calls GetInstanceScreenshot to retrieve the screenshot information of an instance.
|
|
6311
6281
|
*
|
|
6312
6282
|
* @remarks
|
|
6313
|
-
* After Elastic Compute Service (ECS) returns the instance screenshot
|
|
6283
|
+
* After Elastic Compute Service (ECS) returns the instance screenshot in Base64-encoded JPG image format, you must decode it yourself. You can call this operation when troubleshooting faults. Note the following items:
|
|
6314
6284
|
* - The instance must be in the Running state.
|
|
6315
|
-
* -
|
|
6316
|
-
* - If you call this operation multiple times on the same instance, the interval between calls must be at least 10 seconds. Otherwise, the
|
|
6285
|
+
* - Screenshots cannot be retrieved for [retired instance types](https://help.aliyun.com/document_detail/55263.html).
|
|
6286
|
+
* - If you call this operation multiple times on the same instance, the interval between calls must be at least 10 seconds. Otherwise, the Throttling error code is returned.
|
|
6317
6287
|
*
|
|
6318
6288
|
* @param request - GetInstanceScreenshotRequest
|
|
6319
6289
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6321,13 +6291,13 @@ export default class Client extends OpenApi {
|
|
|
6321
6291
|
*/
|
|
6322
6292
|
getInstanceScreenshotWithOptions(request: $_model.GetInstanceScreenshotRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetInstanceScreenshotResponse>;
|
|
6323
6293
|
/**
|
|
6324
|
-
* Calls GetInstanceScreenshot to
|
|
6294
|
+
* Calls GetInstanceScreenshot to retrieve the screenshot information of an instance.
|
|
6325
6295
|
*
|
|
6326
6296
|
* @remarks
|
|
6327
|
-
* After Elastic Compute Service (ECS) returns the instance screenshot
|
|
6297
|
+
* After Elastic Compute Service (ECS) returns the instance screenshot in Base64-encoded JPG image format, you must decode it yourself. You can call this operation when troubleshooting faults. Note the following items:
|
|
6328
6298
|
* - The instance must be in the Running state.
|
|
6329
|
-
* -
|
|
6330
|
-
* - If you call this operation multiple times on the same instance, the interval between calls must be at least 10 seconds. Otherwise, the
|
|
6299
|
+
* - Screenshots cannot be retrieved for [retired instance types](https://help.aliyun.com/document_detail/55263.html).
|
|
6300
|
+
* - If you call this operation multiple times on the same instance, the interval between calls must be at least 10 seconds. Otherwise, the Throttling error code is returned.
|
|
6331
6301
|
*
|
|
6332
6302
|
* @param request - GetInstanceScreenshotRequest
|
|
6333
6303
|
* @returns GetInstanceScreenshotResponse
|
|
@@ -7359,7 +7329,7 @@ export default class Client extends OpenApi {
|
|
|
7359
7329
|
*/
|
|
7360
7330
|
modifyHaVipAttribute(request: $_model.ModifyHaVipAttributeRequest): Promise<$_model.ModifyHaVipAttributeResponse>;
|
|
7361
7331
|
/**
|
|
7362
|
-
* Modifies the description of an HPC cluster
|
|
7332
|
+
* Modifies the description of an HPC cluster.
|
|
7363
7333
|
*
|
|
7364
7334
|
* @param request - ModifyHpcClusterAttributeRequest
|
|
7365
7335
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7367,7 +7337,7 @@ export default class Client extends OpenApi {
|
|
|
7367
7337
|
*/
|
|
7368
7338
|
modifyHpcClusterAttributeWithOptions(request: $_model.ModifyHpcClusterAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyHpcClusterAttributeResponse>;
|
|
7369
7339
|
/**
|
|
7370
|
-
* Modifies the description of an HPC cluster
|
|
7340
|
+
* Modifies the description of an HPC cluster.
|
|
7371
7341
|
*
|
|
7372
7342
|
* @param request - ModifyHpcClusterAttributeRequest
|
|
7373
7343
|
* @returns ModifyHpcClusterAttributeResponse
|
|
@@ -7486,10 +7456,10 @@ export default class Client extends OpenApi {
|
|
|
7486
7456
|
*/
|
|
7487
7457
|
modifyInstanceAttachmentAttributes(request: $_model.ModifyInstanceAttachmentAttributesRequest): Promise<$_model.ModifyInstanceAttachmentAttributesResponse>;
|
|
7488
7458
|
/**
|
|
7489
|
-
*
|
|
7459
|
+
* Modifies some properties of an ECS instance, including the password, instance name, hostname, security group membership, MTU, and instance user data.
|
|
7490
7460
|
*
|
|
7491
7461
|
* @remarks
|
|
7492
|
-
*
|
|
7462
|
+
* Instances that are locked for security reasons do not support this operation. For more information, see [Impact of resource security locks on API calls](https://help.aliyun.com/document_detail/25695.html).
|
|
7493
7463
|
*
|
|
7494
7464
|
* @param request - ModifyInstanceAttributeRequest
|
|
7495
7465
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7497,10 +7467,10 @@ export default class Client extends OpenApi {
|
|
|
7497
7467
|
*/
|
|
7498
7468
|
modifyInstanceAttributeWithOptions(request: $_model.ModifyInstanceAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyInstanceAttributeResponse>;
|
|
7499
7469
|
/**
|
|
7500
|
-
*
|
|
7470
|
+
* Modifies some properties of an ECS instance, including the password, instance name, hostname, security group membership, MTU, and instance user data.
|
|
7501
7471
|
*
|
|
7502
7472
|
* @remarks
|
|
7503
|
-
*
|
|
7473
|
+
* Instances that are locked for security reasons do not support this operation. For more information, see [Impact of resource security locks on API calls](https://help.aliyun.com/document_detail/25695.html).
|
|
7504
7474
|
*
|
|
7505
7475
|
* @param request - ModifyInstanceAttributeRequest
|
|
7506
7476
|
* @returns ModifyInstanceAttributeResponse
|
|
@@ -7724,15 +7694,14 @@ export default class Client extends OpenApi {
|
|
|
7724
7694
|
* Modifies the bandwidth configuration of an ECS instance, allocates a public IP address, or converts the network billing method. Both upgrades and downgrades are supported.
|
|
7725
7695
|
*
|
|
7726
7696
|
* @remarks
|
|
7727
|
-
* - When
|
|
7728
|
-
* - When
|
|
7729
|
-
*
|
|
7730
|
-
* > Within a single region, there is a limit on the total peak pay-by-bandwidth public bandwidth for a single Alibaba Cloud account. For more information, see [Public bandwidth limits](~~25412#BandwidthQuota~~).
|
|
7697
|
+
* - When you modify the bandwidth configuration of a subscription (PrePaid) instance, a public IP address is automatically allocated if the outbound public bandwidth (InternetMaxBandwidthOut) is upgraded from 0 Mbit/s to a non-zero value.
|
|
7698
|
+
* - When you modify the bandwidth configuration of a pay-as-you-go (PostPaid) instance, a public IP address is not automatically allocated if the outbound public bandwidth (InternetMaxBandwidthOut) is upgraded from 0 Mbit/s to a non-zero value. You need to set the `AllocatePublicIp` parameter to `true` to allocate a public IP address.
|
|
7699
|
+
* > In a single region, the total peak pay-by-bandwidth public bandwidth of a single Alibaba Cloud account is subject to a limit. For more information, see [Public bandwidth limits](~~25412#BandwidthQuota~~).
|
|
7731
7700
|
*
|
|
7732
7701
|
* - Fees:
|
|
7733
7702
|
*
|
|
7734
|
-
* - After
|
|
7735
|
-
* - After
|
|
7703
|
+
* - After the bandwidth is upgraded, the payment is automatically deducted by default. Make sure that your payment method has sufficient balance. Otherwise, an abnormal order is generated, and you can only cancel the order. If your account balance is insufficient, you can set the AutoPay parameter to false. In this case, a normal unpaid order is generated. You can log on to the ECS console to pay for the order.
|
|
7704
|
+
* - After the bandwidth is downgraded, the price difference is refunded to the original payment method. Vouchers that have been used are not refundable.
|
|
7736
7705
|
*
|
|
7737
7706
|
* @param request - ModifyInstanceNetworkSpecRequest
|
|
7738
7707
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7743,15 +7712,14 @@ export default class Client extends OpenApi {
|
|
|
7743
7712
|
* Modifies the bandwidth configuration of an ECS instance, allocates a public IP address, or converts the network billing method. Both upgrades and downgrades are supported.
|
|
7744
7713
|
*
|
|
7745
7714
|
* @remarks
|
|
7746
|
-
* - When
|
|
7747
|
-
* - When
|
|
7748
|
-
*
|
|
7749
|
-
* > Within a single region, there is a limit on the total peak pay-by-bandwidth public bandwidth for a single Alibaba Cloud account. For more information, see [Public bandwidth limits](~~25412#BandwidthQuota~~).
|
|
7715
|
+
* - When you modify the bandwidth configuration of a subscription (PrePaid) instance, a public IP address is automatically allocated if the outbound public bandwidth (InternetMaxBandwidthOut) is upgraded from 0 Mbit/s to a non-zero value.
|
|
7716
|
+
* - When you modify the bandwidth configuration of a pay-as-you-go (PostPaid) instance, a public IP address is not automatically allocated if the outbound public bandwidth (InternetMaxBandwidthOut) is upgraded from 0 Mbit/s to a non-zero value. You need to set the `AllocatePublicIp` parameter to `true` to allocate a public IP address.
|
|
7717
|
+
* > In a single region, the total peak pay-by-bandwidth public bandwidth of a single Alibaba Cloud account is subject to a limit. For more information, see [Public bandwidth limits](~~25412#BandwidthQuota~~).
|
|
7750
7718
|
*
|
|
7751
7719
|
* - Fees:
|
|
7752
7720
|
*
|
|
7753
|
-
* - After
|
|
7754
|
-
* - After
|
|
7721
|
+
* - After the bandwidth is upgraded, the payment is automatically deducted by default. Make sure that your payment method has sufficient balance. Otherwise, an abnormal order is generated, and you can only cancel the order. If your account balance is insufficient, you can set the AutoPay parameter to false. In this case, a normal unpaid order is generated. You can log on to the ECS console to pay for the order.
|
|
7722
|
+
* - After the bandwidth is downgraded, the price difference is refunded to the original payment method. Vouchers that have been used are not refundable.
|
|
7755
7723
|
*
|
|
7756
7724
|
* @param request - ModifyInstanceNetworkSpecRequest
|
|
7757
7725
|
* @returns ModifyInstanceNetworkSpecResponse
|
|
@@ -7762,18 +7730,18 @@ export default class Client extends OpenApi {
|
|
|
7762
7730
|
*
|
|
7763
7731
|
* @remarks
|
|
7764
7732
|
* <props="china">.
|
|
7765
|
-
* **Before you
|
|
7733
|
+
* **Before you use this operation, make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of ECS.**.
|
|
7766
7734
|
* .
|
|
7767
7735
|
* <props="intl">.
|
|
7768
|
-
* **Before you
|
|
7736
|
+
* **Before you use this operation, make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/zh/pricing-calculator#/commodity/vm_intl) of ECS.**.
|
|
7769
7737
|
* .
|
|
7770
7738
|
* Before you [change the instance type of a pay-as-you-go instance](https://help.aliyun.com/document_detail/60051.html), you can call [DescribeResourcesModification](https://help.aliyun.com/document_detail/66187.html) to query the instance types to which the current instance can be changed.
|
|
7771
7739
|
* **Before you begin**.
|
|
7772
7740
|
* - Your account must not have overdue payments.
|
|
7773
|
-
* - Each call can modify only one configuration. You can
|
|
7741
|
+
* - Each call can modify only one configuration at a time. You can modify only the instance type or adjust only the public bandwidth in a single request.
|
|
7774
7742
|
* - The instance status must be **Running** (`Running`) or **Stopped** (`Stopped`) before you can adjust the public bandwidth. The change takes effect immediately.
|
|
7775
|
-
* - The instance status must be **Stopped** (`Stopped`) before you can
|
|
7776
|
-
* >
|
|
7743
|
+
* - The instance status must be **Stopped** (`Stopped`) before you can modify the instance type. After the modification, you must [start the instance](https://help.aliyun.com/document_detail/25441.html) for the change to take effect.
|
|
7744
|
+
* > In a single region, the total peak pay-by-bandwidth public bandwidth for a single Alibaba Cloud account is limited. For more information, see [Public bandwidth limits](~~25412#BandwidthQuota~~).
|
|
7777
7745
|
*
|
|
7778
7746
|
* @param request - ModifyInstanceSpecRequest
|
|
7779
7747
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7785,18 +7753,18 @@ export default class Client extends OpenApi {
|
|
|
7785
7753
|
*
|
|
7786
7754
|
* @remarks
|
|
7787
7755
|
* <props="china">.
|
|
7788
|
-
* **Before you
|
|
7756
|
+
* **Before you use this operation, make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of ECS.**.
|
|
7789
7757
|
* .
|
|
7790
7758
|
* <props="intl">.
|
|
7791
|
-
* **Before you
|
|
7759
|
+
* **Before you use this operation, make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/zh/pricing-calculator#/commodity/vm_intl) of ECS.**.
|
|
7792
7760
|
* .
|
|
7793
7761
|
* Before you [change the instance type of a pay-as-you-go instance](https://help.aliyun.com/document_detail/60051.html), you can call [DescribeResourcesModification](https://help.aliyun.com/document_detail/66187.html) to query the instance types to which the current instance can be changed.
|
|
7794
7762
|
* **Before you begin**.
|
|
7795
7763
|
* - Your account must not have overdue payments.
|
|
7796
|
-
* - Each call can modify only one configuration. You can
|
|
7764
|
+
* - Each call can modify only one configuration at a time. You can modify only the instance type or adjust only the public bandwidth in a single request.
|
|
7797
7765
|
* - The instance status must be **Running** (`Running`) or **Stopped** (`Stopped`) before you can adjust the public bandwidth. The change takes effect immediately.
|
|
7798
|
-
* - The instance status must be **Stopped** (`Stopped`) before you can
|
|
7799
|
-
* >
|
|
7766
|
+
* - The instance status must be **Stopped** (`Stopped`) before you can modify the instance type. After the modification, you must [start the instance](https://help.aliyun.com/document_detail/25441.html) for the change to take effect.
|
|
7767
|
+
* > In a single region, the total peak pay-by-bandwidth public bandwidth for a single Alibaba Cloud account is limited. For more information, see [Public bandwidth limits](~~25412#BandwidthQuota~~).
|
|
7800
7768
|
*
|
|
7801
7769
|
* @param request - ModifyInstanceSpecRequest
|
|
7802
7770
|
* @returns ModifyInstanceSpecResponse
|
|
@@ -8015,7 +7983,7 @@ export default class Client extends OpenApi {
|
|
|
8015
7983
|
* Updates an O&M window.
|
|
8016
7984
|
*
|
|
8017
7985
|
* @remarks
|
|
8018
|
-
* Modifies the attributes of an O&M window. When the TargetResource parameter of an O&M window is set to associate ECS instances and
|
|
7986
|
+
* Modifies the attributes of an O&M window. When the TargetResource parameter of an O&M window is set to associate ECS instances and underlying hardware risks are detected that require scheduled O&M to mitigate, the execution time of the scheduled O&M is determined based on the time range specified by the TimePeriod parameter of the O&M window. When the execution time of an O&M event is reached, the platform automatically performs the corresponding O&M operation based on the type of the O&M event.
|
|
8019
7987
|
*
|
|
8020
7988
|
* @param tmpReq - ModifyPlanMaintenanceWindowRequest
|
|
8021
7989
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8026,7 +7994,7 @@ export default class Client extends OpenApi {
|
|
|
8026
7994
|
* Updates an O&M window.
|
|
8027
7995
|
*
|
|
8028
7996
|
* @remarks
|
|
8029
|
-
* Modifies the attributes of an O&M window. When the TargetResource parameter of an O&M window is set to associate ECS instances and
|
|
7997
|
+
* Modifies the attributes of an O&M window. When the TargetResource parameter of an O&M window is set to associate ECS instances and underlying hardware risks are detected that require scheduled O&M to mitigate, the execution time of the scheduled O&M is determined based on the time range specified by the TimePeriod parameter of the O&M window. When the execution time of an O&M event is reached, the platform automatically performs the corresponding O&M operation based on the type of the O&M event.
|
|
8030
7998
|
*
|
|
8031
7999
|
* @param request - ModifyPlanMaintenanceWindowRequest
|
|
8032
8000
|
* @returns ModifyPlanMaintenanceWindowResponse
|
|
@@ -8081,20 +8049,24 @@ export default class Client extends OpenApi {
|
|
|
8081
8049
|
*/
|
|
8082
8050
|
modifyPrefixList(request: $_model.ModifyPrefixListRequest): Promise<$_model.ModifyPrefixListResponse>;
|
|
8083
8051
|
/**
|
|
8084
|
-
*
|
|
8052
|
+
* Modifies the instance type of a subscription ECS instance. You can upgrade or downgrade the instance type. The new instance type takes effect for the entire lifecycle of the instance.
|
|
8085
8053
|
*
|
|
8086
8054
|
* @remarks
|
|
8087
|
-
*
|
|
8088
|
-
*
|
|
8089
|
-
*
|
|
8090
|
-
*
|
|
8091
|
-
*
|
|
8092
|
-
*
|
|
8093
|
-
* -
|
|
8094
|
-
* -
|
|
8095
|
-
*
|
|
8096
|
-
*
|
|
8097
|
-
*
|
|
8055
|
+
* <props="china">
|
|
8056
|
+
* **Before you call this operation, make sure that you fully understand the billing methods, [pricing](https://www.aliyun.com/price/product#/ecs/detail), and [downgrade refund rules](https://help.aliyun.com/document_detail/116043.html) of ECS.**
|
|
8057
|
+
* <props="intl">
|
|
8058
|
+
* **Before you call this operation, make sure that you fully understand the billing methods, [pricing](https://www.alibabacloud.com/zh/pricing-calculator#/commodity/vm_intl), and [downgrade refund rules](https://help.aliyun.com/document_detail/476339.html) of ECS.**
|
|
8059
|
+
* This operation is asynchronous. The configuration change takes effect after approximately 5 to 10 seconds. Before you upgrade or downgrade ECS instance type of a subscription ECS instance, you can call [DescribeResourcesModification](https://help.aliyun.com/document_detail/2679954.html) to query ECS instance types to which the current instance can be changed.
|
|
8060
|
+
* **Precautions**
|
|
8061
|
+
* - If the NVMe property of the source and target instance types are different (the `NvmeSupport` field returned by [DescribeInstanceTypes](https://help.aliyun.com/document_detail/2679699.html)) and the operating system is Windows (the `OSType` field returned by [DescribeInstances](https://help.aliyun.com/document_detail/2679689.html)), complete the [preventive measures](~~2978777#7de04a1c9fo50~~) before you perform the Upgrade/Downgrade.
|
|
8062
|
+
* - Expired instances cannot be changed to a different instance type. Complete the renewal and try again.
|
|
8063
|
+
* - Downgrade the instance type:
|
|
8064
|
+
* - The instance must be in the **Stopped** (`Stopped`) state.
|
|
8065
|
+
* - The price difference between the original and new instance types is refunded to your original billing method. Used vouchers are not refundable. The payer receives the refund.
|
|
8066
|
+
* - The new instance type takes effect only after you [start the instance](https://help.aliyun.com/document_detail/25441.html) after the Upgrade/Downgrade.
|
|
8067
|
+
* - Upgrade the instance type:
|
|
8068
|
+
* - The instance must be in the **Stopped** (`Stopped`) or **Running** (`Running`) state.
|
|
8069
|
+
* - The new instance type takes effect only after you [start the instance](https://help.aliyun.com/document_detail/25441.html) or [restart the instance](https://help.aliyun.com/document_detail/25440.html).
|
|
8098
8070
|
*
|
|
8099
8071
|
* @param request - ModifyPrepayInstanceSpecRequest
|
|
8100
8072
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8102,20 +8074,24 @@ export default class Client extends OpenApi {
|
|
|
8102
8074
|
*/
|
|
8103
8075
|
modifyPrepayInstanceSpecWithOptions(request: $_model.ModifyPrepayInstanceSpecRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyPrepayInstanceSpecResponse>;
|
|
8104
8076
|
/**
|
|
8105
|
-
*
|
|
8077
|
+
* Modifies the instance type of a subscription ECS instance. You can upgrade or downgrade the instance type. The new instance type takes effect for the entire lifecycle of the instance.
|
|
8106
8078
|
*
|
|
8107
8079
|
* @remarks
|
|
8108
|
-
*
|
|
8109
|
-
*
|
|
8110
|
-
*
|
|
8111
|
-
*
|
|
8112
|
-
*
|
|
8113
|
-
*
|
|
8114
|
-
* -
|
|
8115
|
-
* -
|
|
8116
|
-
*
|
|
8117
|
-
*
|
|
8118
|
-
*
|
|
8080
|
+
* <props="china">
|
|
8081
|
+
* **Before you call this operation, make sure that you fully understand the billing methods, [pricing](https://www.aliyun.com/price/product#/ecs/detail), and [downgrade refund rules](https://help.aliyun.com/document_detail/116043.html) of ECS.**
|
|
8082
|
+
* <props="intl">
|
|
8083
|
+
* **Before you call this operation, make sure that you fully understand the billing methods, [pricing](https://www.alibabacloud.com/zh/pricing-calculator#/commodity/vm_intl), and [downgrade refund rules](https://help.aliyun.com/document_detail/476339.html) of ECS.**
|
|
8084
|
+
* This operation is asynchronous. The configuration change takes effect after approximately 5 to 10 seconds. Before you upgrade or downgrade ECS instance type of a subscription ECS instance, you can call [DescribeResourcesModification](https://help.aliyun.com/document_detail/2679954.html) to query ECS instance types to which the current instance can be changed.
|
|
8085
|
+
* **Precautions**
|
|
8086
|
+
* - If the NVMe property of the source and target instance types are different (the `NvmeSupport` field returned by [DescribeInstanceTypes](https://help.aliyun.com/document_detail/2679699.html)) and the operating system is Windows (the `OSType` field returned by [DescribeInstances](https://help.aliyun.com/document_detail/2679689.html)), complete the [preventive measures](~~2978777#7de04a1c9fo50~~) before you perform the Upgrade/Downgrade.
|
|
8087
|
+
* - Expired instances cannot be changed to a different instance type. Complete the renewal and try again.
|
|
8088
|
+
* - Downgrade the instance type:
|
|
8089
|
+
* - The instance must be in the **Stopped** (`Stopped`) state.
|
|
8090
|
+
* - The price difference between the original and new instance types is refunded to your original billing method. Used vouchers are not refundable. The payer receives the refund.
|
|
8091
|
+
* - The new instance type takes effect only after you [start the instance](https://help.aliyun.com/document_detail/25441.html) after the Upgrade/Downgrade.
|
|
8092
|
+
* - Upgrade the instance type:
|
|
8093
|
+
* - The instance must be in the **Stopped** (`Stopped`) or **Running** (`Running`) state.
|
|
8094
|
+
* - The new instance type takes effect only after you [start the instance](https://help.aliyun.com/document_detail/25441.html) or [restart the instance](https://help.aliyun.com/document_detail/25440.html).
|
|
8119
8095
|
*
|
|
8120
8096
|
* @param request - ModifyPrepayInstanceSpecRequest
|
|
8121
8097
|
* @returns ModifyPrepayInstanceSpecResponse
|
|
@@ -8334,12 +8310,12 @@ export default class Client extends OpenApi {
|
|
|
8334
8310
|
*/
|
|
8335
8311
|
modifySecurityGroupAttribute(request: $_model.ModifySecurityGroupAttributeRequest): Promise<$_model.ModifySecurityGroupAttributeResponse>;
|
|
8336
8312
|
/**
|
|
8337
|
-
* Modifies an
|
|
8313
|
+
* Modifies an outbound security group rule.
|
|
8338
8314
|
*
|
|
8339
8315
|
* @remarks
|
|
8340
|
-
* When
|
|
8341
|
-
* -
|
|
8342
|
-
* -
|
|
8316
|
+
* When you modify a security group rule by specifying the security group rule ID, take note of the following limits:
|
|
8317
|
+
* - The authorization object of a security group rule can be an IPv4 Classless Inter-Domain Routing (CIDR) block (or IP address), an IPv6 CIDR block (or IP address), a security group, or a prefix list. You cannot use this operation to change the type of the authorization object of an existing security group rule. For example, if the original authorization object type is an IPv4 CIDR block, you can change it to another IPv4 CIDR block (or IP address), but you cannot change it to an IPv6 CIDR block (or IP address), a security group, or a prefix list.
|
|
8318
|
+
* - You cannot change a field value from a non-empty value to an empty value. To modify security group rules in this case, increase a new rule and then delete the current rule.
|
|
8343
8319
|
*
|
|
8344
8320
|
* @param request - ModifySecurityGroupEgressRuleRequest
|
|
8345
8321
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8347,12 +8323,12 @@ export default class Client extends OpenApi {
|
|
|
8347
8323
|
*/
|
|
8348
8324
|
modifySecurityGroupEgressRuleWithOptions(request: $_model.ModifySecurityGroupEgressRuleRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifySecurityGroupEgressRuleResponse>;
|
|
8349
8325
|
/**
|
|
8350
|
-
* Modifies an
|
|
8326
|
+
* Modifies an outbound security group rule.
|
|
8351
8327
|
*
|
|
8352
8328
|
* @remarks
|
|
8353
|
-
* When
|
|
8354
|
-
* -
|
|
8355
|
-
* -
|
|
8329
|
+
* When you modify a security group rule by specifying the security group rule ID, take note of the following limits:
|
|
8330
|
+
* - The authorization object of a security group rule can be an IPv4 Classless Inter-Domain Routing (CIDR) block (or IP address), an IPv6 CIDR block (or IP address), a security group, or a prefix list. You cannot use this operation to change the type of the authorization object of an existing security group rule. For example, if the original authorization object type is an IPv4 CIDR block, you can change it to another IPv4 CIDR block (or IP address), but you cannot change it to an IPv6 CIDR block (or IP address), a security group, or a prefix list.
|
|
8331
|
+
* - You cannot change a field value from a non-empty value to an empty value. To modify security group rules in this case, increase a new rule and then delete the current rule.
|
|
8356
8332
|
*
|
|
8357
8333
|
* @param request - ModifySecurityGroupEgressRuleRequest
|
|
8358
8334
|
* @returns ModifySecurityGroupEgressRuleResponse
|
|
@@ -8391,7 +8367,7 @@ export default class Client extends OpenApi {
|
|
|
8391
8367
|
* @remarks
|
|
8392
8368
|
* When you modify a security group rule by specifying the security group rule ID, take note of the following limits:
|
|
8393
8369
|
* - The authorization object of a security group rule can be an IPv4 Classless Inter-Domain Routing (CIDR) block (or IP address), an IPv6 CIDR block (or IP address), a security group, or a prefix list. You cannot use this operation to change the type of the authorization object of an existing security group rule. For example, if the original authorization object type is an IPv4 CIDR block, you can change it to another IPv4 CIDR block (or IP address), but you cannot change it to an IPv6 CIDR block (or IP address), a security group, or a prefix list.
|
|
8394
|
-
* - You cannot change a field from a non-empty value to an empty value. To modify security group rules in this case, increase a new rule and then delete the current rule.
|
|
8370
|
+
* - You cannot change a field value from a non-empty value to an empty value. To modify security group rules in this case, increase a new rule and then delete the current rule.
|
|
8395
8371
|
*
|
|
8396
8372
|
* @param request - ModifySecurityGroupRuleRequest
|
|
8397
8373
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8404,7 +8380,7 @@ export default class Client extends OpenApi {
|
|
|
8404
8380
|
* @remarks
|
|
8405
8381
|
* When you modify a security group rule by specifying the security group rule ID, take note of the following limits:
|
|
8406
8382
|
* - The authorization object of a security group rule can be an IPv4 Classless Inter-Domain Routing (CIDR) block (or IP address), an IPv6 CIDR block (or IP address), a security group, or a prefix list. You cannot use this operation to change the type of the authorization object of an existing security group rule. For example, if the original authorization object type is an IPv4 CIDR block, you can change it to another IPv4 CIDR block (or IP address), but you cannot change it to an IPv6 CIDR block (or IP address), a security group, or a prefix list.
|
|
8407
|
-
* - You cannot change a field from a non-empty value to an empty value. To modify security group rules in this case, increase a new rule and then delete the current rule.
|
|
8383
|
+
* - You cannot change a field value from a non-empty value to an empty value. To modify security group rules in this case, increase a new rule and then delete the current rule.
|
|
8408
8384
|
*
|
|
8409
8385
|
* @param request - ModifySecurityGroupRuleRequest
|
|
8410
8386
|
* @returns ModifySecurityGroupRuleResponse
|
|
@@ -8499,6 +8475,33 @@ export default class Client extends OpenApi {
|
|
|
8499
8475
|
* @returns ModifyStorageSetAttributeResponse
|
|
8500
8476
|
*/
|
|
8501
8477
|
modifyStorageSetAttribute(request: $_model.ModifyStorageSetAttributeRequest): Promise<$_model.ModifyStorageSetAttributeResponse>;
|
|
8478
|
+
/**
|
|
8479
|
+
* 修改计划内运维事件属性
|
|
8480
|
+
*
|
|
8481
|
+
* @remarks
|
|
8482
|
+
* ## 接口说明
|
|
8483
|
+
* - 只能修改状态为Scheduled的计划内运维事件。
|
|
8484
|
+
* - 传入的NotBefore不早于当前时间。
|
|
8485
|
+
* - 传入的NotBefore不晚于事件产生时初始的计划执行时间。
|
|
8486
|
+
*
|
|
8487
|
+
* @param request - ModifySystemEventAttributeRequest
|
|
8488
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
8489
|
+
* @returns ModifySystemEventAttributeResponse
|
|
8490
|
+
*/
|
|
8491
|
+
modifySystemEventAttributeWithOptions(request: $_model.ModifySystemEventAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifySystemEventAttributeResponse>;
|
|
8492
|
+
/**
|
|
8493
|
+
* 修改计划内运维事件属性
|
|
8494
|
+
*
|
|
8495
|
+
* @remarks
|
|
8496
|
+
* ## 接口说明
|
|
8497
|
+
* - 只能修改状态为Scheduled的计划内运维事件。
|
|
8498
|
+
* - 传入的NotBefore不早于当前时间。
|
|
8499
|
+
* - 传入的NotBefore不晚于事件产生时初始的计划执行时间。
|
|
8500
|
+
*
|
|
8501
|
+
* @param request - ModifySystemEventAttributeRequest
|
|
8502
|
+
* @returns ModifySystemEventAttributeResponse
|
|
8503
|
+
*/
|
|
8504
|
+
modifySystemEventAttribute(request: $_model.ModifySystemEventAttributeRequest): Promise<$_model.ModifySystemEventAttributeResponse>;
|
|
8502
8505
|
/**
|
|
8503
8506
|
* Modifies the default user-level attributes.
|
|
8504
8507
|
*
|
|
@@ -9067,7 +9070,7 @@ export default class Client extends OpenApi {
|
|
|
9067
9070
|
*/
|
|
9068
9071
|
renewDedicatedHosts(request: $_model.RenewDedicatedHostsRequest): Promise<$_model.RenewDedicatedHostsResponse>;
|
|
9069
9072
|
/**
|
|
9070
|
-
* Renews
|
|
9073
|
+
* Renews one or more purchased elasticity assurance services.
|
|
9071
9074
|
*
|
|
9072
9075
|
* @param request - RenewElasticityAssurancesRequest
|
|
9073
9076
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9075,7 +9078,7 @@ export default class Client extends OpenApi {
|
|
|
9075
9078
|
*/
|
|
9076
9079
|
renewElasticityAssurancesWithOptions(request: $_model.RenewElasticityAssurancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RenewElasticityAssurancesResponse>;
|
|
9077
9080
|
/**
|
|
9078
|
-
* Renews
|
|
9081
|
+
* Renews one or more purchased elasticity assurance services.
|
|
9079
9082
|
*
|
|
9080
9083
|
* @param request - RenewElasticityAssurancesRequest
|
|
9081
9084
|
* @returns RenewElasticityAssurancesResponse
|
|
@@ -9306,61 +9309,57 @@ export default class Client extends OpenApi {
|
|
|
9306
9309
|
*/
|
|
9307
9310
|
resizeDisk(request: $_model.ResizeDiskRequest): Promise<$_model.ResizeDiskResponse>;
|
|
9308
9311
|
/**
|
|
9309
|
-
* Deletes inbound security group rules from a
|
|
9310
|
-
*
|
|
9311
|
-
* @remarks
|
|
9312
|
-
* > Alibaba Cloud
|
|
9313
|
-
* You can use one of the following
|
|
9314
|
-
* -
|
|
9315
|
-
*
|
|
9316
|
-
* -
|
|
9317
|
-
*
|
|
9318
|
-
*
|
|
9319
|
-
*
|
|
9320
|
-
*
|
|
9321
|
-
*
|
|
9322
|
-
*
|
|
9323
|
-
* > You cannot specify
|
|
9324
|
-
* ###
|
|
9325
|
-
* - Delete
|
|
9326
|
-
* <!---->
|
|
9312
|
+
* Deletes one or more inbound security group rules from a specified security group.
|
|
9313
|
+
*
|
|
9314
|
+
* @remarks
|
|
9315
|
+
* >Notice: Starting July 8, 2024, Alibaba Cloud adjusted the validation rules for this operation. When you attempt to delete a security group rule that does not exist, the operation now returns the error code "InvalidParam.SecurityGroupRuleId" instead of a success response. Update your error code handling to be compatible accordingly to avoid impact on your production workloads.
|
|
9316
|
+
* You can use one of the following methods to pass parameters to delete rules:
|
|
9317
|
+
* - Specify security group rule IDs to delete rules (recommended).
|
|
9318
|
+
* - If a specified security group rule ID does not exist, the API invocation fails.
|
|
9319
|
+
* - Specify Permissions to delete rules.
|
|
9320
|
+
* - If no matching security group rule exists, the invocation succeeds but no rule is deleted.
|
|
9321
|
+
* - The following parameters are required to identify an inbound rule:
|
|
9322
|
+
* - Source settings: Set one of SourceCidrIp (IPv4 address), Ipv6SourceCidrIp (IPv6 address), SourcePrefixListId (prefix list ID), or SourceGroupId (source security group).
|
|
9323
|
+
* - Destination port range: PortRange.
|
|
9324
|
+
* - Protocol type: IpProtocol.
|
|
9325
|
+
* - Access policy: Policy.
|
|
9326
|
+
* > You cannot specify both security group rule IDs and Permissions at the same time.
|
|
9327
|
+
* ### Request examples
|
|
9328
|
+
* - Delete by specifying security group rule IDs.
|
|
9327
9329
|
* ```
|
|
9328
|
-
* "SecurityGroupId":"sg-bp67acfmxazb4p****", //Specify the
|
|
9329
|
-
* "SecurityGroupRuleId":["sgr-bpdfmk****","sgr-bpdfmg****"] //Specify the
|
|
9330
|
+
* "SecurityGroupId":"sg-bp67acfmxazb4p****", // Specify the security group ID.
|
|
9331
|
+
* "SecurityGroupRuleId":["sgr-bpdfmk****","sgr-bpdfmg****"] // Specify the security group rule IDs.
|
|
9330
9332
|
* ```
|
|
9331
|
-
* - Delete
|
|
9332
|
-
* <!---->
|
|
9333
|
+
* - Delete by specifying an IP address range.
|
|
9333
9334
|
* ```
|
|
9334
9335
|
* "SecurityGroupId":"sg-bp67acfmxazb4p****",
|
|
9335
9336
|
* "Permissions":[
|
|
9336
9337
|
* {
|
|
9337
|
-
* "SourceCidrIp":"10.0.0.0/8", //Specify the source
|
|
9338
|
-
* "IpProtocol":"TCP", //Specify the protocol.
|
|
9339
|
-
* "PortRange":"80/80", //Specify the destination port range.
|
|
9340
|
-
* "Policy":"accept" //Specify the
|
|
9338
|
+
* "SourceCidrIp":"10.0.0.0/8", // Specify the source IP address range.
|
|
9339
|
+
* "IpProtocol":"TCP", // Specify the protocol type.
|
|
9340
|
+
* "PortRange":"80/80", // Specify the destination port range.
|
|
9341
|
+
* "Policy":"accept" // Specify the access policy.
|
|
9341
9342
|
* }
|
|
9342
9343
|
* ]
|
|
9343
9344
|
* ```
|
|
9344
|
-
* - Delete
|
|
9345
|
-
* <!---->
|
|
9345
|
+
* - Delete by specifying another security group.
|
|
9346
9346
|
* ```
|
|
9347
9347
|
* "SecurityGroupId":"sg-bp67acfmxazb4p****",
|
|
9348
9348
|
* "Permissions":[
|
|
9349
9349
|
* {
|
|
9350
|
-
* "SourceGroupId":"sg-bp67acfmxa123b****", //Specify the
|
|
9350
|
+
* "SourceGroupId":"sg-bp67acfmxa123b****", // Specify the source security group ID.
|
|
9351
9351
|
* "IpProtocol":"TCP,"
|
|
9352
9352
|
* "PortRange":"80/80",
|
|
9353
9353
|
* "Policy":"accept"
|
|
9354
9354
|
* ]
|
|
9355
9355
|
* }
|
|
9356
9356
|
* ```
|
|
9357
|
-
* - Delete
|
|
9358
|
-
* <!---->
|
|
9357
|
+
* - Delete by specifying a prefix list.
|
|
9359
9358
|
* ```
|
|
9360
9359
|
* "SecurityGroupId":"sg-bp67acfmxazb4p****",
|
|
9361
9360
|
* "Permissions":[
|
|
9362
9361
|
* {
|
|
9363
|
-
* "SourcePrefixListId":pl-x1j1k5ykzqlixdcy****", //Specify the
|
|
9362
|
+
* "SourcePrefixListId":pl-x1j1k5ykzqlixdcy****", // Specify the source prefix list ID.
|
|
9364
9363
|
* "IpProtocol":"TCP",
|
|
9365
9364
|
* "PortRange":"80/80",
|
|
9366
9365
|
* "Policy":"accept"
|
|
@@ -9374,61 +9373,57 @@ export default class Client extends OpenApi {
|
|
|
9374
9373
|
*/
|
|
9375
9374
|
revokeSecurityGroupWithOptions(request: $_model.RevokeSecurityGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RevokeSecurityGroupResponse>;
|
|
9376
9375
|
/**
|
|
9377
|
-
* Deletes inbound security group rules from a
|
|
9378
|
-
*
|
|
9379
|
-
* @remarks
|
|
9380
|
-
* > Alibaba Cloud
|
|
9381
|
-
* You can use one of the following
|
|
9382
|
-
* -
|
|
9383
|
-
*
|
|
9384
|
-
* -
|
|
9385
|
-
*
|
|
9386
|
-
*
|
|
9387
|
-
*
|
|
9388
|
-
*
|
|
9389
|
-
*
|
|
9390
|
-
*
|
|
9391
|
-
* > You cannot specify
|
|
9392
|
-
* ###
|
|
9393
|
-
* - Delete
|
|
9394
|
-
* <!---->
|
|
9376
|
+
* Deletes one or more inbound security group rules from a specified security group.
|
|
9377
|
+
*
|
|
9378
|
+
* @remarks
|
|
9379
|
+
* >Notice: Starting July 8, 2024, Alibaba Cloud adjusted the validation rules for this operation. When you attempt to delete a security group rule that does not exist, the operation now returns the error code "InvalidParam.SecurityGroupRuleId" instead of a success response. Update your error code handling to be compatible accordingly to avoid impact on your production workloads.
|
|
9380
|
+
* You can use one of the following methods to pass parameters to delete rules:
|
|
9381
|
+
* - Specify security group rule IDs to delete rules (recommended).
|
|
9382
|
+
* - If a specified security group rule ID does not exist, the API invocation fails.
|
|
9383
|
+
* - Specify Permissions to delete rules.
|
|
9384
|
+
* - If no matching security group rule exists, the invocation succeeds but no rule is deleted.
|
|
9385
|
+
* - The following parameters are required to identify an inbound rule:
|
|
9386
|
+
* - Source settings: Set one of SourceCidrIp (IPv4 address), Ipv6SourceCidrIp (IPv6 address), SourcePrefixListId (prefix list ID), or SourceGroupId (source security group).
|
|
9387
|
+
* - Destination port range: PortRange.
|
|
9388
|
+
* - Protocol type: IpProtocol.
|
|
9389
|
+
* - Access policy: Policy.
|
|
9390
|
+
* > You cannot specify both security group rule IDs and Permissions at the same time.
|
|
9391
|
+
* ### Request examples
|
|
9392
|
+
* - Delete by specifying security group rule IDs.
|
|
9395
9393
|
* ```
|
|
9396
|
-
* "SecurityGroupId":"sg-bp67acfmxazb4p****", //Specify the
|
|
9397
|
-
* "SecurityGroupRuleId":["sgr-bpdfmk****","sgr-bpdfmg****"] //Specify the
|
|
9394
|
+
* "SecurityGroupId":"sg-bp67acfmxazb4p****", // Specify the security group ID.
|
|
9395
|
+
* "SecurityGroupRuleId":["sgr-bpdfmk****","sgr-bpdfmg****"] // Specify the security group rule IDs.
|
|
9398
9396
|
* ```
|
|
9399
|
-
* - Delete
|
|
9400
|
-
* <!---->
|
|
9397
|
+
* - Delete by specifying an IP address range.
|
|
9401
9398
|
* ```
|
|
9402
9399
|
* "SecurityGroupId":"sg-bp67acfmxazb4p****",
|
|
9403
9400
|
* "Permissions":[
|
|
9404
9401
|
* {
|
|
9405
|
-
* "SourceCidrIp":"10.0.0.0/8", //Specify the source
|
|
9406
|
-
* "IpProtocol":"TCP", //Specify the protocol.
|
|
9407
|
-
* "PortRange":"80/80", //Specify the destination port range.
|
|
9408
|
-
* "Policy":"accept" //Specify the
|
|
9402
|
+
* "SourceCidrIp":"10.0.0.0/8", // Specify the source IP address range.
|
|
9403
|
+
* "IpProtocol":"TCP", // Specify the protocol type.
|
|
9404
|
+
* "PortRange":"80/80", // Specify the destination port range.
|
|
9405
|
+
* "Policy":"accept" // Specify the access policy.
|
|
9409
9406
|
* }
|
|
9410
9407
|
* ]
|
|
9411
9408
|
* ```
|
|
9412
|
-
* - Delete
|
|
9413
|
-
* <!---->
|
|
9409
|
+
* - Delete by specifying another security group.
|
|
9414
9410
|
* ```
|
|
9415
9411
|
* "SecurityGroupId":"sg-bp67acfmxazb4p****",
|
|
9416
9412
|
* "Permissions":[
|
|
9417
9413
|
* {
|
|
9418
|
-
* "SourceGroupId":"sg-bp67acfmxa123b****", //Specify the
|
|
9414
|
+
* "SourceGroupId":"sg-bp67acfmxa123b****", // Specify the source security group ID.
|
|
9419
9415
|
* "IpProtocol":"TCP,"
|
|
9420
9416
|
* "PortRange":"80/80",
|
|
9421
9417
|
* "Policy":"accept"
|
|
9422
9418
|
* ]
|
|
9423
9419
|
* }
|
|
9424
9420
|
* ```
|
|
9425
|
-
* - Delete
|
|
9426
|
-
* <!---->
|
|
9421
|
+
* - Delete by specifying a prefix list.
|
|
9427
9422
|
* ```
|
|
9428
9423
|
* "SecurityGroupId":"sg-bp67acfmxazb4p****",
|
|
9429
9424
|
* "Permissions":[
|
|
9430
9425
|
* {
|
|
9431
|
-
* "SourcePrefixListId":pl-x1j1k5ykzqlixdcy****", //Specify the
|
|
9426
|
+
* "SourcePrefixListId":pl-x1j1k5ykzqlixdcy****", // Specify the source prefix list ID.
|
|
9432
9427
|
* "IpProtocol":"TCP",
|
|
9433
9428
|
* "PortRange":"80/80",
|
|
9434
9429
|
* "Policy":"accept"
|
|
@@ -9444,14 +9439,14 @@ export default class Client extends OpenApi {
|
|
|
9444
9439
|
* Deletes one or more outbound security group rules from a specified security group.
|
|
9445
9440
|
*
|
|
9446
9441
|
* @remarks
|
|
9447
|
-
* >Notice:
|
|
9442
|
+
* >Notice: Alibaba Cloud adjusted the validation rules for this operation on July 8, 2024. When you attempt to delete a security group rule that does not exist, the operation now returns the error code "InvalidSecurityGroupRule.RuleNotExist" instead of a success response. Update your error code handling to be compatible with this change to avoid impacts on your production workloads.
|
|
9448
9443
|
* You can use one of the following methods to pass parameters to delete security group rules:
|
|
9449
9444
|
* - Delete rules by specifying security group rule IDs (recommended).
|
|
9450
|
-
* - If
|
|
9445
|
+
* - If a specified security group rule ID does not exist, a fault is returned.
|
|
9451
9446
|
* - Delete rules by specifying the Permissions parameter.
|
|
9452
|
-
* - If
|
|
9447
|
+
* - If no matching security group rule exists, the invocation succeeds but no rule is deleted.
|
|
9453
9448
|
* - The following parameters are required to delete a security group rule:
|
|
9454
|
-
* - Destination
|
|
9449
|
+
* - Destination: Specify one of DestCidrIp (IPv4 address), Ipv6DestCidrIp (IPv6 address), DestPrefixListId (prefix list ID), or DestGroupId (destination security group).
|
|
9455
9450
|
* - Destination port range: PortRange.
|
|
9456
9451
|
* - Protocol type: IpProtocol.
|
|
9457
9452
|
* - Access policy: Policy.
|
|
@@ -9462,15 +9457,15 @@ export default class Client extends OpenApi {
|
|
|
9462
9457
|
* "SecurityGroupId":"sg-bp67acfmxazb4p****", // Specify the security group ID.
|
|
9463
9458
|
* "SecurityGroupRuleId":["sgr-bpdfmk****","sgr-bpdfmg****"] // Specify the security group rule IDs.
|
|
9464
9459
|
* ```
|
|
9465
|
-
* - Delete by IP
|
|
9460
|
+
* - Delete by IP CIDR block.
|
|
9466
9461
|
* ```
|
|
9467
9462
|
* "SecurityGroupId":"sg-bp67acfmxazb4ph***",
|
|
9468
9463
|
* "Permissions":[
|
|
9469
9464
|
* {
|
|
9470
9465
|
* "IpProtocol":"TCP", // Specify the protocol type.
|
|
9471
|
-
* "DestCidrIp":"10.0.0.0/8", // Specify the destination IP
|
|
9466
|
+
* "DestCidrIp":"10.0.0.0/8", // Specify the destination IP CIDR block.
|
|
9472
9467
|
* "PortRange":"22/22", // Specify the destination port range.
|
|
9473
|
-
* "Policy":"accept" // Specify the
|
|
9468
|
+
* "Policy":"accept" // Specify the authorization policy.
|
|
9474
9469
|
* }
|
|
9475
9470
|
* ]
|
|
9476
9471
|
* ```
|
|
@@ -9498,7 +9493,7 @@ export default class Client extends OpenApi {
|
|
|
9498
9493
|
* "Policy":"accept",
|
|
9499
9494
|
* }
|
|
9500
9495
|
* ]
|
|
9501
|
-
*
|
|
9496
|
+
* ```
|
|
9502
9497
|
*
|
|
9503
9498
|
* @param request - RevokeSecurityGroupEgressRequest
|
|
9504
9499
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9509,14 +9504,14 @@ export default class Client extends OpenApi {
|
|
|
9509
9504
|
* Deletes one or more outbound security group rules from a specified security group.
|
|
9510
9505
|
*
|
|
9511
9506
|
* @remarks
|
|
9512
|
-
* >Notice:
|
|
9507
|
+
* >Notice: Alibaba Cloud adjusted the validation rules for this operation on July 8, 2024. When you attempt to delete a security group rule that does not exist, the operation now returns the error code "InvalidSecurityGroupRule.RuleNotExist" instead of a success response. Update your error code handling to be compatible with this change to avoid impacts on your production workloads.
|
|
9513
9508
|
* You can use one of the following methods to pass parameters to delete security group rules:
|
|
9514
9509
|
* - Delete rules by specifying security group rule IDs (recommended).
|
|
9515
|
-
* - If
|
|
9510
|
+
* - If a specified security group rule ID does not exist, a fault is returned.
|
|
9516
9511
|
* - Delete rules by specifying the Permissions parameter.
|
|
9517
|
-
* - If
|
|
9512
|
+
* - If no matching security group rule exists, the invocation succeeds but no rule is deleted.
|
|
9518
9513
|
* - The following parameters are required to delete a security group rule:
|
|
9519
|
-
* - Destination
|
|
9514
|
+
* - Destination: Specify one of DestCidrIp (IPv4 address), Ipv6DestCidrIp (IPv6 address), DestPrefixListId (prefix list ID), or DestGroupId (destination security group).
|
|
9520
9515
|
* - Destination port range: PortRange.
|
|
9521
9516
|
* - Protocol type: IpProtocol.
|
|
9522
9517
|
* - Access policy: Policy.
|
|
@@ -9527,15 +9522,15 @@ export default class Client extends OpenApi {
|
|
|
9527
9522
|
* "SecurityGroupId":"sg-bp67acfmxazb4p****", // Specify the security group ID.
|
|
9528
9523
|
* "SecurityGroupRuleId":["sgr-bpdfmk****","sgr-bpdfmg****"] // Specify the security group rule IDs.
|
|
9529
9524
|
* ```
|
|
9530
|
-
* - Delete by IP
|
|
9525
|
+
* - Delete by IP CIDR block.
|
|
9531
9526
|
* ```
|
|
9532
9527
|
* "SecurityGroupId":"sg-bp67acfmxazb4ph***",
|
|
9533
9528
|
* "Permissions":[
|
|
9534
9529
|
* {
|
|
9535
9530
|
* "IpProtocol":"TCP", // Specify the protocol type.
|
|
9536
|
-
* "DestCidrIp":"10.0.0.0/8", // Specify the destination IP
|
|
9531
|
+
* "DestCidrIp":"10.0.0.0/8", // Specify the destination IP CIDR block.
|
|
9537
9532
|
* "PortRange":"22/22", // Specify the destination port range.
|
|
9538
|
-
* "Policy":"accept" // Specify the
|
|
9533
|
+
* "Policy":"accept" // Specify the authorization policy.
|
|
9539
9534
|
* }
|
|
9540
9535
|
* ]
|
|
9541
9536
|
* ```
|
|
@@ -9563,7 +9558,7 @@ export default class Client extends OpenApi {
|
|
|
9563
9558
|
* "Policy":"accept",
|
|
9564
9559
|
* }
|
|
9565
9560
|
* ]
|
|
9566
|
-
*
|
|
9561
|
+
* ```
|
|
9567
9562
|
*
|
|
9568
9563
|
* @param request - RevokeSecurityGroupEgressRequest
|
|
9569
9564
|
* @returns RevokeSecurityGroupEgressResponse
|
|
@@ -9986,22 +9981,22 @@ export default class Client extends OpenApi {
|
|
|
9986
9981
|
*/
|
|
9987
9982
|
startInstances(request: $_model.StartInstancesRequest): Promise<$_model.StartInstancesResponse>;
|
|
9988
9983
|
/**
|
|
9989
|
-
*
|
|
9984
|
+
* Invokes StartTerminalSession to create a session based on the session management feature. You can establish a WebSocket session with an ECS instance by specifying the instance ID. The WebSocketUrl returned by this operation can be used to establish a remote connection to the ECS instance.
|
|
9990
9985
|
*
|
|
9991
9986
|
* @remarks
|
|
9992
|
-
* ##
|
|
9993
|
-
* When you customize a remote connection client
|
|
9994
|
-
* - The specified ECS instance must be in the
|
|
9995
|
-
* -
|
|
9996
|
-
*
|
|
9997
|
-
*
|
|
9998
|
-
*
|
|
9999
|
-
*
|
|
10000
|
-
* - After
|
|
10001
|
-
* -
|
|
10002
|
-
* -
|
|
10003
|
-
* - The port forwarding feature
|
|
10004
|
-
* - To permanently
|
|
9987
|
+
* ## Operation description
|
|
9988
|
+
* When you customize a remote connection client by using code, you can invoke this operation to obtain the WebSocketUrl for establishing a remote connection to an ECS instance. Take note of the following items:
|
|
9989
|
+
* - The specified ECS instance must be in the Running state.
|
|
9990
|
+
* - Cloud Assistant Agent must be installed on the specified ECS instance. You can invoke [DescribeCloudAssistantStatus](https://help.aliyun.com/document_detail/87346.html) to check whether Cloud Assistant Agent is installed on the ECS instance and query the version number of Cloud Assistant Agent.
|
|
9991
|
+
* - If Cloud Assistant Agent is not installed on the ECS instance, invoke [InstallCloudAssistant](https://help.aliyun.com/document_detail/85916.html) to install it.
|
|
9992
|
+
* - The version number of Cloud Assistant Agent must be later than the following versions to support the session management feature. To upgrade Cloud Assistant Agent, see [Update or disable updates for Cloud Assistant Agent](https://help.aliyun.com/document_detail/134383.html).
|
|
9993
|
+
* - Linux operating system: 2.2.3.256
|
|
9994
|
+
* - Windows operating system: 2.1.3.256
|
|
9995
|
+
* - After this operation is invoked, the WebSocketUrl is valid for 10 minutes.
|
|
9996
|
+
* - After a session is established, Cloud Assistant closes the connection if no data is transmitted for 3 minutes.
|
|
9997
|
+
* - In a single region, a maximum of 100 sessions can be created and active. A maximum of 20 sessions can be in the connected state for a single ECS instance. The bandwidth limit for a single session is 200 KB/s.
|
|
9998
|
+
* - The port forwarding feature supports only TCP port forwarding. UDP is not supported.
|
|
9999
|
+
* - To permanently shutdown a session and invalidate the WebSocketUrl, invoke the EndTerminalSession operation.
|
|
10005
10000
|
*
|
|
10006
10001
|
* @param tmpReq - StartTerminalSessionRequest
|
|
10007
10002
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -10009,35 +10004,35 @@ export default class Client extends OpenApi {
|
|
|
10009
10004
|
*/
|
|
10010
10005
|
startTerminalSessionWithOptions(tmpReq: $_model.StartTerminalSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StartTerminalSessionResponse>;
|
|
10011
10006
|
/**
|
|
10012
|
-
*
|
|
10007
|
+
* Invokes StartTerminalSession to create a session based on the session management feature. You can establish a WebSocket session with an ECS instance by specifying the instance ID. The WebSocketUrl returned by this operation can be used to establish a remote connection to the ECS instance.
|
|
10013
10008
|
*
|
|
10014
10009
|
* @remarks
|
|
10015
|
-
* ##
|
|
10016
|
-
* When you customize a remote connection client
|
|
10017
|
-
* - The specified ECS instance must be in the
|
|
10018
|
-
* -
|
|
10019
|
-
*
|
|
10020
|
-
*
|
|
10021
|
-
*
|
|
10022
|
-
*
|
|
10023
|
-
* - After
|
|
10024
|
-
* -
|
|
10025
|
-
* -
|
|
10026
|
-
* - The port forwarding feature
|
|
10027
|
-
* - To permanently
|
|
10010
|
+
* ## Operation description
|
|
10011
|
+
* When you customize a remote connection client by using code, you can invoke this operation to obtain the WebSocketUrl for establishing a remote connection to an ECS instance. Take note of the following items:
|
|
10012
|
+
* - The specified ECS instance must be in the Running state.
|
|
10013
|
+
* - Cloud Assistant Agent must be installed on the specified ECS instance. You can invoke [DescribeCloudAssistantStatus](https://help.aliyun.com/document_detail/87346.html) to check whether Cloud Assistant Agent is installed on the ECS instance and query the version number of Cloud Assistant Agent.
|
|
10014
|
+
* - If Cloud Assistant Agent is not installed on the ECS instance, invoke [InstallCloudAssistant](https://help.aliyun.com/document_detail/85916.html) to install it.
|
|
10015
|
+
* - The version number of Cloud Assistant Agent must be later than the following versions to support the session management feature. To upgrade Cloud Assistant Agent, see [Update or disable updates for Cloud Assistant Agent](https://help.aliyun.com/document_detail/134383.html).
|
|
10016
|
+
* - Linux operating system: 2.2.3.256
|
|
10017
|
+
* - Windows operating system: 2.1.3.256
|
|
10018
|
+
* - After this operation is invoked, the WebSocketUrl is valid for 10 minutes.
|
|
10019
|
+
* - After a session is established, Cloud Assistant closes the connection if no data is transmitted for 3 minutes.
|
|
10020
|
+
* - In a single region, a maximum of 100 sessions can be created and active. A maximum of 20 sessions can be in the connected state for a single ECS instance. The bandwidth limit for a single session is 200 KB/s.
|
|
10021
|
+
* - The port forwarding feature supports only TCP port forwarding. UDP is not supported.
|
|
10022
|
+
* - To permanently shutdown a session and invalidate the WebSocketUrl, invoke the EndTerminalSession operation.
|
|
10028
10023
|
*
|
|
10029
10024
|
* @param request - StartTerminalSessionRequest
|
|
10030
10025
|
* @returns StartTerminalSessionResponse
|
|
10031
10026
|
*/
|
|
10032
10027
|
startTerminalSession(request: $_model.StartTerminalSessionRequest): Promise<$_model.StartTerminalSessionResponse>;
|
|
10033
10028
|
/**
|
|
10034
|
-
* Stops an Elastic Compute Service (ECS) instance. You can specify
|
|
10029
|
+
* Stops an Elastic Compute Service (ECS) instance. You can specify different stop strategies, stop modes, and batch operation modes to stop the ECS instance.
|
|
10035
10030
|
*
|
|
10036
10031
|
* @remarks
|
|
10037
|
-
*
|
|
10038
|
-
* ###
|
|
10039
|
-
* -
|
|
10040
|
-
* -
|
|
10032
|
+
* This is an asynchronous operation. The ECS instance is not stopped immediately after a successful invocation. The ECS instance first enters the Stopping state. You can invoke [DescribeInstanceStatus](https://help.aliyun.com/document_detail/2679688.html) to query the instance status. When the returned status is `Stopped`, the ECS instance is stopped.
|
|
10033
|
+
* ### Before you begin
|
|
10034
|
+
* - ECS instances that are locked for security reasons cannot be stopped by invoking this operation. For more information, see [Impact of resource security locks on API calls](https://help.aliyun.com/document_detail/25695.html).
|
|
10035
|
+
* - After you enable the economical mode for VPC-connected instances, you can set `StoppedMode=KeepCharging` to enable the standard stop mode. The ECS instance continues billing after it is stopped, and the ECS instance type inventory and Internet IP address are retained.
|
|
10041
10036
|
*
|
|
10042
10037
|
* @param request - StopInstanceRequest
|
|
10043
10038
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -10045,26 +10040,26 @@ export default class Client extends OpenApi {
|
|
|
10045
10040
|
*/
|
|
10046
10041
|
stopInstanceWithOptions(request: $_model.StopInstanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StopInstanceResponse>;
|
|
10047
10042
|
/**
|
|
10048
|
-
* Stops an Elastic Compute Service (ECS) instance. You can specify
|
|
10043
|
+
* Stops an Elastic Compute Service (ECS) instance. You can specify different stop strategies, stop modes, and batch operation modes to stop the ECS instance.
|
|
10049
10044
|
*
|
|
10050
10045
|
* @remarks
|
|
10051
|
-
*
|
|
10052
|
-
* ###
|
|
10053
|
-
* -
|
|
10054
|
-
* -
|
|
10046
|
+
* This is an asynchronous operation. The ECS instance is not stopped immediately after a successful invocation. The ECS instance first enters the Stopping state. You can invoke [DescribeInstanceStatus](https://help.aliyun.com/document_detail/2679688.html) to query the instance status. When the returned status is `Stopped`, the ECS instance is stopped.
|
|
10047
|
+
* ### Before you begin
|
|
10048
|
+
* - ECS instances that are locked for security reasons cannot be stopped by invoking this operation. For more information, see [Impact of resource security locks on API calls](https://help.aliyun.com/document_detail/25695.html).
|
|
10049
|
+
* - After you enable the economical mode for VPC-connected instances, you can set `StoppedMode=KeepCharging` to enable the standard stop mode. The ECS instance continues billing after it is stopped, and the ECS instance type inventory and Internet IP address are retained.
|
|
10055
10050
|
*
|
|
10056
10051
|
* @param request - StopInstanceRequest
|
|
10057
10052
|
* @returns StopInstanceResponse
|
|
10058
10053
|
*/
|
|
10059
10054
|
stopInstance(request: $_model.StopInstanceRequest): Promise<$_model.StopInstanceResponse>;
|
|
10060
10055
|
/**
|
|
10061
|
-
* Stops
|
|
10056
|
+
* Stops one or more ECS instances. You can specify the stop method, stop mode, and batch operation mode.
|
|
10062
10057
|
*
|
|
10063
10058
|
* @remarks
|
|
10064
|
-
*
|
|
10065
|
-
* ###
|
|
10066
|
-
* -
|
|
10067
|
-
* -
|
|
10059
|
+
* This is an asynchronous operation. After a successful call, the instance enters the Stopping state. Call [DescribeInstanceStatus](https://help.aliyun.com/document_detail/2679688.html) to query the instance status. When the returned status is `Stopped`, the instance is stopped.
|
|
10060
|
+
* ### Before you begin
|
|
10061
|
+
* - After an instance is stopped, it becomes unavailable. Make sure that stopping the instance does not affect your business. Call [StartInstance](https://help.aliyun.com/document_detail/2679679.html) or [StartInstances](https://help.aliyun.com/document_detail/2679680.html) to start the instance.
|
|
10062
|
+
* - Instances that are locked for security reasons cannot be stopped by calling this operation. For more information, see [Impacts of resource security locks on API calls](https://help.aliyun.com/document_detail/25695.html).
|
|
10068
10063
|
*
|
|
10069
10064
|
* @param request - StopInstancesRequest
|
|
10070
10065
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -10072,13 +10067,13 @@ export default class Client extends OpenApi {
|
|
|
10072
10067
|
*/
|
|
10073
10068
|
stopInstancesWithOptions(request: $_model.StopInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StopInstancesResponse>;
|
|
10074
10069
|
/**
|
|
10075
|
-
* Stops
|
|
10070
|
+
* Stops one or more ECS instances. You can specify the stop method, stop mode, and batch operation mode.
|
|
10076
10071
|
*
|
|
10077
10072
|
* @remarks
|
|
10078
|
-
*
|
|
10079
|
-
* ###
|
|
10080
|
-
* -
|
|
10081
|
-
* -
|
|
10073
|
+
* This is an asynchronous operation. After a successful call, the instance enters the Stopping state. Call [DescribeInstanceStatus](https://help.aliyun.com/document_detail/2679688.html) to query the instance status. When the returned status is `Stopped`, the instance is stopped.
|
|
10074
|
+
* ### Before you begin
|
|
10075
|
+
* - After an instance is stopped, it becomes unavailable. Make sure that stopping the instance does not affect your business. Call [StartInstance](https://help.aliyun.com/document_detail/2679679.html) or [StartInstances](https://help.aliyun.com/document_detail/2679680.html) to start the instance.
|
|
10076
|
+
* - Instances that are locked for security reasons cannot be stopped by calling this operation. For more information, see [Impacts of resource security locks on API calls](https://help.aliyun.com/document_detail/25695.html).
|
|
10082
10077
|
*
|
|
10083
10078
|
* @param request - StopInstancesRequest
|
|
10084
10079
|
* @returns StopInstancesResponse
|
|
@@ -10178,8 +10173,8 @@ export default class Client extends OpenApi {
|
|
|
10178
10173
|
* @remarks
|
|
10179
10174
|
* ## Operation description
|
|
10180
10175
|
* When you invoke this operation, take note of the following items:
|
|
10181
|
-
* - The Elastic Network Interface (ENI) must be in the **Active**
|
|
10182
|
-
* - If you are operating on a primary
|
|
10176
|
+
* - The Elastic Network Interface (ENI) must be in the **Active** or **InUse** state.
|
|
10177
|
+
* - If you are operating on a primary network interface controller (NIC), the ECS instance to which the NIC is attached must be in the **Running** or **Stopped** state.
|
|
10183
10178
|
*
|
|
10184
10179
|
* @param request - UnassignIpv6AddressesRequest
|
|
10185
10180
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -10192,8 +10187,8 @@ export default class Client extends OpenApi {
|
|
|
10192
10187
|
* @remarks
|
|
10193
10188
|
* ## Operation description
|
|
10194
10189
|
* When you invoke this operation, take note of the following items:
|
|
10195
|
-
* - The Elastic Network Interface (ENI) must be in the **Active**
|
|
10196
|
-
* - If you are operating on a primary
|
|
10190
|
+
* - The Elastic Network Interface (ENI) must be in the **Active** or **InUse** state.
|
|
10191
|
+
* - If you are operating on a primary network interface controller (NIC), the ECS instance to which the NIC is attached must be in the **Running** or **Stopped** state.
|
|
10197
10192
|
*
|
|
10198
10193
|
* @param request - UnassignIpv6AddressesRequest
|
|
10199
10194
|
* @returns UnassignIpv6AddressesResponse
|