@alicloud/ecs20140526 7.9.0 → 7.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +302 -298
- package/dist/client.js +305 -298
- package/dist/client.js.map +1 -1
- package/dist/models/AttachDiskRequest.d.ts +25 -27
- package/dist/models/AttachDiskRequest.js.map +1 -1
- package/dist/models/CancelAutoSnapshotPolicyRequest.d.ts +6 -9
- package/dist/models/CancelAutoSnapshotPolicyRequest.js.map +1 -1
- package/dist/models/CancelImagePipelineExecutionRequest.d.ts +1 -1
- 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/CopySnapshotRequest.d.ts +17 -18
- package/dist/models/CopySnapshotRequest.js.map +1 -1
- 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/CreateAutoSnapshotPolicyRequest.d.ts +29 -35
- package/dist/models/CreateAutoSnapshotPolicyRequest.js.map +1 -1
- package/dist/models/CreateAutoSnapshotPolicyResponseBody.d.ts +1 -1
- package/dist/models/CreateDiskRequest.d.ts +30 -30
- package/dist/models/CreateDiskResponseBody.d.ts +2 -2
- 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/CreateLaunchTemplateRequest.d.ts +235 -278
- package/dist/models/CreateLaunchTemplateRequest.js.map +1 -1
- package/dist/models/CreateLaunchTemplateResponseBody.d.ts +3 -3
- package/dist/models/CreateSnapshotGroupRequest.d.ts +23 -25
- package/dist/models/CreateSnapshotGroupRequest.js.map +1 -1
- package/dist/models/CreateSnapshotRequest.d.ts +24 -29
- package/dist/models/CreateSnapshotRequest.js.map +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/DeleteSnapshotGroupRequest.d.ts +2 -2
- package/dist/models/DeleteSnapshotGroupResponseBody.d.ts +1 -1
- package/dist/models/DeleteSnapshotRequest.d.ts +2 -2
- package/dist/models/DescribeDiskDefaultKmskeyIdRequest.d.ts +1 -1
- package/dist/models/DescribeDiskDefaultKmskeyIdResponseBody.d.ts +1 -1
- package/dist/models/DescribeDiskEncryptionByDefaultStatusRequest.d.ts +1 -1
- package/dist/models/DescribeDiskEncryptionByDefaultStatusResponseBody.d.ts +5 -3
- package/dist/models/DescribeDiskEncryptionByDefaultStatusResponseBody.js.map +1 -1
- package/dist/models/DescribeImagesRequest.d.ts +61 -88
- package/dist/models/DescribeImagesRequest.js +2 -0
- package/dist/models/DescribeImagesRequest.js.map +1 -1
- package/dist/models/DescribeImagesResponseBody.d.ts +6 -5
- package/dist/models/DescribeImagesResponseBody.js +2 -0
- package/dist/models/DescribeImagesResponseBody.js.map +1 -1
- package/dist/models/DescribeRecommendInstanceTypeRequest.d.ts +4 -4
- package/dist/models/DescribeSendFileResultsRequest.d.ts +13 -13
- package/dist/models/DescribeSnapshotGroupsRequest.d.ts +11 -11
- package/dist/models/DescribeSnapshotGroupsResponseBody.d.ts +3 -3
- package/dist/models/DisableDiskEncryptionByDefaultRequest.d.ts +1 -1
- package/dist/models/RenewElasticityAssurancesRequest.d.ts +3 -3
- package/package.json +1 -1
- package/src/client.ts +306 -298
- package/src/models/AttachDiskRequest.ts +25 -27
- package/src/models/CancelAutoSnapshotPolicyRequest.ts +6 -9
- package/src/models/CancelImagePipelineExecutionRequest.ts +1 -1
- package/src/models/CloneDisksRequest.ts +55 -80
- package/src/models/CloneDisksResponseBody.ts +2 -2
- package/src/models/CopySnapshotRequest.ts +17 -18
- package/src/models/CreateAutoProvisioningGroupRequest.ts +287 -381
- package/src/models/CreateAutoProvisioningGroupShrinkRequest.ts +283 -376
- package/src/models/CreateAutoSnapshotPolicyRequest.ts +29 -35
- package/src/models/CreateAutoSnapshotPolicyResponseBody.ts +1 -1
- package/src/models/CreateDiskRequest.ts +30 -30
- package/src/models/CreateDiskResponseBody.ts +2 -2
- package/src/models/CreateImageRequest.ts +43 -88
- package/src/models/CreateImageResponseBody.ts +2 -2
- package/src/models/CreateLaunchTemplateRequest.ts +235 -278
- package/src/models/CreateLaunchTemplateResponseBody.ts +3 -3
- package/src/models/CreateSnapshotGroupRequest.ts +23 -25
- package/src/models/CreateSnapshotRequest.ts +24 -29
- package/src/models/CreateVswitchRequest.ts +0 -29
- package/src/models/CreateVswitchResponseBody.ts +0 -8
- package/src/models/DeleteSnapshotGroupRequest.ts +2 -2
- package/src/models/DeleteSnapshotGroupResponseBody.ts +1 -1
- package/src/models/DeleteSnapshotRequest.ts +2 -2
- package/src/models/DescribeDiskDefaultKmskeyIdRequest.ts +1 -1
- package/src/models/DescribeDiskDefaultKmskeyIdResponseBody.ts +1 -1
- package/src/models/DescribeDiskEncryptionByDefaultStatusRequest.ts +1 -1
- package/src/models/DescribeDiskEncryptionByDefaultStatusResponseBody.ts +5 -3
- package/src/models/DescribeImagesRequest.ts +64 -89
- package/src/models/DescribeImagesResponseBody.ts +8 -5
- package/src/models/DescribeRecommendInstanceTypeRequest.ts +4 -4
- package/src/models/DescribeSendFileResultsRequest.ts +13 -13
- package/src/models/DescribeSnapshotGroupsRequest.ts +11 -11
- package/src/models/DescribeSnapshotGroupsResponseBody.ts +3 -3
- package/src/models/DisableDiskEncryptionByDefaultRequest.ts +1 -1
- package/src/models/RenewElasticityAssurancesRequest.ts +3 -3
package/dist/client.d.ts
CHANGED
|
@@ -342,24 +342,27 @@ export default class Client extends OpenApi {
|
|
|
342
342
|
*/
|
|
343
343
|
attachClassicLinkVpc(request: $_model.AttachClassicLinkVpcRequest): Promise<$_model.AttachClassicLinkVpcResponse>;
|
|
344
344
|
/**
|
|
345
|
-
* Attaches a
|
|
345
|
+
* Attaches a data disk or system disk to an ECS instance.
|
|
346
346
|
*
|
|
347
347
|
* @remarks
|
|
348
|
-
*
|
|
349
|
-
* - The
|
|
350
|
-
* - The disk must be in the **
|
|
351
|
-
* - When you attach
|
|
352
|
-
*
|
|
353
|
-
*
|
|
354
|
-
*
|
|
355
|
-
*
|
|
356
|
-
* - When you attach
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
*
|
|
362
|
-
* -
|
|
348
|
+
* When you call this operation, take note of the following items:
|
|
349
|
+
* - The instance and the disk must be in the same zone.
|
|
350
|
+
* - The disk must be in the **Available** (`Available`) state.
|
|
351
|
+
* - When you attach a data disk:
|
|
352
|
+
* - The destination ECS instance must be in the **Running** (`Running`) or **Stopped** (`Stopped`) state.
|
|
353
|
+
* - If the disk is separately purchased, the billing method must be pay-as-you-go.
|
|
354
|
+
* - A system disk that was uninstalled from an ECS instance can be attached as a data disk without billable methods restrictions.
|
|
355
|
+
* - An elastic ephemeral disk that has been detached can only be re-attached to its original instance.
|
|
356
|
+
* - When you attach a system disk:
|
|
357
|
+
* - The destination ECS instance must be the original instance from which the system disk was detached.
|
|
358
|
+
* - The destination ECS instance must be in the **Stopped** (`Stopped`) state.
|
|
359
|
+
* - You must specify the logon credential for the instance.
|
|
360
|
+
* - Elastic ephemeral disks cannot be attached as system disks.
|
|
361
|
+
* - For more information about attaching system disks, see [Detach or attach a system disk](https://help.aliyun.com/document_detail/146752.html).
|
|
362
|
+
* - When you query ECS instance information, if the response contains `{"OperationLocks": {"LockReason" : "security"}}`, all operations are prohibited.
|
|
363
|
+
* <props="china">
|
|
364
|
+
* - A disk with the multi-attach attribute enabled can only be attached to instances that support the NVMe protocol.
|
|
365
|
+
* For more information, see [Standard SSDs 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).
|
|
363
366
|
*
|
|
364
367
|
* @param request - AttachDiskRequest
|
|
365
368
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -367,24 +370,27 @@ export default class Client extends OpenApi {
|
|
|
367
370
|
*/
|
|
368
371
|
attachDiskWithOptions(request: $_model.AttachDiskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AttachDiskResponse>;
|
|
369
372
|
/**
|
|
370
|
-
* Attaches a
|
|
373
|
+
* Attaches a data disk or system disk to an ECS instance.
|
|
371
374
|
*
|
|
372
375
|
* @remarks
|
|
373
|
-
*
|
|
374
|
-
* - The
|
|
375
|
-
* - The disk must be in the **
|
|
376
|
-
* - When you attach
|
|
377
|
-
*
|
|
378
|
-
*
|
|
379
|
-
*
|
|
380
|
-
*
|
|
381
|
-
* - When you attach
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
-
*
|
|
385
|
-
*
|
|
386
|
-
*
|
|
387
|
-
* -
|
|
376
|
+
* When you call this operation, take note of the following items:
|
|
377
|
+
* - The instance and the disk must be in the same zone.
|
|
378
|
+
* - The disk must be in the **Available** (`Available`) state.
|
|
379
|
+
* - When you attach a data disk:
|
|
380
|
+
* - The destination ECS instance must be in the **Running** (`Running`) or **Stopped** (`Stopped`) state.
|
|
381
|
+
* - If the disk is separately purchased, the billing method must be pay-as-you-go.
|
|
382
|
+
* - A system disk that was uninstalled from an ECS instance can be attached as a data disk without billable methods restrictions.
|
|
383
|
+
* - An elastic ephemeral disk that has been detached can only be re-attached to its original instance.
|
|
384
|
+
* - When you attach a system disk:
|
|
385
|
+
* - The destination ECS instance must be the original instance from which the system disk was detached.
|
|
386
|
+
* - The destination ECS instance must be in the **Stopped** (`Stopped`) state.
|
|
387
|
+
* - You must specify the logon credential for the instance.
|
|
388
|
+
* - Elastic ephemeral disks cannot be attached as system disks.
|
|
389
|
+
* - For more information about attaching system disks, see [Detach or attach a system disk](https://help.aliyun.com/document_detail/146752.html).
|
|
390
|
+
* - When you query ECS instance information, if the response contains `{"OperationLocks": {"LockReason" : "security"}}`, all operations are prohibited.
|
|
391
|
+
* <props="china">
|
|
392
|
+
* - A disk with the multi-attach attribute enabled can only be attached to instances that support the NVMe protocol.
|
|
393
|
+
* For more information, see [Standard SSDs 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).
|
|
388
394
|
*
|
|
389
395
|
* @param request - AttachDiskRequest
|
|
390
396
|
* @returns AttachDiskResponse
|
|
@@ -708,7 +714,7 @@ export default class Client extends OpenApi {
|
|
|
708
714
|
*/
|
|
709
715
|
authorizeSecurityGroupEgress(request: $_model.AuthorizeSecurityGroupEgressRequest): Promise<$_model.AuthorizeSecurityGroupEgressResponse>;
|
|
710
716
|
/**
|
|
711
|
-
* Cancels
|
|
717
|
+
* Cancels the automatic snapshot policy for one or more cloud disks.
|
|
712
718
|
*
|
|
713
719
|
* @param request - CancelAutoSnapshotPolicyRequest
|
|
714
720
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -716,7 +722,7 @@ export default class Client extends OpenApi {
|
|
|
716
722
|
*/
|
|
717
723
|
cancelAutoSnapshotPolicyWithOptions(request: $_model.CancelAutoSnapshotPolicyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CancelAutoSnapshotPolicyResponse>;
|
|
718
724
|
/**
|
|
719
|
-
* Cancels
|
|
725
|
+
* Cancels the automatic snapshot policy for one or more cloud disks.
|
|
720
726
|
*
|
|
721
727
|
* @param request - CancelAutoSnapshotPolicyRequest
|
|
722
728
|
* @returns CancelAutoSnapshotPolicyResponse
|
|
@@ -748,10 +754,10 @@ export default class Client extends OpenApi {
|
|
|
748
754
|
*/
|
|
749
755
|
cancelCopyImage(request: $_model.CancelCopyImageRequest): Promise<$_model.CancelCopyImageResponse>;
|
|
750
756
|
/**
|
|
751
|
-
* Cancels an image
|
|
757
|
+
* Cancels an image building task.
|
|
752
758
|
*
|
|
753
759
|
* @remarks
|
|
754
|
-
* Before you call this operation, make sure that the image
|
|
760
|
+
* Before you call this operation, make sure that the image building task you want to cancel is in the PREPARING, REPAIRING, or BUILDING state.
|
|
755
761
|
*
|
|
756
762
|
* @param request - CancelImagePipelineExecutionRequest
|
|
757
763
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -759,10 +765,10 @@ export default class Client extends OpenApi {
|
|
|
759
765
|
*/
|
|
760
766
|
cancelImagePipelineExecutionWithOptions(request: $_model.CancelImagePipelineExecutionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CancelImagePipelineExecutionResponse>;
|
|
761
767
|
/**
|
|
762
|
-
* Cancels an image
|
|
768
|
+
* Cancels an image building task.
|
|
763
769
|
*
|
|
764
770
|
* @remarks
|
|
765
|
-
* Before you call this operation, make sure that the image
|
|
771
|
+
* Before you call this operation, make sure that the image building task you want to cancel is in the PREPARING, REPAIRING, or BUILDING state.
|
|
766
772
|
*
|
|
767
773
|
* @param request - CancelImagePipelineExecutionRequest
|
|
768
774
|
* @returns CancelImagePipelineExecutionResponse
|
|
@@ -818,29 +824,29 @@ export default class Client extends OpenApi {
|
|
|
818
824
|
*/
|
|
819
825
|
cancelTask(request: $_model.CancelTaskRequest): Promise<$_model.CancelTaskResponse>;
|
|
820
826
|
/**
|
|
821
|
-
*
|
|
827
|
+
* Disk cloning allows you to quickly replicate a disk with the same data as the source disk in the same zone. The cloned disk supports custom capacity, type, and encryption attributes. After you attach the cloned disk to an instance, you can quickly replicate business data or horizontally scale services.
|
|
822
828
|
*
|
|
823
829
|
* @remarks
|
|
824
|
-
* > The
|
|
825
|
-
* ### Usage
|
|
826
|
-
* - This is an asynchronous operation. After a successful call,
|
|
830
|
+
* > The disk cloning feature itself is free of charge. However, 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, other fees start to accrue after the disk is created, regardless of whether the disk is attached to an instance.
|
|
831
|
+
* ### Usage notes
|
|
832
|
+
* - This is an asynchronous operation. After a successful call, use the taskGroupId and call the DescribeTasks operation to query the execution result.
|
|
827
833
|
* ### Features
|
|
828
|
-
* -
|
|
829
|
-
* -
|
|
830
|
-
* - Local disks and elastic ephemeral disks
|
|
831
|
-
* - You can specify the type and performance level
|
|
832
|
-
* - You can specify the capacity
|
|
833
|
-
* - You can configure provisioned performance and burst
|
|
834
|
-
* - You can
|
|
835
|
-
* - You can use a subscription
|
|
836
|
-
* -
|
|
837
|
-
* -
|
|
838
|
-
* - `
|
|
839
|
-
* - The `source disk`
|
|
840
|
-
* - The `source disk`
|
|
841
|
-
* -
|
|
842
|
-
* -
|
|
843
|
-
* -
|
|
834
|
+
* - Cloning supports only ESSD series disks (cloud_essd, cloud_auto, cloud_essd_entry, cloud_regional_disk_auto) as the source, and the cloned `new disk` supports only ESSD series disk types.
|
|
835
|
+
* - Non-regional disks can be cloned only to non-regional types. Regional disks can be cloned only to regional disk types.
|
|
836
|
+
* - Local disks and elastic ephemeral disks cannot be cloned or used as clone sources.
|
|
837
|
+
* - You can specify the `new disk` type and performance level during cloning.
|
|
838
|
+
* - You can specify the `new disk` capacity during cloning. The new disk capacity must be greater than or equal to the `source disk` capacity.
|
|
839
|
+
* - You can configure provisioned performance and performance burst for the `new disk` during cloning, provided that the destination disk type supports provisioned performance and performance burst.
|
|
840
|
+
* - You can specify encryption or change the encryption key for the `new disk` during cloning. If the `source disk` is encrypted, you cannot clone it into an unencrypted disk, but you can change the encryption key.
|
|
841
|
+
* - You can use a subscription disk as the `source disk` for cloning, even if the subscription disk has expired.
|
|
842
|
+
* - The cloned `new disk` does not support reinitialization.
|
|
843
|
+
* - Cloning does not support storage sets or dedicated block storage clusters. However, disks in these resources can be used as the `source disk`. The cloned disk will not be in the storage set or dedicated block storage cluster.
|
|
844
|
+
* - `Source disk` status restrictions:
|
|
845
|
+
* - The `source disk` status is "In Use" and the corresponding instance status is "Running" or "Stopped".
|
|
846
|
+
* - The `source disk` status is "Available" and the disk has been previously attached.
|
|
847
|
+
* - Disks undergoing specification changes cannot be used as the `source disk`.
|
|
848
|
+
* - Disks undergoing expansion cannot be used as the `source disk`.
|
|
849
|
+
* - 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`.
|
|
844
850
|
*
|
|
845
851
|
* @param request - CloneDisksRequest
|
|
846
852
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -848,29 +854,29 @@ export default class Client extends OpenApi {
|
|
|
848
854
|
*/
|
|
849
855
|
cloneDisksWithOptions(request: $_model.CloneDisksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CloneDisksResponse>;
|
|
850
856
|
/**
|
|
851
|
-
*
|
|
857
|
+
* Disk cloning allows you to quickly replicate a disk with the same data as the source disk in the same zone. The cloned disk supports custom capacity, type, and encryption attributes. After you attach the cloned disk to an instance, you can quickly replicate business data or horizontally scale services.
|
|
852
858
|
*
|
|
853
859
|
* @remarks
|
|
854
|
-
* > The
|
|
855
|
-
* ### Usage
|
|
856
|
-
* - This is an asynchronous operation. After a successful call,
|
|
860
|
+
* > The disk cloning feature itself is free of charge. However, 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, other fees start to accrue after the disk is created, regardless of whether the disk is attached to an instance.
|
|
861
|
+
* ### Usage notes
|
|
862
|
+
* - This is an asynchronous operation. After a successful call, use the taskGroupId and call the DescribeTasks operation to query the execution result.
|
|
857
863
|
* ### Features
|
|
858
|
-
* -
|
|
859
|
-
* -
|
|
860
|
-
* - Local disks and elastic ephemeral disks
|
|
861
|
-
* - You can specify the type and performance level
|
|
862
|
-
* - You can specify the capacity
|
|
863
|
-
* - You can configure provisioned performance and burst
|
|
864
|
-
* - You can
|
|
865
|
-
* - You can use a subscription
|
|
866
|
-
* -
|
|
867
|
-
* -
|
|
868
|
-
* - `
|
|
869
|
-
* - The `source disk`
|
|
870
|
-
* - The `source disk`
|
|
871
|
-
* -
|
|
872
|
-
* -
|
|
873
|
-
* -
|
|
864
|
+
* - Cloning supports only ESSD series disks (cloud_essd, cloud_auto, cloud_essd_entry, cloud_regional_disk_auto) as the source, and the cloned `new disk` supports only ESSD series disk types.
|
|
865
|
+
* - Non-regional disks can be cloned only to non-regional types. Regional disks can be cloned only to regional disk types.
|
|
866
|
+
* - Local disks and elastic ephemeral disks cannot be cloned or used as clone sources.
|
|
867
|
+
* - You can specify the `new disk` type and performance level during cloning.
|
|
868
|
+
* - You can specify the `new disk` capacity during cloning. The new disk capacity must be greater than or equal to the `source disk` capacity.
|
|
869
|
+
* - You can configure provisioned performance and performance burst for the `new disk` during cloning, provided that the destination disk type supports provisioned performance and performance burst.
|
|
870
|
+
* - You can specify encryption or change the encryption key for the `new disk` during cloning. If the `source disk` is encrypted, you cannot clone it into an unencrypted disk, but you can change the encryption key.
|
|
871
|
+
* - You can use a subscription disk as the `source disk` for cloning, even if the subscription disk has expired.
|
|
872
|
+
* - The cloned `new disk` does not support reinitialization.
|
|
873
|
+
* - Cloning does not support storage sets or dedicated block storage clusters. However, disks in these resources can be used as the `source disk`. The cloned disk will not be in the storage set or dedicated block storage cluster.
|
|
874
|
+
* - `Source disk` status restrictions:
|
|
875
|
+
* - The `source disk` status is "In Use" and the corresponding instance status is "Running" or "Stopped".
|
|
876
|
+
* - The `source disk` status is "Available" and the disk has been previously attached.
|
|
877
|
+
* - Disks undergoing specification changes cannot be used as the `source disk`.
|
|
878
|
+
* - Disks undergoing expansion cannot be used as the `source disk`.
|
|
879
|
+
* - 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`.
|
|
874
880
|
*
|
|
875
881
|
* @param request - CloneDisksRequest
|
|
876
882
|
* @returns CloneDisksResponse
|
|
@@ -968,11 +974,11 @@ export default class Client extends OpenApi {
|
|
|
968
974
|
*/
|
|
969
975
|
copyImage(request: $_model.CopyImageRequest): Promise<$_model.CopyImageResponse>;
|
|
970
976
|
/**
|
|
971
|
-
* Copies a standard or encrypted snapshot from one region to another.
|
|
977
|
+
* Copies a standard snapshot or encrypted snapshot from one region to another.
|
|
972
978
|
*
|
|
973
979
|
* @remarks
|
|
974
|
-
* When you call this operation, take note of the following
|
|
975
|
-
* -
|
|
980
|
+
* When you call this operation, take note of the following items:
|
|
981
|
+
* - The new snapshot cannot be used to roll back the cloud disk that is associated with the source snapshot.
|
|
976
982
|
* - Local snapshots cannot be copied.
|
|
977
983
|
*
|
|
978
984
|
* @param request - CopySnapshotRequest
|
|
@@ -981,11 +987,11 @@ export default class Client extends OpenApi {
|
|
|
981
987
|
*/
|
|
982
988
|
copySnapshotWithOptions(request: $_model.CopySnapshotRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CopySnapshotResponse>;
|
|
983
989
|
/**
|
|
984
|
-
* Copies a standard or encrypted snapshot from one region to another.
|
|
990
|
+
* Copies a standard snapshot or encrypted snapshot from one region to another.
|
|
985
991
|
*
|
|
986
992
|
* @remarks
|
|
987
|
-
* When you call this operation, take note of the following
|
|
988
|
-
* -
|
|
993
|
+
* When you call this operation, take note of the following items:
|
|
994
|
+
* - The new snapshot cannot be used to roll back the cloud disk that is associated with the source snapshot.
|
|
989
995
|
* - Local snapshots cannot be copied.
|
|
990
996
|
*
|
|
991
997
|
* @param request - CopySnapshotRequest
|
|
@@ -1040,13 +1046,13 @@ export default class Client extends OpenApi {
|
|
|
1040
1046
|
*/
|
|
1041
1047
|
createActivation(request: $_model.CreateActivationRequest): Promise<$_model.CreateActivationResponse>;
|
|
1042
1048
|
/**
|
|
1043
|
-
*
|
|
1049
|
+
* Creates an auto provisioning group.
|
|
1044
1050
|
*
|
|
1045
1051
|
* @remarks
|
|
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
|
|
1047
|
-
* - Auto provisioning
|
|
1048
|
-
* - Auto provisioning is a free feature
|
|
1049
|
-
* -
|
|
1052
|
+
* - 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).
|
|
1053
|
+
* - 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.
|
|
1054
|
+
* - 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).
|
|
1055
|
+
* - If you specify both a launch template (`LaunchTemplateId`) and launch configuration information (`LaunchConfiguration.*`), the launch template takes precedence.
|
|
1050
1056
|
*
|
|
1051
1057
|
* @param tmpReq - CreateAutoProvisioningGroupRequest
|
|
1052
1058
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1054,28 +1060,28 @@ export default class Client extends OpenApi {
|
|
|
1054
1060
|
*/
|
|
1055
1061
|
createAutoProvisioningGroupWithOptions(tmpReq: $_model.CreateAutoProvisioningGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAutoProvisioningGroupResponse>;
|
|
1056
1062
|
/**
|
|
1057
|
-
*
|
|
1063
|
+
* Creates an auto provisioning group.
|
|
1058
1064
|
*
|
|
1059
1065
|
* @remarks
|
|
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
|
|
1061
|
-
* - Auto provisioning
|
|
1062
|
-
* - Auto provisioning is a free feature
|
|
1063
|
-
* -
|
|
1066
|
+
* - 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).
|
|
1067
|
+
* - 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.
|
|
1068
|
+
* - 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).
|
|
1069
|
+
* - If you specify both a launch template (`LaunchTemplateId`) and launch configuration information (`LaunchConfiguration.*`), the launch template takes precedence.
|
|
1064
1070
|
*
|
|
1065
1071
|
* @param request - CreateAutoProvisioningGroupRequest
|
|
1066
1072
|
* @returns CreateAutoProvisioningGroupResponse
|
|
1067
1073
|
*/
|
|
1068
1074
|
createAutoProvisioningGroup(request: $_model.CreateAutoProvisioningGroupRequest): Promise<$_model.CreateAutoProvisioningGroupResponse>;
|
|
1069
1075
|
/**
|
|
1070
|
-
* Creates an automatic snapshot policy in a
|
|
1076
|
+
* Creates an automatic snapshot policy in a specified region. You can specify the repeat cycle, retention period, and cross-region backup settings for automatic snapshots to back up data on system disks or data disks.
|
|
1071
1077
|
*
|
|
1072
1078
|
* @remarks
|
|
1073
|
-
* Before you call this operation,
|
|
1079
|
+
* Before you call this operation, read [Create an automatic snapshot policy](https://help.aliyun.com/document_detail/127767.html).
|
|
1074
1080
|
* Take note of the following items:
|
|
1075
|
-
* - You can create
|
|
1076
|
-
* -
|
|
1077
|
-
* - If cross-region snapshot replication is enabled and no encryption parameters are configured, encrypted snapshots are
|
|
1078
|
-
* After
|
|
1081
|
+
* - You can create a maximum of 100 automatic snapshot policies in a region for an Alibaba Cloud account. When the number of automatic snapshots for a disk reaches the quota limit, the system deletes the earliest automatic snapshot created by the automatic snapshot policy when a new snapshot task is initiated.
|
|
1082
|
+
* - The system does not execute automatic snapshot policies when an ECS instance has a pending stop or restart task.
|
|
1083
|
+
* - If cross-region snapshot replication is enabled and no encryption parameters are configured, encrypted snapshots are replicated to the destination region by using the service key of the destination region by default. For more information about cross-region snapshot replication, see [Copy a snapshot](https://help.aliyun.com/document_detail/159441.html).
|
|
1084
|
+
* After you create an automatic snapshot policy, call [ApplyAutoSnapshotPolicy](https://help.aliyun.com/document_detail/25531.html) to apply the policy to disks. To modify an automatic snapshot policy, call [ModifyAutoSnapshotPolicyEx](https://help.aliyun.com/document_detail/25529.html).
|
|
1079
1085
|
*
|
|
1080
1086
|
* @param request - CreateAutoSnapshotPolicyRequest
|
|
1081
1087
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1083,15 +1089,15 @@ export default class Client extends OpenApi {
|
|
|
1083
1089
|
*/
|
|
1084
1090
|
createAutoSnapshotPolicyWithOptions(request: $_model.CreateAutoSnapshotPolicyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAutoSnapshotPolicyResponse>;
|
|
1085
1091
|
/**
|
|
1086
|
-
* Creates an automatic snapshot policy in a
|
|
1092
|
+
* Creates an automatic snapshot policy in a specified region. You can specify the repeat cycle, retention period, and cross-region backup settings for automatic snapshots to back up data on system disks or data disks.
|
|
1087
1093
|
*
|
|
1088
1094
|
* @remarks
|
|
1089
|
-
* Before you call this operation,
|
|
1095
|
+
* Before you call this operation, read [Create an automatic snapshot policy](https://help.aliyun.com/document_detail/127767.html).
|
|
1090
1096
|
* Take note of the following items:
|
|
1091
|
-
* - You can create
|
|
1092
|
-
* -
|
|
1093
|
-
* - If cross-region snapshot replication is enabled and no encryption parameters are configured, encrypted snapshots are
|
|
1094
|
-
* After
|
|
1097
|
+
* - You can create a maximum of 100 automatic snapshot policies in a region for an Alibaba Cloud account. When the number of automatic snapshots for a disk reaches the quota limit, the system deletes the earliest automatic snapshot created by the automatic snapshot policy when a new snapshot task is initiated.
|
|
1098
|
+
* - The system does not execute automatic snapshot policies when an ECS instance has a pending stop or restart task.
|
|
1099
|
+
* - If cross-region snapshot replication is enabled and no encryption parameters are configured, encrypted snapshots are replicated to the destination region by using the service key of the destination region by default. For more information about cross-region snapshot replication, see [Copy a snapshot](https://help.aliyun.com/document_detail/159441.html).
|
|
1100
|
+
* After you create an automatic snapshot policy, call [ApplyAutoSnapshotPolicy](https://help.aliyun.com/document_detail/25531.html) to apply the policy to disks. To modify an automatic snapshot policy, call [ModifyAutoSnapshotPolicyEx](https://help.aliyun.com/document_detail/25529.html).
|
|
1095
1101
|
*
|
|
1096
1102
|
* @param request - CreateAutoSnapshotPolicyRequest
|
|
1097
1103
|
* @returns CreateAutoSnapshotPolicyResponse
|
|
@@ -1241,14 +1247,14 @@ export default class Client extends OpenApi {
|
|
|
1241
1247
|
* Creates a pay-as-you-go or subscription data disk.
|
|
1242
1248
|
*
|
|
1243
1249
|
* @remarks
|
|
1244
|
-
* -
|
|
1250
|
+
* - You can enable the multi-attach attribute (`MultiAttach`) when you create a disk. 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
1251
|
* - 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
|
-
* -
|
|
1247
|
-
* - Creating a disk incurs
|
|
1252
|
+
* - Complete real-name registration before you create a disk. Go to [Real-name registration](https://account.console.aliyun.com/#/auth/home) in your account information.
|
|
1253
|
+
* - Creating a disk incurs charges. Learn about the billing methods of Elastic Compute Service (ECS) in advance. For more information, see [Billing overview](https://help.aliyun.com/document_detail/25398.html).
|
|
1248
1254
|
* - 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
|
|
1250
|
-
* - When you create an enterprise SSD, if you do not configure
|
|
1251
|
-
* - The billing method is pay-as-you-go
|
|
1255
|
+
* - Automatic snapshots of the disk are deleted when the disk is deleted. That is, `DeleteAutoSnapshot` is set to `true`. You can invoke [DescribeDisks](https://help.aliyun.com/document_detail/2679767.html) to query the parameter settings, and invoke [ModifyDiskAttribute](https://help.aliyun.com/document_detail/25517.html) to modify the property.
|
|
1256
|
+
* - When you create an enterprise SSD, if you do not configure the performance level, the default level is PL1. You can invoke [ModifyDiskSpec](https://help.aliyun.com/document_detail/123780.html) to change the performance level.
|
|
1257
|
+
* - The billing method is pay-as-you-go. That is, the `Portable` property defaults to `true`.
|
|
1252
1258
|
*
|
|
1253
1259
|
* @param request - CreateDiskRequest
|
|
1254
1260
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1259,14 +1265,14 @@ export default class Client extends OpenApi {
|
|
|
1259
1265
|
* Creates a pay-as-you-go or subscription data disk.
|
|
1260
1266
|
*
|
|
1261
1267
|
* @remarks
|
|
1262
|
-
* -
|
|
1268
|
+
* - You can enable the multi-attach attribute (`MultiAttach`) when you create a disk. 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
1269
|
* - 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
|
-
* -
|
|
1265
|
-
* - Creating a disk incurs
|
|
1270
|
+
* - Complete real-name registration before you create a disk. Go to [Real-name registration](https://account.console.aliyun.com/#/auth/home) in your account information.
|
|
1271
|
+
* - Creating a disk incurs charges. Learn about the billing methods of Elastic Compute Service (ECS) in advance. For more information, see [Billing overview](https://help.aliyun.com/document_detail/25398.html).
|
|
1266
1272
|
* - 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
|
|
1268
|
-
* - When you create an enterprise SSD, if you do not configure
|
|
1269
|
-
* - The billing method is pay-as-you-go
|
|
1273
|
+
* - Automatic snapshots of the disk are deleted when the disk is deleted. That is, `DeleteAutoSnapshot` is set to `true`. You can invoke [DescribeDisks](https://help.aliyun.com/document_detail/2679767.html) to query the parameter settings, and invoke [ModifyDiskAttribute](https://help.aliyun.com/document_detail/25517.html) to modify the property.
|
|
1274
|
+
* - When you create an enterprise SSD, if you do not configure the performance level, the default level is PL1. You can invoke [ModifyDiskSpec](https://help.aliyun.com/document_detail/123780.html) to change the performance level.
|
|
1275
|
+
* - The billing method is pay-as-you-go. That is, the `Portable` property defaults to `true`.
|
|
1270
1276
|
*
|
|
1271
1277
|
* @param request - CreateDiskRequest
|
|
1272
1278
|
* @returns CreateDiskResponse
|
|
@@ -1353,26 +1359,25 @@ export default class Client extends OpenApi {
|
|
|
1353
1359
|
*/
|
|
1354
1360
|
createHpcCluster(request: $_model.CreateHpcClusterRequest): Promise<$_model.CreateHpcClusterResponse>;
|
|
1355
1361
|
/**
|
|
1356
|
-
*
|
|
1362
|
+
* 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).
|
|
1357
1363
|
*
|
|
1358
1364
|
* @remarks
|
|
1359
|
-
* ###
|
|
1360
|
-
* - This
|
|
1361
|
-
* -
|
|
1362
|
-
* -
|
|
1363
|
-
*
|
|
1365
|
+
* ### Before you begin
|
|
1366
|
+
* - 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).
|
|
1367
|
+
* - When you query ECS instance information, if the response contains {"OperationLocks": {"LockReason" : "security"}}, you cannot create a custom image.
|
|
1368
|
+
* - 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).
|
|
1369
|
+
* 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.
|
|
1364
1370
|
* - **Create a custom image from an instance**: Specify the instance ID (`InstanceId`).
|
|
1365
|
-
* - The instance must be in the `Running` or `Stopped` state.
|
|
1366
|
-
* -
|
|
1367
|
-
* >Notice:
|
|
1368
|
-
*
|
|
1369
|
-
*
|
|
1370
|
-
*
|
|
1371
|
-
*
|
|
1372
|
-
*
|
|
1373
|
-
*
|
|
1374
|
-
*
|
|
1375
|
-
* > 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.
|
|
1371
|
+
* - The instance must be in the Running (`Running`) or Stopped (`Stopped`) state.
|
|
1372
|
+
* - After the operation is called, a new snapshot is created for each disk of the instance.
|
|
1373
|
+
* >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.
|
|
1374
|
+
* - **Create a custom image from a snapshot (the specified snapshot cannot be one created on or before July 15, 2013.)**
|
|
1375
|
+
* - **Create a custom image from a system disk snapshot**: Specify only the snapshot ID of the instance system disk (`SnapshotId`).
|
|
1376
|
+
* - **Create a custom image from system disk and data disk snapshots**: Establish data associations among multiple disks (`DiskDeviceMapping`).
|
|
1377
|
+
* - Only one system disk snapshot can be specified.
|
|
1378
|
+
* - 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.
|
|
1379
|
+
*
|
|
1380
|
+
* > 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.
|
|
1376
1381
|
*
|
|
1377
1382
|
* @param request - CreateImageRequest
|
|
1378
1383
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1380,26 +1385,25 @@ export default class Client extends OpenApi {
|
|
|
1380
1385
|
*/
|
|
1381
1386
|
createImageWithOptions(request: $_model.CreateImageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateImageResponse>;
|
|
1382
1387
|
/**
|
|
1383
|
-
*
|
|
1388
|
+
* 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).
|
|
1384
1389
|
*
|
|
1385
1390
|
* @remarks
|
|
1386
|
-
* ###
|
|
1387
|
-
* - This
|
|
1388
|
-
* -
|
|
1389
|
-
* -
|
|
1390
|
-
*
|
|
1391
|
+
* ### Before you begin
|
|
1392
|
+
* - 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).
|
|
1393
|
+
* - When you query ECS instance information, if the response contains {"OperationLocks": {"LockReason" : "security"}}, you cannot create a custom image.
|
|
1394
|
+
* - 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).
|
|
1395
|
+
* 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.
|
|
1391
1396
|
* - **Create a custom image from an instance**: Specify the instance ID (`InstanceId`).
|
|
1392
|
-
* - The instance must be in the `Running` or `Stopped` state.
|
|
1393
|
-
* -
|
|
1394
|
-
* >Notice:
|
|
1395
|
-
*
|
|
1396
|
-
*
|
|
1397
|
-
*
|
|
1398
|
-
*
|
|
1399
|
-
*
|
|
1400
|
-
*
|
|
1401
|
-
*
|
|
1402
|
-
* > 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.
|
|
1397
|
+
* - The instance must be in the Running (`Running`) or Stopped (`Stopped`) state.
|
|
1398
|
+
* - After the operation is called, a new snapshot is created for each disk of the instance.
|
|
1399
|
+
* >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.
|
|
1400
|
+
* - **Create a custom image from a snapshot (the specified snapshot cannot be one created on or before July 15, 2013.)**
|
|
1401
|
+
* - **Create a custom image from a system disk snapshot**: Specify only the snapshot ID of the instance system disk (`SnapshotId`).
|
|
1402
|
+
* - **Create a custom image from system disk and data disk snapshots**: Establish data associations among multiple disks (`DiskDeviceMapping`).
|
|
1403
|
+
* - Only one system disk snapshot can be specified.
|
|
1404
|
+
* - 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.
|
|
1405
|
+
*
|
|
1406
|
+
* > 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.
|
|
1403
1407
|
*
|
|
1404
1408
|
* @param request - CreateImageRequest
|
|
1405
1409
|
* @returns CreateImageResponse
|
|
@@ -1562,15 +1566,15 @@ export default class Client extends OpenApi {
|
|
|
1562
1566
|
*/
|
|
1563
1567
|
createKeyPair(request: $_model.CreateKeyPairRequest): Promise<$_model.CreateKeyPairResponse>;
|
|
1564
1568
|
/**
|
|
1565
|
-
*
|
|
1569
|
+
* 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.
|
|
1566
1570
|
*
|
|
1567
1571
|
* @remarks
|
|
1568
|
-
* After you
|
|
1569
|
-
* A launch template version
|
|
1570
|
-
* When
|
|
1571
|
-
* -
|
|
1572
|
-
* -
|
|
1573
|
-
* -
|
|
1572
|
+
* 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.
|
|
1573
|
+
* 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.
|
|
1574
|
+
* When you call this operation, take note of the following items:
|
|
1575
|
+
* - Each account can create up to 30 launch templates per region, and each template can have up to 30 versions.
|
|
1576
|
+
* - 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.
|
|
1577
|
+
* - 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`.
|
|
1574
1578
|
*
|
|
1575
1579
|
* @param request - CreateLaunchTemplateRequest
|
|
1576
1580
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1578,15 +1582,15 @@ export default class Client extends OpenApi {
|
|
|
1578
1582
|
*/
|
|
1579
1583
|
createLaunchTemplateWithOptions(request: $_model.CreateLaunchTemplateRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateLaunchTemplateResponse>;
|
|
1580
1584
|
/**
|
|
1581
|
-
*
|
|
1585
|
+
* 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.
|
|
1582
1586
|
*
|
|
1583
1587
|
* @remarks
|
|
1584
|
-
* After you
|
|
1585
|
-
* A launch template version
|
|
1586
|
-
* When
|
|
1587
|
-
* -
|
|
1588
|
-
* -
|
|
1589
|
-
* -
|
|
1588
|
+
* 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.
|
|
1589
|
+
* 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.
|
|
1590
|
+
* When you call this operation, take note of the following items:
|
|
1591
|
+
* - Each account can create up to 30 launch templates per region, and each template can have up to 30 versions.
|
|
1592
|
+
* - 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.
|
|
1593
|
+
* - 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`.
|
|
1590
1594
|
*
|
|
1591
1595
|
* @param request - CreateLaunchTemplateRequest
|
|
1592
1596
|
* @returns CreateLaunchTemplateResponse
|
|
@@ -1924,30 +1928,30 @@ export default class Client extends OpenApi {
|
|
|
1924
1928
|
*/
|
|
1925
1929
|
createSimulatedSystemEvents(request: $_model.CreateSimulatedSystemEventsRequest): Promise<$_model.CreateSimulatedSystemEventsResponse>;
|
|
1926
1930
|
/**
|
|
1927
|
-
*
|
|
1928
|
-
*
|
|
1929
|
-
* @remarks
|
|
1930
|
-
* The
|
|
1931
|
-
* - If you used local snapshots before December 14, 2020, you can
|
|
1932
|
-
* - If you did not use local snapshots before December 14, 2020, no additional configuration is required. New snapshots
|
|
1933
|
-
*
|
|
1934
|
-
* -
|
|
1935
|
-
* - The
|
|
1936
|
-
* - If the
|
|
1937
|
-
* - If the
|
|
1938
|
-
* - When
|
|
1939
|
-
*
|
|
1940
|
-
* -
|
|
1941
|
-
* -
|
|
1942
|
-
* -
|
|
1943
|
-
* - If the
|
|
1944
|
-
* -
|
|
1945
|
-
* - You can create
|
|
1946
|
-
* - After a snapshot is created,
|
|
1947
|
-
* -
|
|
1948
|
-
* - The number of manual snapshots
|
|
1949
|
-
* -
|
|
1950
|
-
* - When you query
|
|
1931
|
+
* Creates a snapshot for a disk.
|
|
1932
|
+
*
|
|
1933
|
+
* @remarks
|
|
1934
|
+
* The local snapshot feature has been replaced by the snapshot instant access feature. Metric description is as follows:
|
|
1935
|
+
* - If you used local snapshots before December 14, 2020, you can use the `Category` parameter as Normal.
|
|
1936
|
+
* - If you did not use local snapshots before December 14, 2020, no additional configuration is required. New snapshots created for ESSD series disks (ESSD, ESSD AutoPL, ESSD Entry, and regional ESSD) are instantly active by default, and both manual snapshots and automatic snapshots are supported. The three snapshot instant access-related parameters `InstantAccess`, `InstantAccessRetentionDays`, and `DisableInstantAccess` in API operations no longer take effect. The `DescribeSnapshots` and `DescribeSnapshotGroups` API operations will include a new response parameter named Available to describe the active status of snapshots.
|
|
1937
|
+
* Before you begin:
|
|
1938
|
+
* - Activate the snapshot feature. For more information, see [Activate snapshots](https://help.aliyun.com/document_detail/108381.html).
|
|
1939
|
+
* - The disk must be in the **In Use** or **Unattached** state. Note the following items for different states:
|
|
1940
|
+
* - If the disk is in the **In Use** state, the instance must be in the **Running** or **Stopped** state.
|
|
1941
|
+
* - If the disk is in the **Unattached** state, the disk must have been previously attached to an ECS instance. Snapshots cannot be created for disks that have never been attached to an ECS instance.
|
|
1942
|
+
* - When a disk is used to create a dynamic extended volume or a RAID array, use a snapshot-consistent group and enable application-consistent snapshots to back up data. Snapshot-consistent groups ensure write order consistency and crash consistency for data written to multiple disks in a business system. For more information, see [Create a snapshot-consistent group](https://help.aliyun.com/document_detail/199625.html) and [Create an application-consistent snapshot](https://help.aliyun.com/document_detail/208589.html).
|
|
1943
|
+
* When you create a snapshot, take note of the following items:
|
|
1944
|
+
* - Avoid creating snapshots during peak business hours. When a snapshot is being created, the I/O performance of the disk decreases by up to 10%, and read and write performance may be briefly affected.
|
|
1945
|
+
* - If the snapshot has not been created, it cannot be used to create a custom image ([CreateImage](https://help.aliyun.com/document_detail/25535.html)).
|
|
1946
|
+
* - Incremental data generated by disk operations during snapshot creation is not backup to the snapshot.
|
|
1947
|
+
* - If the disk is attached to an ECS instance, do not change the instance status during snapshot creation, such as stopping or restarting the ECS instance. Otherwise, the snapshot creation is failed.
|
|
1948
|
+
* - A disk for which a snapshot is being created does not support scale-out. Wait until the snapshot is created before you execute the scale-out operation.
|
|
1949
|
+
* - You can create snapshots for disks in the **Expired** (`Expired`) state. If the disk reaches its expiration release time during snapshot creation, the disk is released and the snapshot in the **Creating** (`Creating`) state is also deleted.
|
|
1950
|
+
* - After a snapshot is created, the system calculates fees based on the snapshot size in each region separately. For more information, see [Snapshot billing](https://help.aliyun.com/document_detail/56159.html).
|
|
1951
|
+
* - In the following scenarios, you cannot create a snapshot for the specified disk:
|
|
1952
|
+
* - The number of manual snapshots retained for the disk has reached the upper limit. For more information, see [Snapshot limits](~~25412#SnapshotQuota1~~).
|
|
1953
|
+
* - Snapshot creation has concurrency limits. Exceeding the limits causes creation failures. For more information, see [Snapshot limits](~~25412#SnapshotQuota1~~).
|
|
1954
|
+
* - When you query ECS instance information, if the returned data contains `{"OperationLocks": {"LockReason" : "security"}}`, all operations are prohibited.
|
|
1951
1955
|
*
|
|
1952
1956
|
* @param request - CreateSnapshotRequest
|
|
1953
1957
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1955,50 +1959,50 @@ export default class Client extends OpenApi {
|
|
|
1955
1959
|
*/
|
|
1956
1960
|
createSnapshotWithOptions(request: $_model.CreateSnapshotRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSnapshotResponse>;
|
|
1957
1961
|
/**
|
|
1958
|
-
*
|
|
1959
|
-
*
|
|
1960
|
-
* @remarks
|
|
1961
|
-
* The
|
|
1962
|
-
* - If you used local snapshots before December 14, 2020, you can
|
|
1963
|
-
* - If you did not use local snapshots before December 14, 2020, no additional configuration is required. New snapshots
|
|
1964
|
-
*
|
|
1965
|
-
* -
|
|
1966
|
-
* - The
|
|
1967
|
-
* - If the
|
|
1968
|
-
* - If the
|
|
1969
|
-
* - When
|
|
1970
|
-
*
|
|
1971
|
-
* -
|
|
1972
|
-
* -
|
|
1973
|
-
* -
|
|
1974
|
-
* - If the
|
|
1975
|
-
* -
|
|
1976
|
-
* - You can create
|
|
1977
|
-
* - After a snapshot is created,
|
|
1978
|
-
* -
|
|
1979
|
-
* - The number of manual snapshots
|
|
1980
|
-
* -
|
|
1981
|
-
* - When you query
|
|
1962
|
+
* Creates a snapshot for a disk.
|
|
1963
|
+
*
|
|
1964
|
+
* @remarks
|
|
1965
|
+
* The local snapshot feature has been replaced by the snapshot instant access feature. Metric description is as follows:
|
|
1966
|
+
* - If you used local snapshots before December 14, 2020, you can use the `Category` parameter as Normal.
|
|
1967
|
+
* - If you did not use local snapshots before December 14, 2020, no additional configuration is required. New snapshots created for ESSD series disks (ESSD, ESSD AutoPL, ESSD Entry, and regional ESSD) are instantly active by default, and both manual snapshots and automatic snapshots are supported. The three snapshot instant access-related parameters `InstantAccess`, `InstantAccessRetentionDays`, and `DisableInstantAccess` in API operations no longer take effect. The `DescribeSnapshots` and `DescribeSnapshotGroups` API operations will include a new response parameter named Available to describe the active status of snapshots.
|
|
1968
|
+
* Before you begin:
|
|
1969
|
+
* - Activate the snapshot feature. For more information, see [Activate snapshots](https://help.aliyun.com/document_detail/108381.html).
|
|
1970
|
+
* - The disk must be in the **In Use** or **Unattached** state. Note the following items for different states:
|
|
1971
|
+
* - If the disk is in the **In Use** state, the instance must be in the **Running** or **Stopped** state.
|
|
1972
|
+
* - If the disk is in the **Unattached** state, the disk must have been previously attached to an ECS instance. Snapshots cannot be created for disks that have never been attached to an ECS instance.
|
|
1973
|
+
* - When a disk is used to create a dynamic extended volume or a RAID array, use a snapshot-consistent group and enable application-consistent snapshots to back up data. Snapshot-consistent groups ensure write order consistency and crash consistency for data written to multiple disks in a business system. For more information, see [Create a snapshot-consistent group](https://help.aliyun.com/document_detail/199625.html) and [Create an application-consistent snapshot](https://help.aliyun.com/document_detail/208589.html).
|
|
1974
|
+
* When you create a snapshot, take note of the following items:
|
|
1975
|
+
* - Avoid creating snapshots during peak business hours. When a snapshot is being created, the I/O performance of the disk decreases by up to 10%, and read and write performance may be briefly affected.
|
|
1976
|
+
* - If the snapshot has not been created, it cannot be used to create a custom image ([CreateImage](https://help.aliyun.com/document_detail/25535.html)).
|
|
1977
|
+
* - Incremental data generated by disk operations during snapshot creation is not backup to the snapshot.
|
|
1978
|
+
* - If the disk is attached to an ECS instance, do not change the instance status during snapshot creation, such as stopping or restarting the ECS instance. Otherwise, the snapshot creation is failed.
|
|
1979
|
+
* - A disk for which a snapshot is being created does not support scale-out. Wait until the snapshot is created before you execute the scale-out operation.
|
|
1980
|
+
* - You can create snapshots for disks in the **Expired** (`Expired`) state. If the disk reaches its expiration release time during snapshot creation, the disk is released and the snapshot in the **Creating** (`Creating`) state is also deleted.
|
|
1981
|
+
* - After a snapshot is created, the system calculates fees based on the snapshot size in each region separately. For more information, see [Snapshot billing](https://help.aliyun.com/document_detail/56159.html).
|
|
1982
|
+
* - In the following scenarios, you cannot create a snapshot for the specified disk:
|
|
1983
|
+
* - The number of manual snapshots retained for the disk has reached the upper limit. For more information, see [Snapshot limits](~~25412#SnapshotQuota1~~).
|
|
1984
|
+
* - Snapshot creation has concurrency limits. Exceeding the limits causes creation failures. For more information, see [Snapshot limits](~~25412#SnapshotQuota1~~).
|
|
1985
|
+
* - When you query ECS instance information, if the returned data contains `{"OperationLocks": {"LockReason" : "security"}}`, all operations are prohibited.
|
|
1982
1986
|
*
|
|
1983
1987
|
* @param request - CreateSnapshotRequest
|
|
1984
1988
|
* @returns CreateSnapshotResponse
|
|
1985
1989
|
*/
|
|
1986
1990
|
createSnapshot(request: $_model.CreateSnapshotRequest): Promise<$_model.CreateSnapshotResponse>;
|
|
1987
1991
|
/**
|
|
1988
|
-
* Creates a snapshot-consistent group for
|
|
1992
|
+
* Creates a snapshot-consistent group for disks attached to a specified ECS instance. A snapshot-consistent group contains snapshots of one or more disks.
|
|
1989
1993
|
*
|
|
1990
1994
|
* @remarks
|
|
1991
|
-
*
|
|
1992
|
-
* > `DiskId.N
|
|
1993
|
-
*
|
|
1994
|
-
* -
|
|
1995
|
-
*
|
|
1996
|
-
*
|
|
1997
|
-
* -
|
|
1998
|
-
* -
|
|
1999
|
-
* -
|
|
2000
|
-
* -
|
|
2001
|
-
*
|
|
1995
|
+
* You can set `InstanceId` to create a snapshot-consistent group for specified disks within an instance. Alternatively, you can use only `DiskId.N` to create a snapshot-consistent group for multiple disks attached to multiple ECS instances in the same zone.
|
|
1996
|
+
* > `DiskId.N` and `ExcludeDiskId.N` cannot be specified at the same time. If `InstanceId` is specified, `DiskId.N` can only be set to disks attached to the specified instance and no longer supports specifying disk IDs across multiple instances.
|
|
1997
|
+
* When you create a snapshot-consistent group, take note of the following items:
|
|
1998
|
+
* - The disks for which you want to create snapshots must be in the **In Use** (`In_use`) or **Available** (`Available`) state.
|
|
1999
|
+
* - If a disk is in the **In Use** (`In_use`) state, the ECS instance status must be **Running** (`Running`) or **Stopped** (`Stopped`).
|
|
2000
|
+
* - If a disk is in the **Available** (`Available`) state, the disk must have been previously attached to an ECS instance. Disks that have never been attached to an ECS instance do not support snapshot creation.
|
|
2001
|
+
* - Snapshot-consistent groups support only ESSD series disks (ESSD, ESSD AutoPL, and ESSD Entry).
|
|
2002
|
+
* - A single snapshot-consistent group can contain up to 16 disks (including system disks and data disks), and the total capacity cannot exceed 32 TiB.
|
|
2003
|
+
* - Snapshots that you manually create are retained until you delete them. Delete unnecessary snapshots on a regular basis to avoid incurring ongoing snapshot size fees.
|
|
2004
|
+
* - Disks with the multi-attach attribute enabled do not support snapshot-consistent groups. If an instance has a multi-attach disk attached, set the `ExcludeDiskId.N` parameter to exclude the disk.
|
|
2005
|
+
* For more information about the features and billing of snapshot-consistent groups, see [Snapshot-consistent groups](https://help.aliyun.com/document_detail/199625.html).
|
|
2002
2006
|
*
|
|
2003
2007
|
* @param request - CreateSnapshotGroupRequest
|
|
2004
2008
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2006,20 +2010,20 @@ export default class Client extends OpenApi {
|
|
|
2006
2010
|
*/
|
|
2007
2011
|
createSnapshotGroupWithOptions(request: $_model.CreateSnapshotGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSnapshotGroupResponse>;
|
|
2008
2012
|
/**
|
|
2009
|
-
* Creates a snapshot-consistent group for
|
|
2013
|
+
* Creates a snapshot-consistent group for disks attached to a specified ECS instance. A snapshot-consistent group contains snapshots of one or more disks.
|
|
2010
2014
|
*
|
|
2011
2015
|
* @remarks
|
|
2012
|
-
*
|
|
2013
|
-
* > `DiskId.N
|
|
2014
|
-
*
|
|
2015
|
-
* -
|
|
2016
|
-
*
|
|
2017
|
-
*
|
|
2018
|
-
* -
|
|
2019
|
-
* -
|
|
2020
|
-
* -
|
|
2021
|
-
* -
|
|
2022
|
-
*
|
|
2016
|
+
* You can set `InstanceId` to create a snapshot-consistent group for specified disks within an instance. Alternatively, you can use only `DiskId.N` to create a snapshot-consistent group for multiple disks attached to multiple ECS instances in the same zone.
|
|
2017
|
+
* > `DiskId.N` and `ExcludeDiskId.N` cannot be specified at the same time. If `InstanceId` is specified, `DiskId.N` can only be set to disks attached to the specified instance and no longer supports specifying disk IDs across multiple instances.
|
|
2018
|
+
* When you create a snapshot-consistent group, take note of the following items:
|
|
2019
|
+
* - The disks for which you want to create snapshots must be in the **In Use** (`In_use`) or **Available** (`Available`) state.
|
|
2020
|
+
* - If a disk is in the **In Use** (`In_use`) state, the ECS instance status must be **Running** (`Running`) or **Stopped** (`Stopped`).
|
|
2021
|
+
* - If a disk is in the **Available** (`Available`) state, the disk must have been previously attached to an ECS instance. Disks that have never been attached to an ECS instance do not support snapshot creation.
|
|
2022
|
+
* - Snapshot-consistent groups support only ESSD series disks (ESSD, ESSD AutoPL, and ESSD Entry).
|
|
2023
|
+
* - A single snapshot-consistent group can contain up to 16 disks (including system disks and data disks), and the total capacity cannot exceed 32 TiB.
|
|
2024
|
+
* - Snapshots that you manually create are retained until you delete them. Delete unnecessary snapshots on a regular basis to avoid incurring ongoing snapshot size fees.
|
|
2025
|
+
* - Disks with the multi-attach attribute enabled do not support snapshot-consistent groups. If an instance has a multi-attach disk attached, set the `ExcludeDiskId.N` parameter to exclude the disk.
|
|
2026
|
+
* For more information about the features and billing of snapshot-consistent groups, see [Snapshot-consistent groups](https://help.aliyun.com/document_detail/199625.html).
|
|
2023
2027
|
*
|
|
2024
2028
|
* @param request - CreateSnapshotGroupRequest
|
|
2025
2029
|
* @returns CreateSnapshotGroupResponse
|
|
@@ -2295,13 +2299,13 @@ export default class Client extends OpenApi {
|
|
|
2295
2299
|
*/
|
|
2296
2300
|
deleteDiagnosticReports(request: $_model.DeleteDiagnosticReportsRequest): Promise<$_model.DeleteDiagnosticReportsResponse>;
|
|
2297
2301
|
/**
|
|
2298
|
-
* Releases a pay-as-you-go data disk.
|
|
2302
|
+
* Releases a pay-as-you-go data disk. Disk types include basic disks, ultra disks, standard SSDs, and enterprise SSDs.
|
|
2299
2303
|
*
|
|
2300
2304
|
* @remarks
|
|
2301
2305
|
* When you invoke this operation, take note of the following items:
|
|
2302
2306
|
* - Manual snapshots of the disk are retained.
|
|
2303
|
-
* - You can invoke [ModifyDiskAttribute](https://help.aliyun.com/document_detail/25517.html) to
|
|
2304
|
-
* - The disk must be in the
|
|
2307
|
+
* - You can invoke [ModifyDiskAttribute](https://help.aliyun.com/document_detail/25517.html) to configure the Settings for whether to retain or release automatic snapshots together with the disk. Delete unnecessary snapshots promptly to maintain sufficient snapshot quota for epoch-based automatic snapshot policy.
|
|
2308
|
+
* - The disk must be in the Pending Attach (Available) state when you release it.
|
|
2305
2309
|
* - If the disk with the specified ID does not exist, the request is ignored.
|
|
2306
2310
|
*
|
|
2307
2311
|
* @param request - DeleteDiskRequest
|
|
@@ -2310,13 +2314,13 @@ export default class Client extends OpenApi {
|
|
|
2310
2314
|
*/
|
|
2311
2315
|
deleteDiskWithOptions(request: $_model.DeleteDiskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteDiskResponse>;
|
|
2312
2316
|
/**
|
|
2313
|
-
* Releases a pay-as-you-go data disk.
|
|
2317
|
+
* Releases a pay-as-you-go data disk. Disk types include basic disks, ultra disks, standard SSDs, and enterprise SSDs.
|
|
2314
2318
|
*
|
|
2315
2319
|
* @remarks
|
|
2316
2320
|
* When you invoke this operation, take note of the following items:
|
|
2317
2321
|
* - Manual snapshots of the disk are retained.
|
|
2318
|
-
* - You can invoke [ModifyDiskAttribute](https://help.aliyun.com/document_detail/25517.html) to
|
|
2319
|
-
* - The disk must be in the
|
|
2322
|
+
* - You can invoke [ModifyDiskAttribute](https://help.aliyun.com/document_detail/25517.html) to configure the Settings for whether to retain or release automatic snapshots together with the disk. Delete unnecessary snapshots promptly to maintain sufficient snapshot quota for epoch-based automatic snapshot policy.
|
|
2323
|
+
* - The disk must be in the Pending Attach (Available) state when you release it.
|
|
2320
2324
|
* - If the disk with the specified ID does not exist, the request is ignored.
|
|
2321
2325
|
*
|
|
2322
2326
|
* @param request - DeleteDiskRequest
|
|
@@ -2809,13 +2813,13 @@ export default class Client extends OpenApi {
|
|
|
2809
2813
|
*/
|
|
2810
2814
|
deleteSecurityGroup(request: $_model.DeleteSecurityGroupRequest): Promise<$_model.DeleteSecurityGroupResponse>;
|
|
2811
2815
|
/**
|
|
2812
|
-
* Deletes a specified snapshot.
|
|
2816
|
+
* Deletes a specified snapshot. You can also call this operation to cancel a snapshot that is being created.
|
|
2813
2817
|
*
|
|
2814
2818
|
* @remarks
|
|
2815
|
-
*
|
|
2816
|
-
* - If the snapshot does not exist, the request is ignored.
|
|
2817
|
-
* - If the snapshot has been used to create custom
|
|
2818
|
-
* - If the snapshot has been used to create
|
|
2819
|
+
* When you invoke this operation, note the following items:
|
|
2820
|
+
* - If the specified snapshot ID does not exist, the request is ignored.
|
|
2821
|
+
* - If the snapshot has been used to create a custom image, the snapshot cannot be deleted. You must first delete the custom image ([DeleteImage](https://help.aliyun.com/document_detail/25537.html)) before you can delete the snapshot.
|
|
2822
|
+
* - If the snapshot has been used to create a cloud disk and the `Force` parameter is not set or is set to `Force=false`, the snapshot cannot be directly deleted. To delete the snapshot, set `Force=true` to force delete it. After the snapshot is force deleted, the corresponding cloud disk cannot be reinitialized.
|
|
2819
2823
|
*
|
|
2820
2824
|
* @param request - DeleteSnapshotRequest
|
|
2821
2825
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2823,23 +2827,23 @@ export default class Client extends OpenApi {
|
|
|
2823
2827
|
*/
|
|
2824
2828
|
deleteSnapshotWithOptions(request: $_model.DeleteSnapshotRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteSnapshotResponse>;
|
|
2825
2829
|
/**
|
|
2826
|
-
* Deletes a specified snapshot.
|
|
2830
|
+
* Deletes a specified snapshot. You can also call this operation to cancel a snapshot that is being created.
|
|
2827
2831
|
*
|
|
2828
2832
|
* @remarks
|
|
2829
|
-
*
|
|
2830
|
-
* - If the snapshot does not exist, the request is ignored.
|
|
2831
|
-
* - If the snapshot has been used to create custom
|
|
2832
|
-
* - If the snapshot has been used to create
|
|
2833
|
+
* When you invoke this operation, note the following items:
|
|
2834
|
+
* - If the specified snapshot ID does not exist, the request is ignored.
|
|
2835
|
+
* - If the snapshot has been used to create a custom image, the snapshot cannot be deleted. You must first delete the custom image ([DeleteImage](https://help.aliyun.com/document_detail/25537.html)) before you can delete the snapshot.
|
|
2836
|
+
* - If the snapshot has been used to create a cloud disk and the `Force` parameter is not set or is set to `Force=false`, the snapshot cannot be directly deleted. To delete the snapshot, set `Force=true` to force delete it. After the snapshot is force deleted, the corresponding cloud disk cannot be reinitialized.
|
|
2833
2837
|
*
|
|
2834
2838
|
* @param request - DeleteSnapshotRequest
|
|
2835
2839
|
* @returns DeleteSnapshotResponse
|
|
2836
2840
|
*/
|
|
2837
2841
|
deleteSnapshot(request: $_model.DeleteSnapshotRequest): Promise<$_model.DeleteSnapshotResponse>;
|
|
2838
2842
|
/**
|
|
2839
|
-
* Deletes snapshot-consistent
|
|
2843
|
+
* Deletes a snapshot-consistent group.
|
|
2840
2844
|
*
|
|
2841
2845
|
* @remarks
|
|
2842
|
-
* If
|
|
2846
|
+
* If disk snapshots in a snapshot-consistent group have been used to create custom images, the related disk snapshots are not deleted when the snapshot-consistent group is deleted. To delete the related disk snapshots, first delete the custom images ([DeleteImage](https://help.aliyun.com/document_detail/25537.html)), and then delete the related disk snapshots ([DeleteSnapshot](https://help.aliyun.com/document_detail/25525.html)).
|
|
2843
2847
|
*
|
|
2844
2848
|
* @param request - DeleteSnapshotGroupRequest
|
|
2845
2849
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2847,10 +2851,10 @@ export default class Client extends OpenApi {
|
|
|
2847
2851
|
*/
|
|
2848
2852
|
deleteSnapshotGroupWithOptions(request: $_model.DeleteSnapshotGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteSnapshotGroupResponse>;
|
|
2849
2853
|
/**
|
|
2850
|
-
* Deletes snapshot-consistent
|
|
2854
|
+
* Deletes a snapshot-consistent group.
|
|
2851
2855
|
*
|
|
2852
2856
|
* @remarks
|
|
2853
|
-
* If
|
|
2857
|
+
* If disk snapshots in a snapshot-consistent group have been used to create custom images, the related disk snapshots are not deleted when the snapshot-consistent group is deleted. To delete the related disk snapshots, first delete the custom images ([DeleteImage](https://help.aliyun.com/document_detail/25537.html)), and then delete the related disk snapshots ([DeleteSnapshot](https://help.aliyun.com/document_detail/25525.html)).
|
|
2854
2858
|
*
|
|
2855
2859
|
* @param request - DeleteSnapshotGroupRequest
|
|
2856
2860
|
* @returns DeleteSnapshotGroupResponse
|
|
@@ -3575,7 +3579,7 @@ export default class Client extends OpenApi {
|
|
|
3575
3579
|
*/
|
|
3576
3580
|
describeDiagnosticReports(request: $_model.DescribeDiagnosticReportsRequest): Promise<$_model.DescribeDiagnosticReportsResponse>;
|
|
3577
3581
|
/**
|
|
3578
|
-
* Queries the
|
|
3582
|
+
* Queries the key used for account-level default encryption of block storage.
|
|
3579
3583
|
*
|
|
3580
3584
|
* @param request - DescribeDiskDefaultKMSKeyIdRequest
|
|
3581
3585
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3583,14 +3587,14 @@ export default class Client extends OpenApi {
|
|
|
3583
3587
|
*/
|
|
3584
3588
|
describeDiskDefaultKMSKeyIdWithOptions(request: $_model.DescribeDiskDefaultKMSKeyIdRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDiskDefaultKMSKeyIdResponse>;
|
|
3585
3589
|
/**
|
|
3586
|
-
* Queries the
|
|
3590
|
+
* Queries the key used for account-level default encryption of block storage.
|
|
3587
3591
|
*
|
|
3588
3592
|
* @param request - DescribeDiskDefaultKMSKeyIdRequest
|
|
3589
3593
|
* @returns DescribeDiskDefaultKMSKeyIdResponse
|
|
3590
3594
|
*/
|
|
3591
3595
|
describeDiskDefaultKMSKeyId(request: $_model.DescribeDiskDefaultKMSKeyIdRequest): Promise<$_model.DescribeDiskDefaultKMSKeyIdResponse>;
|
|
3592
3596
|
/**
|
|
3593
|
-
* Queries
|
|
3597
|
+
* Queries the service status of account-level default encryption for block storage in a specified region.
|
|
3594
3598
|
*
|
|
3595
3599
|
* @param request - DescribeDiskEncryptionByDefaultStatusRequest
|
|
3596
3600
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3598,7 +3602,7 @@ export default class Client extends OpenApi {
|
|
|
3598
3602
|
*/
|
|
3599
3603
|
describeDiskEncryptionByDefaultStatusWithOptions(request: $_model.DescribeDiskEncryptionByDefaultStatusRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDiskEncryptionByDefaultStatusResponse>;
|
|
3600
3604
|
/**
|
|
3601
|
-
* Queries
|
|
3605
|
+
* Queries the service status of account-level default encryption for block storage in a specified region.
|
|
3602
3606
|
*
|
|
3603
3607
|
* @param request - DescribeDiskEncryptionByDefaultStatusRequest
|
|
3604
3608
|
* @returns DescribeDiskEncryptionByDefaultStatusResponse
|
|
@@ -3995,13 +3999,13 @@ export default class Client extends OpenApi {
|
|
|
3995
3999
|
*/
|
|
3996
4000
|
describeImageSupportInstanceTypes(request: $_model.DescribeImageSupportInstanceTypesRequest): Promise<$_model.DescribeImageSupportInstanceTypesResponse>;
|
|
3997
4001
|
/**
|
|
3998
|
-
*
|
|
4002
|
+
* Queries the list of image resources that you can use by specifying parameters such as ImageId, image usage scenarios, and Filter conditions.
|
|
3999
4003
|
*
|
|
4000
4004
|
* @remarks
|
|
4001
|
-
* -
|
|
4002
|
-
* -
|
|
4003
|
-
* - When
|
|
4004
|
-
* - When
|
|
4005
|
+
* - 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.
|
|
4006
|
+
* - 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.
|
|
4007
|
+
* - 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).
|
|
4008
|
+
* - 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).
|
|
4005
4009
|
*
|
|
4006
4010
|
* @param request - DescribeImagesRequest
|
|
4007
4011
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4009,13 +4013,13 @@ export default class Client extends OpenApi {
|
|
|
4009
4013
|
*/
|
|
4010
4014
|
describeImagesWithOptions(request: $_model.DescribeImagesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeImagesResponse>;
|
|
4011
4015
|
/**
|
|
4012
|
-
*
|
|
4016
|
+
* Queries the list of image resources that you can use by specifying parameters such as ImageId, image usage scenarios, and Filter conditions.
|
|
4013
4017
|
*
|
|
4014
4018
|
* @remarks
|
|
4015
|
-
* -
|
|
4016
|
-
* -
|
|
4017
|
-
* - When
|
|
4018
|
-
* - When
|
|
4019
|
+
* - 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.
|
|
4020
|
+
* - 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.
|
|
4021
|
+
* - 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).
|
|
4022
|
+
* - 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).
|
|
4019
4023
|
*
|
|
4020
4024
|
* @param request - DescribeImagesRequest
|
|
4021
4025
|
* @returns DescribeImagesResponse
|
|
@@ -4895,7 +4899,7 @@ export default class Client extends OpenApi {
|
|
|
4895
4899
|
*/
|
|
4896
4900
|
describePrice(request: $_model.DescribePriceRequest): Promise<$_model.DescribePriceResponse>;
|
|
4897
4901
|
/**
|
|
4898
|
-
*
|
|
4902
|
+
* (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.
|
|
4899
4903
|
*
|
|
4900
4904
|
* @param request - DescribeRecommendInstanceTypeRequest
|
|
4901
4905
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4903,7 +4907,7 @@ export default class Client extends OpenApi {
|
|
|
4903
4907
|
*/
|
|
4904
4908
|
describeRecommendInstanceTypeWithOptions(request: $_model.DescribeRecommendInstanceTypeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeRecommendInstanceTypeResponse>;
|
|
4905
4909
|
/**
|
|
4906
|
-
*
|
|
4910
|
+
* (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.
|
|
4907
4911
|
*
|
|
4908
4912
|
* @param request - DescribeRecommendInstanceTypeRequest
|
|
4909
4913
|
* @returns DescribeRecommendInstanceTypeResponse
|
|
@@ -5269,13 +5273,13 @@ export default class Client extends OpenApi {
|
|
|
5269
5273
|
*/
|
|
5270
5274
|
describeSecurityGroups(request: $_model.DescribeSecurityGroupsRequest): Promise<$_model.DescribeSecurityGroupsResponse>;
|
|
5271
5275
|
/**
|
|
5272
|
-
* Queries the list and status of files sent by Cloud Assistant
|
|
5276
|
+
* Queries the list and status of files sent by Cloud Assistant.
|
|
5273
5277
|
*
|
|
5274
5278
|
* @remarks
|
|
5275
5279
|
* ## Operation description:
|
|
5276
|
-
* - After you send a file, the file is not necessarily sent. You must check the actual
|
|
5277
|
-
* - You can query execution information from the last
|
|
5278
|
-
* - When
|
|
5280
|
+
* - After you send a file, the file is not necessarily sent successfully. You must check the actual delivery result based on the return value of this operation. The actual output prevails.
|
|
5281
|
+
* - You can query execution information from the last day. A maximum of 1,000 entries of execution information can be retained.
|
|
5282
|
+
* - When you execute a paging query for the first page, set only `MaxResults` to limit the number of entries returned. The `NextToken` value in the response serves as the token for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the value obtained from the previous response and set `MaxResults` to limit the number of entries returned.
|
|
5279
5283
|
*
|
|
5280
5284
|
* @param request - DescribeSendFileResultsRequest
|
|
5281
5285
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5283,23 +5287,23 @@ export default class Client extends OpenApi {
|
|
|
5283
5287
|
*/
|
|
5284
5288
|
describeSendFileResultsWithOptions(request: $_model.DescribeSendFileResultsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSendFileResultsResponse>;
|
|
5285
5289
|
/**
|
|
5286
|
-
* Queries the list and status of files sent by Cloud Assistant
|
|
5290
|
+
* Queries the list and status of files sent by Cloud Assistant.
|
|
5287
5291
|
*
|
|
5288
5292
|
* @remarks
|
|
5289
5293
|
* ## Operation description:
|
|
5290
|
-
* - After you send a file, the file is not necessarily sent. You must check the actual
|
|
5291
|
-
* - You can query execution information from the last
|
|
5292
|
-
* - When
|
|
5294
|
+
* - After you send a file, the file is not necessarily sent successfully. You must check the actual delivery result based on the return value of this operation. The actual output prevails.
|
|
5295
|
+
* - You can query execution information from the last day. A maximum of 1,000 entries of execution information can be retained.
|
|
5296
|
+
* - When you execute a paging query for the first page, set only `MaxResults` to limit the number of entries returned. The `NextToken` value in the response serves as the token for querying subsequent pages. When querying subsequent pages, set the `NextToken` parameter to the value obtained from the previous response and set `MaxResults` to limit the number of entries returned.
|
|
5293
5297
|
*
|
|
5294
5298
|
* @param request - DescribeSendFileResultsRequest
|
|
5295
5299
|
* @returns DescribeSendFileResultsResponse
|
|
5296
5300
|
*/
|
|
5297
5301
|
describeSendFileResults(request: $_model.DescribeSendFileResultsRequest): Promise<$_model.DescribeSendFileResultsResponse>;
|
|
5298
5302
|
/**
|
|
5299
|
-
* Queries
|
|
5303
|
+
* Queries information about one or more snapshot-consistent groups, such as the status, associated instance ID, and snapshot creation progress.
|
|
5300
5304
|
*
|
|
5301
5305
|
* @remarks
|
|
5302
|
-
*
|
|
5306
|
+
* `InstanceId`, `SnapshotGroupId.N`, and `Status.N` are not required request parameters, but they can be used to build filter logic. The parameters have a logical AND relationship.
|
|
5303
5307
|
*
|
|
5304
5308
|
* @param request - DescribeSnapshotGroupsRequest
|
|
5305
5309
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5307,10 +5311,10 @@ export default class Client extends OpenApi {
|
|
|
5307
5311
|
*/
|
|
5308
5312
|
describeSnapshotGroupsWithOptions(request: $_model.DescribeSnapshotGroupsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSnapshotGroupsResponse>;
|
|
5309
5313
|
/**
|
|
5310
|
-
* Queries
|
|
5314
|
+
* Queries information about one or more snapshot-consistent groups, such as the status, associated instance ID, and snapshot creation progress.
|
|
5311
5315
|
*
|
|
5312
5316
|
* @remarks
|
|
5313
|
-
*
|
|
5317
|
+
* `InstanceId`, `SnapshotGroupId.N`, and `Status.N` are not required request parameters, but they can be used to build filter logic. The parameters have a logical AND relationship.
|
|
5314
5318
|
*
|
|
5315
5319
|
* @param request - DescribeSnapshotGroupsRequest
|
|
5316
5320
|
* @returns DescribeSnapshotGroupsResponse
|
|
@@ -5986,14 +5990,14 @@ export default class Client extends OpenApi {
|
|
|
5986
5990
|
*/
|
|
5987
5991
|
disableActivation(request: $_model.DisableActivationRequest): Promise<$_model.DisableActivationResponse>;
|
|
5988
5992
|
/**
|
|
5989
|
-
* Disables
|
|
5993
|
+
* Disables the account-level default encryption for block storage in a specified region.
|
|
5990
5994
|
*
|
|
5991
5995
|
* @remarks
|
|
5992
|
-
* - **
|
|
5993
|
-
* -
|
|
5994
|
-
* - **
|
|
5995
|
-
* - After
|
|
5996
|
-
* - After
|
|
5996
|
+
* - **Before you begin**
|
|
5997
|
+
* - Resource Access Management (RAM) users require the `AliyunECSFullAccess` permission. For more information about how to perform authorization, see [Grant permissions to a RAM user](https://help.aliyun.com/document_detail/116146.html).
|
|
5998
|
+
* - **Usage notes**
|
|
5999
|
+
* - After you shutdown account-level default encryption for block storage, the encryption status of existing cloud disks is not affected.
|
|
6000
|
+
* - After you shutdown account-level default encryption for block storage, you can still manually select encryption when you create cloud disks.
|
|
5997
6001
|
*
|
|
5998
6002
|
* @param request - DisableDiskEncryptionByDefaultRequest
|
|
5999
6003
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6001,14 +6005,14 @@ export default class Client extends OpenApi {
|
|
|
6001
6005
|
*/
|
|
6002
6006
|
disableDiskEncryptionByDefaultWithOptions(request: $_model.DisableDiskEncryptionByDefaultRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DisableDiskEncryptionByDefaultResponse>;
|
|
6003
6007
|
/**
|
|
6004
|
-
* Disables
|
|
6008
|
+
* Disables the account-level default encryption for block storage in a specified region.
|
|
6005
6009
|
*
|
|
6006
6010
|
* @remarks
|
|
6007
|
-
* - **
|
|
6008
|
-
* -
|
|
6009
|
-
* - **
|
|
6010
|
-
* - After
|
|
6011
|
-
* - After
|
|
6011
|
+
* - **Before you begin**
|
|
6012
|
+
* - Resource Access Management (RAM) users require the `AliyunECSFullAccess` permission. For more information about how to perform authorization, see [Grant permissions to a RAM user](https://help.aliyun.com/document_detail/116146.html).
|
|
6013
|
+
* - **Usage notes**
|
|
6014
|
+
* - After you shutdown account-level default encryption for block storage, the encryption status of existing cloud disks is not affected.
|
|
6015
|
+
* - After you shutdown account-level default encryption for block storage, you can still manually select encryption when you create cloud disks.
|
|
6012
6016
|
*
|
|
6013
6017
|
* @param request - DisableDiskEncryptionByDefaultRequest
|
|
6014
6018
|
* @returns DisableDiskEncryptionByDefaultResponse
|