@alicloud/ecs20140526 7.9.0 → 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.
Files changed (41) hide show
  1. package/dist/client.d.ts +108 -110
  2. package/dist/client.js +108 -110
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CloneDisksRequest.d.ts +55 -80
  5. package/dist/models/CloneDisksRequest.js.map +1 -1
  6. package/dist/models/CloneDisksResponseBody.d.ts +2 -2
  7. package/dist/models/CreateAutoProvisioningGroupRequest.d.ts +286 -380
  8. package/dist/models/CreateAutoProvisioningGroupRequest.js.map +1 -1
  9. package/dist/models/CreateAutoProvisioningGroupShrinkRequest.d.ts +282 -375
  10. package/dist/models/CreateAutoProvisioningGroupShrinkRequest.js.map +1 -1
  11. package/dist/models/CreateImageRequest.d.ts +43 -88
  12. package/dist/models/CreateImageRequest.js.map +1 -1
  13. package/dist/models/CreateImageResponseBody.d.ts +2 -2
  14. package/dist/models/CreateLaunchTemplateRequest.d.ts +235 -278
  15. package/dist/models/CreateLaunchTemplateRequest.js.map +1 -1
  16. package/dist/models/CreateLaunchTemplateResponseBody.d.ts +3 -3
  17. package/dist/models/CreateVswitchRequest.d.ts +0 -29
  18. package/dist/models/CreateVswitchRequest.js.map +1 -1
  19. package/dist/models/CreateVswitchResponseBody.d.ts +0 -8
  20. package/dist/models/CreateVswitchResponseBody.js.map +1 -1
  21. package/dist/models/DescribeImagesRequest.d.ts +61 -89
  22. package/dist/models/DescribeImagesRequest.js.map +1 -1
  23. package/dist/models/DescribeImagesResponseBody.d.ts +5 -5
  24. package/dist/models/DescribeRecommendInstanceTypeRequest.d.ts +4 -4
  25. package/dist/models/RenewElasticityAssurancesRequest.d.ts +3 -3
  26. package/package.json +1 -1
  27. package/src/client.ts +108 -110
  28. package/src/models/CloneDisksRequest.ts +55 -80
  29. package/src/models/CloneDisksResponseBody.ts +2 -2
  30. package/src/models/CreateAutoProvisioningGroupRequest.ts +287 -381
  31. package/src/models/CreateAutoProvisioningGroupShrinkRequest.ts +283 -376
  32. package/src/models/CreateImageRequest.ts +43 -88
  33. package/src/models/CreateImageResponseBody.ts +2 -2
  34. package/src/models/CreateLaunchTemplateRequest.ts +235 -278
  35. package/src/models/CreateLaunchTemplateResponseBody.ts +3 -3
  36. package/src/models/CreateVswitchRequest.ts +0 -29
  37. package/src/models/CreateVswitchResponseBody.ts +0 -8
  38. package/src/models/DescribeImagesRequest.ts +62 -90
  39. package/src/models/DescribeImagesResponseBody.ts +5 -5
  40. package/src/models/DescribeRecommendInstanceTypeRequest.ts +4 -4
  41. package/src/models/RenewElasticityAssurancesRequest.ts +3 -3
package/src/client.ts CHANGED
@@ -2504,29 +2504,29 @@ export default class Client extends OpenApi {
2504
2504
  }
2505
2505
 
2506
2506
  /**
2507
- * Cloud disk cloning allows you to quickly create a new cloud disk in the same availability zone containing the same data as the source disk. You can customize the new disk\\"s capacity, type, and encryption attributes. After attaching the disk to an instance, you can use it to rapidly replicate business data or scale your services horizontally.
2507
+ * 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.
2508
2508
  *
2509
2509
  * @remarks
2510
- * > The cloud disk cloning feature is free. However, the resulting destination disk is billed based on block storage rules. Charges vary by disk type and can include capacity, provisioned performance, and burst performance. Billing for all items begins at creation—except for burst performance fees, which are charged only after a burst occurs—and applies regardless of whether the disk is attached to an instance.
2511
- * ### Usage
2512
- * - This is an asynchronous operation. After a successful call, call the DescribeTasks operation with the returned taskGroupId to query the task\\"s status.
2510
+ * > 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.
2511
+ * ### How to use
2512
+ * - This is an asynchronous operation. After a successful call, use the taskGroupId and call the DescribeTasks operation to obtain the execution result.
2513
2513
  * ### Features
2514
- * - You can only clone ESSD cloud disks (cloud_essd, cloud_auto, cloud_essd_entry, and cloud_regional_disk_auto) to create a `destination disk`, which must also be an ESSD type.
2515
- * - A non-zone-redundant cloud disk can only be cloned to a non-zone-redundant disk. A zone-redundant cloud disk can only be cloned to another zone-redundant cloud disk.
2516
- * - Local disks and elastic ephemeral disks do not support cloning and cannot be used as either a source disk or a destination disk.
2517
- * - You can specify the type and performance level for the `destination disk`.
2518
- * - You can specify the capacity for the `destination disk`, but its capacity must be greater than or equal to that of the `source disk`.
2519
- * - You can configure provisioned performance and burst performance for the `destination disk`, provided that the destination disk type supports these features.
2520
- * - You can enable encryption and change the encryption key for the `destination disk`. If the `source disk` is encrypted, the destination disk must also be encrypted. However, you can use a different encryption key.
2521
- * - You can use a subscription cloud disk as the `source disk`. The disk can still be used as a `source disk` even after its subscription expires.
2522
- * - A `destination disk` created by cloning cannot be re-initialized.
2523
- * - While you cannot clone entire storage sets or dedicated storage clusters, you can use a disk from within them as a `source disk`. The resulting destination disk is a standalone disk and will not belong to the original storage set or cluster.
2524
- * - `source disk` status requirements
2525
- * - The `source disk` must be "In Use", and its attached instance must be "Running" or "Stopped".
2526
- * - The `source disk` must be "Available" and have been attached to an instance at least once.
2527
- * - A disk undergoing a configuration modification cannot be used as a `source disk`.
2528
- * - A disk that is being scaled up cannot be used as a `source disk`.
2529
- * - As cloud disk cloning is not supported for hibernated instances, a disk attached to a hibernated instance cannot be used as a `source disk`.
2514
+ * - 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.
2515
+ * - Non-regional disks can only be cloned to non-regional disk types. Regional disks can only be cloned to regional disk types.
2516
+ * - Local disks and elastic ephemeral disks cannot be cloned or used as clone sources.
2517
+ * - You can specify the `new disk` type and performance level (PL) during cloning.
2518
+ * - 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.
2519
+ * - You can configure provisioned performance and performance burst for the `new disk`, provided that the destination disk type supports provisioned performance and performance burst.
2520
+ * - 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.
2521
+ * - 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`.
2522
+ * - The `new disk` created by cloning does not support reinitialization.
2523
+ * - 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.
2524
+ * - `Source disk` status restrictions:
2525
+ * - The `source disk` status is "In Use" and the corresponding instance status is "Running" or "Stopped".
2526
+ * - The `source disk` status is "Available" and the disk has been previously attached.
2527
+ * - A disk undergoing a specification change cannot be used as the `source disk`.
2528
+ * - A disk undergoing expansion cannot be used as the `source disk`.
2529
+ * - 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`.
2530
2530
  *
2531
2531
  * @param request - CloneDisksRequest
2532
2532
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2625,29 +2625,29 @@ export default class Client extends OpenApi {
2625
2625
  }
2626
2626
 
2627
2627
  /**
2628
- * Cloud disk cloning allows you to quickly create a new cloud disk in the same availability zone containing the same data as the source disk. You can customize the new disk\\"s capacity, type, and encryption attributes. After attaching the disk to an instance, you can use it to rapidly replicate business data or scale your services horizontally.
2628
+ * 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.
2629
2629
  *
2630
2630
  * @remarks
2631
- * > The cloud disk cloning feature is free. However, the resulting destination disk is billed based on block storage rules. Charges vary by disk type and can include capacity, provisioned performance, and burst performance. Billing for all items begins at creation—except for burst performance fees, which are charged only after a burst occurs—and applies regardless of whether the disk is attached to an instance.
2632
- * ### Usage
2633
- * - This is an asynchronous operation. After a successful call, call the DescribeTasks operation with the returned taskGroupId to query the task\\"s status.
2631
+ * > 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.
2632
+ * ### How to use
2633
+ * - This is an asynchronous operation. After a successful call, use the taskGroupId and call the DescribeTasks operation to obtain the execution result.
2634
2634
  * ### Features
2635
- * - You can only clone ESSD cloud disks (cloud_essd, cloud_auto, cloud_essd_entry, and cloud_regional_disk_auto) to create a `destination disk`, which must also be an ESSD type.
2636
- * - A non-zone-redundant cloud disk can only be cloned to a non-zone-redundant disk. A zone-redundant cloud disk can only be cloned to another zone-redundant cloud disk.
2637
- * - Local disks and elastic ephemeral disks do not support cloning and cannot be used as either a source disk or a destination disk.
2638
- * - You can specify the type and performance level for the `destination disk`.
2639
- * - You can specify the capacity for the `destination disk`, but its capacity must be greater than or equal to that of the `source disk`.
2640
- * - You can configure provisioned performance and burst performance for the `destination disk`, provided that the destination disk type supports these features.
2641
- * - You can enable encryption and change the encryption key for the `destination disk`. If the `source disk` is encrypted, the destination disk must also be encrypted. However, you can use a different encryption key.
2642
- * - You can use a subscription cloud disk as the `source disk`. The disk can still be used as a `source disk` even after its subscription expires.
2643
- * - A `destination disk` created by cloning cannot be re-initialized.
2644
- * - While you cannot clone entire storage sets or dedicated storage clusters, you can use a disk from within them as a `source disk`. The resulting destination disk is a standalone disk and will not belong to the original storage set or cluster.
2645
- * - `source disk` status requirements
2646
- * - The `source disk` must be "In Use", and its attached instance must be "Running" or "Stopped".
2647
- * - The `source disk` must be "Available" and have been attached to an instance at least once.
2648
- * - A disk undergoing a configuration modification cannot be used as a `source disk`.
2649
- * - A disk that is being scaled up cannot be used as a `source disk`.
2650
- * - As cloud disk cloning is not supported for hibernated instances, a disk attached to a hibernated instance cannot be used as a `source disk`.
2635
+ * - 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.
2636
+ * - Non-regional disks can only be cloned to non-regional disk types. Regional disks can only be cloned to regional disk types.
2637
+ * - Local disks and elastic ephemeral disks cannot be cloned or used as clone sources.
2638
+ * - You can specify the `new disk` type and performance level (PL) during cloning.
2639
+ * - 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.
2640
+ * - You can configure provisioned performance and performance burst for the `new disk`, provided that the destination disk type supports provisioned performance and performance burst.
2641
+ * - 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.
2642
+ * - 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`.
2643
+ * - The `new disk` created by cloning does not support reinitialization.
2644
+ * - 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.
2645
+ * - `Source disk` status restrictions:
2646
+ * - The `source disk` status is "In Use" and the corresponding instance status is "Running" or "Stopped".
2647
+ * - The `source disk` status is "Available" and the disk has been previously attached.
2648
+ * - A disk undergoing a specification change cannot be used as the `source disk`.
2649
+ * - A disk undergoing expansion cannot be used as the `source disk`.
2650
+ * - 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`.
2651
2651
  *
2652
2652
  * @param request - CloneDisksRequest
2653
2653
  * @returns CloneDisksResponse
@@ -3161,13 +3161,13 @@ export default class Client extends OpenApi {
3161
3161
  }
3162
3162
 
3163
3163
  /**
3164
- * Create an auto provisioning group.
3164
+ * Creates an auto provisioning group.
3165
3165
  *
3166
3166
  * @remarks
3167
- * - 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 multiple ECS instances](https://help.aliyun.com/document_detail/200772.html).
3168
- * - Auto provisioning schedules and maintains compute resources through provisioning groups. Use auto provisioning groups to provide stable computing power and mitigate instability caused by the spot instance reclamation mechanism.
3169
- * - Auto provisioning is a free feature. You pay only for the instance resources created through 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).
3170
- * - When you specify both a launch template (`LaunchTemplateId`) and launch configuration parameters (`LaunchConfiguration.*`), the system prioritizes the launch template.
3167
+ * - 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).
3168
+ * - 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.
3169
+ * - 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).
3170
+ * - If you specify both a launch template (`LaunchTemplateId`) and launch configuration information (`LaunchConfiguration.*`), the launch template takes precedence.
3171
3171
  *
3172
3172
  * @param tmpReq - CreateAutoProvisioningGroupRequest
3173
3173
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3348,13 +3348,13 @@ export default class Client extends OpenApi {
3348
3348
  }
3349
3349
 
3350
3350
  /**
3351
- * Create an auto provisioning group.
3351
+ * Creates an auto provisioning group.
3352
3352
  *
3353
3353
  * @remarks
3354
- * - 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 multiple ECS instances](https://help.aliyun.com/document_detail/200772.html).
3355
- * - Auto provisioning schedules and maintains compute resources through provisioning groups. Use auto provisioning groups to provide stable computing power and mitigate instability caused by the spot instance reclamation mechanism.
3356
- * - Auto provisioning is a free feature. You pay only for the instance resources created through 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).
3357
- * - When you specify both a launch template (`LaunchTemplateId`) and launch configuration parameters (`LaunchConfiguration.*`), the system prioritizes the launch template.
3354
+ * - 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).
3355
+ * - 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.
3356
+ * - 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).
3357
+ * - If you specify both a launch template (`LaunchTemplateId`) and launch configuration information (`LaunchConfiguration.*`), the launch template takes precedence.
3358
3358
  *
3359
3359
  * @param request - CreateAutoProvisioningGroupRequest
3360
3360
  * @returns CreateAutoProvisioningGroupResponse
@@ -4595,26 +4595,25 @@ export default class Client extends OpenApi {
4595
4595
  }
4596
4596
 
4597
4597
  /**
4598
- * Create a custom image. You can then use the image to create ECS instances (`RunInstances`) or replace the system disk of an instance (`ReplaceSystemDisk`).
4598
+ * 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).
4599
4599
  *
4600
4600
  * @remarks
4601
- * ### Usage notes
4602
- * - This operation is asynchronous. A successful request returns an image ID, but the image is not created immediately. You can call [DescribeImage](https://help.aliyun.com/document_detail/2679797.html) to query the image status. The image is ready for use when its status changes to `Available`. For more information, see [Overview of custom images](https://help.aliyun.com/document_detail/172789.html).
4603
- * - If the response to a query for ECS instance information contains `{"OperationLocks": {"LockReason" : "security"}}`, you cannot create a custom image from the instance.
4604
- * - We recommend configuring the image check parameter `DetectionStrategy` when you create an image. This helps the system optimize your image. For more information, see [Overview of image check](https://help.aliyun.com/document_detail/439819.html).
4605
- * This operation provides three methods to create a custom image. The request parameters are prioritized as follows: InstanceId > DiskDeviceMapping > SnapshotId. If your request includes two or more of these parameters, the operation creates the image based on the parameter with the highest priority.
4601
+ * ### Before you begin
4602
+ * - 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).
4603
+ * - When you query ECS instance information, if the response contains {"OperationLocks": {"LockReason" : "security"}}, you cannot create a custom image.
4604
+ * - 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).
4605
+ * 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.
4606
4606
  * - **Create a custom image from an instance**: Specify the instance ID (`InstanceId`).
4607
- * - The instance must be in the `Running` or `Stopped` state.
4608
- * - A successful call creates a new snapshot for each cloud disk of the instance.
4609
- * >Notice:
4610
- * Data cached in memory on a running instance may not be written to disk. This can cause data inconsistencies between the custom image and the instance. We recommend stopping the instance by calling [StopInstances](https://help.aliyun.com/document_detail/155372.html) before creating an image.
4611
- *
4612
- * - **Create a custom image from a snapshot (snapshots created on or before July 15, 2013, cannot be used).**
4613
- * - **Create a custom image from a system disk snapshot**: Specify only the snapshot ID of the instance\\"s system disk (`SnapshotId`).
4614
- * - **Create a custom image from a system disk snapshot and data disk snapshots**: Map the snapshots to disks by using the `DiskDeviceMapping` parameter.
4615
- * - You can specify only one system disk snapshot.
4616
- * - You can specify up to 16 data disk snapshots. If you do not specify `DiskDeviceMapping.N.SnapshotId`, the system creates an empty data disk with the default capacity.
4617
- * > 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.
4607
+ * - The instance must be in the Running (`Running`) or Stopped (`Stopped`) state.
4608
+ * - After the operation is called, a new snapshot is created for each disk of the instance.
4609
+ * >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.
4610
+ * - **Create a custom image from a snapshot (the specified snapshot cannot be one created on or before July 15, 2013.)**
4611
+ * - **Create a custom image from a system disk snapshot**: Specify only the snapshot ID of the instance system disk (`SnapshotId`).
4612
+ * - **Create a custom image from system disk and data disk snapshots**: Establish data associations among multiple disks (`DiskDeviceMapping`).
4613
+ * - Only one system disk snapshot can be specified.
4614
+ * - 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.
4615
+ *
4616
+ * > 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.
4618
4617
  *
4619
4618
  * @param request - CreateImageRequest
4620
4619
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4725,26 +4724,25 @@ export default class Client extends OpenApi {
4725
4724
  }
4726
4725
 
4727
4726
  /**
4728
- * Create a custom image. You can then use the image to create ECS instances (`RunInstances`) or replace the system disk of an instance (`ReplaceSystemDisk`).
4727
+ * 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).
4729
4728
  *
4730
4729
  * @remarks
4731
- * ### Usage notes
4732
- * - This operation is asynchronous. A successful request returns an image ID, but the image is not created immediately. You can call [DescribeImage](https://help.aliyun.com/document_detail/2679797.html) to query the image status. The image is ready for use when its status changes to `Available`. For more information, see [Overview of custom images](https://help.aliyun.com/document_detail/172789.html).
4733
- * - If the response to a query for ECS instance information contains `{"OperationLocks": {"LockReason" : "security"}}`, you cannot create a custom image from the instance.
4734
- * - We recommend configuring the image check parameter `DetectionStrategy` when you create an image. This helps the system optimize your image. For more information, see [Overview of image check](https://help.aliyun.com/document_detail/439819.html).
4735
- * This operation provides three methods to create a custom image. The request parameters are prioritized as follows: InstanceId > DiskDeviceMapping > SnapshotId. If your request includes two or more of these parameters, the operation creates the image based on the parameter with the highest priority.
4730
+ * ### Before you begin
4731
+ * - 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).
4732
+ * - When you query ECS instance information, if the response contains {"OperationLocks": {"LockReason" : "security"}}, you cannot create a custom image.
4733
+ * - 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).
4734
+ * 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.
4736
4735
  * - **Create a custom image from an instance**: Specify the instance ID (`InstanceId`).
4737
- * - The instance must be in the `Running` or `Stopped` state.
4738
- * - A successful call creates a new snapshot for each cloud disk of the instance.
4739
- * >Notice:
4740
- * Data cached in memory on a running instance may not be written to disk. This can cause data inconsistencies between the custom image and the instance. We recommend stopping the instance by calling [StopInstances](https://help.aliyun.com/document_detail/155372.html) before creating an image.
4741
- *
4742
- * - **Create a custom image from a snapshot (snapshots created on or before July 15, 2013, cannot be used).**
4743
- * - **Create a custom image from a system disk snapshot**: Specify only the snapshot ID of the instance\\"s system disk (`SnapshotId`).
4744
- * - **Create a custom image from a system disk snapshot and data disk snapshots**: Map the snapshots to disks by using the `DiskDeviceMapping` parameter.
4745
- * - You can specify only one system disk snapshot.
4746
- * - You can specify up to 16 data disk snapshots. If you do not specify `DiskDeviceMapping.N.SnapshotId`, the system creates an empty data disk with the default capacity.
4747
- * > 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.
4736
+ * - The instance must be in the Running (`Running`) or Stopped (`Stopped`) state.
4737
+ * - After the operation is called, a new snapshot is created for each disk of the instance.
4738
+ * >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.
4739
+ * - **Create a custom image from a snapshot (the specified snapshot cannot be one created on or before July 15, 2013.)**
4740
+ * - **Create a custom image from a system disk snapshot**: Specify only the snapshot ID of the instance system disk (`SnapshotId`).
4741
+ * - **Create a custom image from system disk and data disk snapshots**: Establish data associations among multiple disks (`DiskDeviceMapping`).
4742
+ * - Only one system disk snapshot can be specified.
4743
+ * - 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.
4744
+ *
4745
+ * > 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.
4748
4746
  *
4749
4747
  * @param request - CreateImageRequest
4750
4748
  * @returns CreateImageResponse
@@ -5459,15 +5457,15 @@ export default class Client extends OpenApi {
5459
5457
  }
5460
5458
 
5461
5459
  /**
5462
- * Create an ECS instance launch template, abbreviated as a template. An instance launch template eliminates the need to enter numerous configuration parameters each time you create an instance.
5460
+ * 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.
5463
5461
  *
5464
5462
  * @remarks
5465
- * After you invoke CreateLaunchTemplate to create a template, Alibaba Cloud automatically generates a default version of the template with version number 1. You can subsequently create multiple versions based on this template by calling `CreateLaunchTemplateVersion`. Version numbers start from 1 and increment sequentially. If you do not specify a template version when creating an instance ([RunInstances](https://help.aliyun.com/document_detail/63440.html)), the default version is used.
5466
- * A launch template version includes configurations required for instance creation, such as the Region, image ID, instance type, security group ID, and Internet bandwidth. If a particular configuration is not specified in the template version, you must provide it explicitly when creating the instance.
5467
- * When invoking this API, note the following:
5468
- * - Each account can create up to 30 launch templates per Region, and each template can have up to 30 versions.
5469
- * - Most parameters in a launch template are optional. Alibaba Cloud does not validate the existence or validity of parameter values when you create the template. Validation occurs only when you actually create an instance.
5470
- * - If a configuration is set in the launch template, you cannot omit it when creating an instance ([RunInstances](https://help.aliyun.com/document_detail/63440.html)). For example, if the template sets `HostName=LocalHost`, and you leave `HostName` empty in `RunInstances`, the instance hostname will still be `LocalHost`. To overwrite the `HostName=LocalHost` setting, specify a different value such as `HostName=MyHost` in `RunInstances`.
5463
+ * 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.
5464
+ * 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.
5465
+ * When you call this operation, take note of the following items:
5466
+ * - Each account can create up to 30 launch templates per region, and each template can have up to 30 versions.
5467
+ * - 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.
5468
+ * - 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`.
5471
5469
  *
5472
5470
  * @param request - CreateLaunchTemplateRequest
5473
5471
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5718,15 +5716,15 @@ export default class Client extends OpenApi {
5718
5716
  }
5719
5717
 
5720
5718
  /**
5721
- * Create an ECS instance launch template, abbreviated as a template. An instance launch template eliminates the need to enter numerous configuration parameters each time you create an instance.
5719
+ * 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.
5722
5720
  *
5723
5721
  * @remarks
5724
- * After you invoke CreateLaunchTemplate to create a template, Alibaba Cloud automatically generates a default version of the template with version number 1. You can subsequently create multiple versions based on this template by calling `CreateLaunchTemplateVersion`. Version numbers start from 1 and increment sequentially. If you do not specify a template version when creating an instance ([RunInstances](https://help.aliyun.com/document_detail/63440.html)), the default version is used.
5725
- * A launch template version includes configurations required for instance creation, such as the Region, image ID, instance type, security group ID, and Internet bandwidth. If a particular configuration is not specified in the template version, you must provide it explicitly when creating the instance.
5726
- * When invoking this API, note the following:
5727
- * - Each account can create up to 30 launch templates per Region, and each template can have up to 30 versions.
5728
- * - Most parameters in a launch template are optional. Alibaba Cloud does not validate the existence or validity of parameter values when you create the template. Validation occurs only when you actually create an instance.
5729
- * - If a configuration is set in the launch template, you cannot omit it when creating an instance ([RunInstances](https://help.aliyun.com/document_detail/63440.html)). For example, if the template sets `HostName=LocalHost`, and you leave `HostName` empty in `RunInstances`, the instance hostname will still be `LocalHost`. To overwrite the `HostName=LocalHost` setting, specify a different value such as `HostName=MyHost` in `RunInstances`.
5722
+ * 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.
5723
+ * 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.
5724
+ * When you call this operation, take note of the following items:
5725
+ * - Each account can create up to 30 launch templates per region, and each template can have up to 30 versions.
5726
+ * - 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.
5727
+ * - 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`.
5730
5728
  *
5731
5729
  * @param request - CreateLaunchTemplateRequest
5732
5730
  * @returns CreateLaunchTemplateResponse
@@ -15005,13 +15003,13 @@ export default class Client extends OpenApi {
15005
15003
  }
15006
15004
 
15007
15005
  /**
15008
- * Specify parameters such as ImageId, image usage scenario, and Filter to query the list of image resources you can use.
15006
+ * Queries the list of available image resources based on specified parameters such as ImageId, image usage scenarios, and filter conditions.
15009
15007
  *
15010
15008
  * @remarks
15011
- * - The image resources you can query include your custom images, public images provided by Alibaba Cloud, Alibaba Cloud Marketplace images, and shared images actively shared with you by other Alibaba Cloud users.
15012
- * - Paged query is supported. The query results include the total number of usable image resources and the image resources on the current page. The default number of entries per page is 10.
15013
- * - When invoking the API through the Alibaba Cloud command-line interface (CLI), the values of request parameters of different data types must comply with format requirements. For more information, see [CLI Parameter Format Description](https://help.aliyun.com/document_detail/110340.html).
15014
- * - When querying official Alibaba Cloud images or shared images (where ImageOwnerAlias is set to system or others), RAM authentication rules are ignored for this request. For more information, see [Authentication Rules](https://help.aliyun.com/document_detail/25497.html).
15009
+ * - 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.
15010
+ * - 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.
15011
+ * - 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).
15012
+ * - 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).
15015
15013
  *
15016
15014
  * @param request - DescribeImagesRequest
15017
15015
  * @param runtime - runtime options for this request RuntimeOptions
@@ -15146,13 +15144,13 @@ export default class Client extends OpenApi {
15146
15144
  }
15147
15145
 
15148
15146
  /**
15149
- * Specify parameters such as ImageId, image usage scenario, and Filter to query the list of image resources you can use.
15147
+ * Queries the list of available image resources based on specified parameters such as ImageId, image usage scenarios, and filter conditions.
15150
15148
  *
15151
15149
  * @remarks
15152
- * - The image resources you can query include your custom images, public images provided by Alibaba Cloud, Alibaba Cloud Marketplace images, and shared images actively shared with you by other Alibaba Cloud users.
15153
- * - Paged query is supported. The query results include the total number of usable image resources and the image resources on the current page. The default number of entries per page is 10.
15154
- * - When invoking the API through the Alibaba Cloud command-line interface (CLI), the values of request parameters of different data types must comply with format requirements. For more information, see [CLI Parameter Format Description](https://help.aliyun.com/document_detail/110340.html).
15155
- * - When querying official Alibaba Cloud images or shared images (where ImageOwnerAlias is set to system or others), RAM authentication rules are ignored for this request. For more information, see [Authentication Rules](https://help.aliyun.com/document_detail/25497.html).
15150
+ * - 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.
15151
+ * - 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.
15152
+ * - 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).
15153
+ * - 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).
15156
15154
  *
15157
15155
  * @param request - DescribeImagesRequest
15158
15156
  * @returns DescribeImagesResponse
@@ -18885,7 +18883,7 @@ export default class Client extends OpenApi {
18885
18883
  }
18886
18884
 
18887
18885
  /**
18888
- * Beta)调用 DescribeRecommendInstanceType 根据一个指定的实例规格,查找一个或多个备选的实例规格。针对已经或者即将停售的实例规格,DescribeRecommendInstanceType会罗列出作为替补的所有实例规格。
18886
+ * (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.
18889
18887
  *
18890
18888
  * @param request - DescribeRecommendInstanceTypeRequest
18891
18889
  * @param runtime - runtime options for this request RuntimeOptions
@@ -18992,7 +18990,7 @@ export default class Client extends OpenApi {
18992
18990
  }
18993
18991
 
18994
18992
  /**
18995
- * Beta)调用 DescribeRecommendInstanceType 根据一个指定的实例规格,查找一个或多个备选的实例规格。针对已经或者即将停售的实例规格,DescribeRecommendInstanceType会罗列出作为替补的所有实例规格。
18993
+ * (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.
18996
18994
  *
18997
18995
  * @param request - DescribeRecommendInstanceTypeRequest
18998
18996
  * @returns DescribeRecommendInstanceTypeResponse