@alicloud/ecs20140526 7.8.4 → 7.8.5

package/src/models/ModifyImageAttributeRequest.ts

@@ -5,15 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyImageAttributeRequestFeatures extends $dara.Model {
   /**
    * @remarks
-   * The image metadata access mode. Valid values:
+   * The metadata access mode of the image. Valid values:
    * 
-   * *   v1: You cannot set the image metadata access mode to security hardening when you create instances from the image.
+   * - `v1`: When you create an ECS instance from this image, you cannot set the metadata access mode to `enforced mode`.
    * 
-   * *   v2: You can set the image metadata access mode to security hardening when you create instances from the image.
+   * - `v2`: When you create an ECS instance from this image, you can set the metadata access mode to `enforced mode`.
    * 
-   *     **
+   *   >Notice: 
    * 
-   *     **Note** You cannot change the value of ImdsSupport from v2 to v1 for an image. To change the value of ImdsSupport from v2 to v1 for an image, use the snapshots associated with the image to create an image and set ImdsSupport to v1 for the new image.
+   *   You cannot change the value of `ImdsSupport` from `v2` to `v1`. To use the `v1` mode, create a new image from a snapshot that is associated with the image and set `ImdsSupport` to `v1`.
    * 
    * @example
    * v2
@@ -21,10 +21,11 @@ export class ModifyImageAttributeRequestFeatures extends $dara.Model {
   imdsSupport?: string;
   /**
    * @remarks
-   * Specifies whether the image supports the Non-Volatile Memory Express (NVMe) protocol. Valid values:
+   * Specifies whether the image supports NVMe. Valid values:
    * 
-   * *   supported: The image supports the NVMe protocol. Instances created from the image also support the NVMe protocol.
-   * *   unsupported: The image does not support the NVMe protocol. Instances created from the image do not support the NVMe protocol.
+   * - `supported`: The image supports NVMe. Instances that you create from this image support the NVMe protocol.
+   * 
+   * - `unsupported`: The image does not support NVMe. Instances that you create from this image do not support the NVMe protocol.
    * 
    * @example
    * supported
@@ -59,13 +60,17 @@ export class ModifyImageAttributeRequestFeatures extends $dara.Model {
 export class ModifyImageAttributeRequest extends $dara.Model {
   /**
    * @remarks
-   * The new boot mode of the image. Valid values:
+   * The boot mode of the image. Valid values:
+   * 
+   * - `BIOS`: BIOS boot mode.
+   * 
+   * - `UEFI`: UEFI boot mode.
    * 
-   * *   BIOS: BIOS mode
-   * *   UEFI: Unified Extensible Firmware Interface (UEFI) mode
-   * *   UEFI-Preferred: BIOS mode and UEFI mode
+   * - `UEFI-Preferred`: UEFI-preferred boot mode.
    * 
-   * >  Before you change this parameter, make sure that you are familiar with the boot modes supported by the image. If you specify a boot mode that is not supported by the image, ECS instances created from the image cannot start as expected. For information about the boot modes of images, see the [Boot modes of custom images](~~2244655#b9caa9b8bb1wf~~) section of the "Best practices for ECS instance boot modes" topic.
+   * >Notice: 
+   * 
+   * To prevent startup failures, verify the boot modes that the image supports before you change its boot mode. For more information, see [Boot modes](~~2244655#b9caa9b8bb1wf~~).
    * 
    * @example
    * BIOS
@@ -73,18 +78,25 @@ export class ModifyImageAttributeRequest extends $dara.Model {
   bootMode?: string;
   /**
    * @remarks
-   * The new description of the custom image. The description must be 2 to 256 characters in length It cannot start with [http:// or https://.](http://https://。)
+   * The new description of the custom image. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.
    * 
-   * This parameter is empty by default, which specifies that the original description is retained.
+   * If you do not specify this parameter, the original description is retained.
    * 
    * @example
    * testDescription
    */
   description?: string;
+  /**
+   * @remarks
+   * Specifies whether to perform a dry run to check whether the request is valid. Valid values:
+   * 
+   * - `true`: performs a dry run to check the request for validity, syntax, and required permissions. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.
+   * - `false` (default): sends the request. If the request passes the validation checks, the operation is performed.
+   */
   dryRun?: boolean;
   /**
    * @remarks
-   * The attributes of the custom image.
+   * The features of the image.
    * 
    * **if can be null:**
    * true
@@ -92,7 +104,7 @@ export class ModifyImageAttributeRequest extends $dara.Model {
   features?: ModifyImageAttributeRequestFeatures;
   /**
    * @remarks
-   * The name of the image family. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with acs: or aliyun. [It cannot contain http:// or https://. It can contain letters, digits, periods (.), colons (:), underscores (_), and hyphens (-).](http://https://。、（.）、（:）、（_）（-）。)
+   * The name of the image family. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character. The name cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`. It can contain digits, periods (.), colons (:), underscores (_), and hyphens (-).
    * 
    * By default, this parameter is empty.
    * 
@@ -112,9 +124,9 @@ export class ModifyImageAttributeRequest extends $dara.Model {
   imageId?: string;
   /**
    * @remarks
-   * The name of the custom image. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with acs: or aliyun. [It cannot contain http:// or https://. It can contain letters, digits, periods (.), colons (:), underscores (_), and hyphens (-).](http://https://。、（.）、（:）、（_）（-）。)
+   * The name of the custom image. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character. The name cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`. It can contain digits, periods (.), colons (:), underscores (_), and hyphens (-).
    * 
-   * By default, this parameter is empty. In this case, the original name is retained.
+   * If you do not specify this parameter, the original name is retained.
    * 
    * @example
    * testImageName
@@ -122,19 +134,19 @@ export class ModifyImageAttributeRequest extends $dara.Model {
   imageName?: string;
   /**
    * @remarks
-   * The type of the license that is used to activate the operating system after the image is imported. Set the value to BYOL.
+   * The license type for activating the operating system after you import the image. The only valid value is `BYOL`.
    * 
-   * BYOL: The license that comes with the source operating system is used. When you use the BYOL license, make sure that your license key is supported by Alibaba Cloud.
+   * `BYOL`: Bring Your Own License. If you use the BYOL license type, you must ensure that your license key is supported for use on Alibaba Cloud.
    * 
    * @example
-   * Auto
+   * BYOL
    */
   licenseType?: string;
   ownerAccount?: string;
   ownerId?: number;
   /**
    * @remarks
-   * The region ID of the custom image. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to query the most recent region list.
+   * The ID of the region where the custom image is located. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to view the latest list of Alibaba Cloud regions.
    * 
    * This parameter is required.
    * 
@@ -146,12 +158,13 @@ export class ModifyImageAttributeRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The new state of the custom image. Valid values:
+   * The image status. Valid values:
+   * 
+   * - `Deprecated`: Deprecates the image. If a custom image that you want to deprecate is shared, you must unshare it first. You cannot share or copy a deprecated image. However, you can use the image to create an instance or replace a system disk.
    * 
-   * *   Deprecated: puts the image into the Deprecated state. If the custom image is shared, you must unshare it before you can put it into the Deprecated state. Images in the Deprecated state cannot be shared or copied, but can be used to create instances or replace system disks.
-   * *   Available: puts the image into the Available state. You can restore an image from the Deprecated state to the Available state.
+   * - `Available`: Makes the image available. You can change the status of a deprecated image to `Available`.
    * 
-   * > If you want to roll back a custom image in the image family to a previous version, you can put the latest available custom image into the Deprecated state. If no custom images are in the Available state within the image family, an image family cannot be used to create instances. Proceed with caution if only a single custom image is in the Available state within the image family.
+   * > However, if this is the only available custom image in the image family, deprecating it prevents the creation of instances from any image in that family. Use this option with caution.
    * 
    * @example
    * Deprecated

package/src/models/ModifyImageAttributeResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyImageAttributeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

package/src/models/ModifyImageShareGroupPermissionRequest.ts

@@ -7,6 +7,8 @@ export class ModifyImageShareGroupPermissionRequest extends $dara.Model {
   removeGroup?: string[];
   /**
    * @remarks
+   * The ID of the custom image.
+   * 
    * This parameter is required.
    */
   imageId?: string;
@@ -14,6 +16,8 @@ export class ModifyImageShareGroupPermissionRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
+   * The ID of the region. You can call the `DescribeRegions` operation to query the latest region list.
+   * 
    * This parameter is required.
    */
   regionId?: string;

package/src/models/ModifyImageShareGroupPermissionResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyImageShareGroupPermissionResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the request.
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ModifyImageSharePermissionRequest.ts

@@ -5,18 +5,24 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyImageSharePermissionRequest extends $dara.Model {
   /**
    * @remarks
-   * The IDs of Alibaba Cloud accounts to which you want to share the custom image. Valid values of N: 1 to 10. If you specify more than 10 Alibaba Cloud account IDs, the system processes only the first 10 account IDs. The excess account IDs are ignored.
+   * The IDs of the Alibaba Cloud accounts with which to share the image. You can specify up to 10 account IDs. If you specify more than 10 account IDs in a request, only the first 10 are processed.
    * 
    * @example
    * 1234567890
    */
   addAccount?: string[];
+  /**
+   * @remarks
+   * Specifies whether to perform a dry run. A dry run checks for request parameter validity and permissions. If the request is valid, the `DryRunOperation` error code is returned. Otherwise, an error is returned. If the request is valid, no fee is incurred and no resource is created. Set the value to `true` to perform a dry run. Default value: `false`.
+   */
   dryRun?: boolean;
   /**
    * @remarks
-   * The ID of the shared custom image.
+   * The ID of the custom image.
    * 
-   * >  You can share images encrypted by using CMKs but cannot share images encrypted by using service keys. When you share an image encrypted by using a service key, an error is reported.
+   * >Notice: 
+   * 
+   * You can no longer share images that are encrypted by using a service key. You can share only images that are encrypted by using a customer managed key (CMK). If you attempt to share an image that is encrypted by using a service key, the request fails.
    * 
    * This parameter is required.
    * 
@@ -26,10 +32,11 @@ export class ModifyImageSharePermissionRequest extends $dara.Model {
   imageId?: string;
   /**
    * @remarks
-   * Specifies whether to publish or unpublish a community image. Valid values:
+   * Specifies whether to publish or unpublish the community image. Valid values:
+   * 
+   * - true: publishes the image as a community image.
    * 
-   * *   true: publishes the custom image as a community image.
-   * *   false: unpublishes a community image. The unpublish operation takes effect only on community images.
+   * - false: unpublishes the community image. The image becomes a custom image. If the image is a custom image, this setting has no effect.
    * 
    * Default value: false.
    * 
@@ -49,7 +56,7 @@ export class ModifyImageSharePermissionRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The region ID of the custom image. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to query the most recent region list.
+   * The region ID of the custom image. You can call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to view the latest list of Alibaba Cloud regions.
    * 
    * This parameter is required.
    * 
@@ -59,7 +66,7 @@ export class ModifyImageSharePermissionRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The IDs of Alibaba Cloud accounts from which you want to unshare the custom image. Valid values of N: 1 to 10. If you specify more than 10 Alibaba Cloud account IDs, the system processes only the first 10 account IDs. The excess account IDs are ignored.
+   * The IDs of the Alibaba Cloud accounts from which to unshare the image. You can specify up to 10 account IDs. If you specify more than 10 account IDs in a request, only the first 10 are processed.
    * 
    * @example
    * 1234567890

package/src/models/ModifyImageSharePermissionResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyImageSharePermissionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

package/src/models/ModifyInstanceAttachmentAttributesRequest.ts

@@ -7,8 +7,9 @@ export class ModifyInstanceAttachmentAttributesRequestPrivatePoolOptions extends
    * @remarks
    * The ID of the private pool. Set the value to the ID of the elasticity assurance or capacity reservation that generates the private pool.
    * 
-   * *   This parameter is required when `PrivatePoolOptions.MatchCriteria` is set to `Target`.
-   * *   This parameter must be empty when `PrivatePoolOptions.MatchCriteria` is set to `Open` or `None`.
+   * - This parameter is required when `PrivatePoolOptions.MatchCriteria` is set to `Target`.
+   * 
+   * - This parameter must be empty when `PrivatePoolOptions.MatchCriteria` is set to `Open` or `None`.
    * 
    * @example
    * eap-bp67acfmxazb4****
@@ -18,9 +19,11 @@ export class ModifyInstanceAttachmentAttributesRequestPrivatePoolOptions extends
    * @remarks
    * The new type of private pool. Valid values:
    * 
-   * *   Open: open private pool. The system matches the instance with an open private pool. If no matching open private pools exist, the system uses resources in the public pool to start the instance.
-   * *   Target: specified private pool. The system uses the capacity in a specified private pool to start the instance. If the specified private pool is unavailable, the instance cannot be started. You must use `PrivatePoolOptions.Id` to specify the ID of a private pool.
-   * *   None: no private pool. The capacity in private pools is not used to start the instance.
+   * - Open: open private pool. The system matches the instance with an open private pool. If no matching open private pools exist, the system uses resources in the public pool to start the instance.
+   * 
+   * - Target: specified private pool. The system uses the capacity in a specified private pool to start the instance. If the specified private pool is unavailable, the instance cannot be started. You must use `PrivatePoolOptions.Id` to specify the ID of a private pool.
+   * 
+   * - None: no private pool. The capacity in private pools is not used to start the instance.
    * 
    * This parameter is required.
    *