@alicloud/ecs20140526 7.8.4 → 7.8.5

package/src/models/ImportImageRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ImportImageRequestDiskDeviceMapping extends $dara.Model {
   /**
    * @remarks
-   * The device name of disk N in the custom image.
+   * The device name of the disk (`DiskDeviceMapping.N.Device`) in the custom image.
    * 
-   * >  This parameter will be removed in the future. We recommend that you do not use this parameter to ensure future compatibility.
+   * > This parameter is being phased out. To ensure compatibility, we recommend that you avoid using this parameter.
    * 
    * @example
    * null
@@ -15,16 +15,17 @@ export class ImportImageRequestDiskDeviceMapping extends $dara.Model {
   device?: string;
   /**
    * @remarks
-   * The size of disk N in the custom image. Unit: GiB.
+   * The size of the disk, in GiB.
    * 
-   * You can use this parameter to specify the sizes of the system disk and data disks in the custom image. When you specify the size of the system disk, make sure that the specified size is greater than or equal to the size of the imported image file. Unit: GiB. Valid values:
+   * The system disk size must be greater than or equal to the size of the imported image file. Valid values:
    * 
-   * *   When the N value is 1, this parameter specifies the size of the system disk in the custom image. Valid values: 1 to 2048.
-   * *   When the N value is an integer in the range of 2 to 17, this parameter specifies the size of a data disk in the custom image. Valid values: 1 to 2048.
+   * - For N=1, the disk is a system disk. The value must be in the range of 1 to 2,048.
    * 
-   * After the image file is uploaded to an OSS bucket, you can view the size of the image file in the OSS bucket.
+   * - For N=2 to 17, the disk is a data disk. The value must be in the range of 1 to 2,048.
    * 
-   * >  This parameter will be removed in the future. We recommend that you use `DiskDeviceMapping.N.DiskImageSize` to ensure future compatibility.
+   * After you upload the source image file to an OSS bucket, you can view the size of the file in the bucket.
+   * 
+   * > This parameter is being deprecated. For better compatibility, we recommend that you use the `DiskDeviceMapping.N.DiskImageSize` parameter.
    * 
    * @example
    * 80
@@ -32,14 +33,15 @@ export class ImportImageRequestDiskDeviceMapping extends $dara.Model {
   diskImSize?: number;
   /**
    * @remarks
-   * The size of disk N in the custom image after the source image is imported.
+   * The size of the disk after the image is imported, in GiB.
+   * 
+   * The value of this parameter for the system disk must be greater than or equal to the size of the image file. Valid values:
    * 
-   * You can use this parameter to specify the sizes of the system disk and data disks in the custom image. When you specify the size of the system disk, make sure that the specified size is greater than or equal to the size of the imported image file. Unit: GiB. Valid values:
+   * - For N=1, the disk is a system disk. The value must be in the range of 1 to 2,048.
    * 
-   * *   When the N value is 1, this parameter specifies the size of the system disk in the custom image. Valid values: 1 to 2048.
-   * *   When the N value is an integer in the range of 2 to 17, this parameter specifies the size of a data disk in the custom image. Valid values: 1 to 2048.
+   * - For N=2 to 17, the disk is a data disk. The value must be in the range of 1 to 2,048.
    * 
-   * After the image file is uploaded to an OSS bucket, you can view the size of the image file in the OSS bucket.
+   * After you upload the source image file to an OSS bucket, you can view the size of the file in the bucket.
    * 
    * @example
    * 80
@@ -47,14 +49,17 @@ export class ImportImageRequestDiskDeviceMapping extends $dara.Model {
   diskImageSize?: number;
   /**
    * @remarks
-   * The format of the source image. Valid values:
+   * The format of the image file. Valid values:
+   * 
+   * - RAW
+   * 
+   * - VHD
+   * 
+   * - QCOW2
    * 
-   * *   RAW
-   * *   VHD
-   * *   QCOW2
-   * *   VMDK (invitational preview)
+   * - VMDK (This feature is in invitation-only preview.)
    * 
-   * This parameter is empty by default, which indicates that the system checks the image format and uses the check result as the value of this parameter.
+   * Default value: None. If you leave this parameter empty, Alibaba Cloud automatically detects the image format and uses the detected format.
    * 
    * @example
    * QCOW2
@@ -62,9 +67,9 @@ export class ImportImageRequestDiskDeviceMapping extends $dara.Model {
   format?: string;
   /**
    * @remarks
-   * The Object Storage Service (OSS) bucket where the image file is stored.
+   * The OSS bucket where the image file is stored.
    * 
-   * >  Before you import images for the first time, you must use RAM to authorize ECS to access your OSS buckets. If ECS is not authorized to access your OSS buckets, the `NoSetRoletoECSServiceAcount` error code is returned when you call the ImportImage operation. For more information, see **Usage notes**.
+   * > Before you import an image from an OSS bucket for the first time, you must add a RAM policy as described in the **Description** section of this topic. Otherwise, the API returns the `NoSetRoletoECSServiceAccount` error.
    * 
    * @example
    * ecsimageos
@@ -72,7 +77,7 @@ export class ImportImageRequestDiskDeviceMapping extends $dara.Model {
   OSSBucket?: string;
   /**
    * @remarks
-   * The name (key) of the object that the image file is stored as in the OSS bucket.
+   * The object key of the image file in the OSS bucket.
    * 
    * @example
    * CentOS_5.4_32.raw
@@ -112,10 +117,11 @@ export class ImportImageRequestDiskDeviceMapping extends $dara.Model {
 export class ImportImageRequestFeatures extends $dara.Model {
   /**
    * @remarks
-   * The metadata access mode version of the image. Valid values:
+   * The metadata access mode of the image. Valid values:
    * 
-   * *   v1: You cannot set the metadata access mode to security hardening when you create instances from the image.
-   * *   v2: You can set the metadata access mode to security hardening when you create instances from the image.
+   * - v1: When you create an ECS instance from the image, you cannot set the metadata access mode to Security-Hardened Mode.
+   * 
+   * - v2: When you create an ECS instance from the image, you can set the metadata access mode to Security-Hardened Mode.
    * 
    * Default value: v1.
    * 
@@ -125,10 +131,11 @@ export class ImportImageRequestFeatures 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: Instances created from the image support the NVMe protocol.
    * 
-   * *   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.
+   * - unsupported: Instances created from the image do not support the NVMe protocol.
    * 
    * @example
    * supported
@@ -160,7 +167,7 @@ export class ImportImageRequestFeatures extends $dara.Model {
 export class ImportImageRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The key of tag N of the image. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun`.
+   * The key of tag N. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters long and cannot start with `aliyun` or `acs:` or contain `http://` or `https://`.
    * 
    * @example
    * TestKey
@@ -168,7 +175,7 @@ export class ImportImageRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The value of tag N of the image. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:`.
+   * The value of tag N. Valid values of N: 1 to 20. The tag value can be an empty string. It can be up to 128 characters long, cannot start with `acs:`, and cannot contain `http://` or `https://`.
    * 
    * @example
    * TestValue
@@ -202,9 +209,11 @@ export class ImportImageRequest extends $dara.Model {
    * @remarks
    * The system architecture. Valid values:
    * 
-   * *   i386
-   * *   x86_64
-   * *   arm64
+   * - i386
+   * 
+   * - x86_64
+   * 
+   * - arm64
    * 
    * Default value: x86_64.
    * 
@@ -216,12 +225,15 @@ export class ImportImageRequest extends $dara.Model {
    * @remarks
    * The boot mode of the image. Valid values:
    * 
-   * *   BIOS
-   * *   UEFI
+   * - BIOS: the BIOS boot mode.
+   * 
+   * - UEFI: the UEFI boot mode.
    * 
-   * Default value: BIOS. If you set `Architecture` to arm64, set this parameter to UEFI.
+   * Default value: BIOS. If you set `Architecture` to `arm64`, the value of this parameter defaults to UEFI and can only be set to UEFI.
    * 
-   * > Make sure that you are aware of the boot modes supported by the specified image, as thehe modified boot mode needs to be supported by the image. This way, instances that use this image can start.
+   * >Notice: 
+   * 
+   * To prevent startup failures, ensure the boot mode you specify is supported by the image. For more information, see [Image boot modes](~~2244655#b9caa9b8bb1wf~~).
    * 
    * @example
    * BIOS
@@ -229,7 +241,7 @@ export class ImportImageRequest extends $dara.Model {
   bootMode?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. **The token can contain only ASCII characters and cannot exceed 64 characters in length.** For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).
+   * A client-generated token that ensures the idempotence of a request. The token must be unique across requests. The token can contain only ASCII characters and must be no more than 64 characters long. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).
    * 
    * @example
    * 123e4567-e89b-12d3-a456-426655440000
@@ -237,7 +249,7 @@ export class ImportImageRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The image description. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.
+   * The description of the image. The description must be 2 to 256 characters long and cannot start with `http://` or `https://`. Both English and Chinese characters are supported.
    * 
    * @example
    * TestDescription
@@ -245,9 +257,9 @@ export class ImportImageRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The mode in which to check the image. If you do not specify this parameter, the image is not checked. Only the standard check mode is supported.
+   * The policy for checking the image. If you do not specify this parameter, the system does not check the image. This parameter supports only the standard detection mode. Set the value to `Standard`.
    * 
-   * >  This parameter is supported for most Linux and Windows operating system versions. For more information about image check items and operating system limits for image check, see [Overview](https://help.aliyun.com/document_detail/439819.html) and [Operating system limits for image check](https://help.aliyun.com/document_detail/475800.html).
+   * > This feature is supported on most Linux and Windows versions. For more information about the check items and the operating systems that support this feature, see [Image detection overview](https://help.aliyun.com/document_detail/439819.html) and [Operating system limitations for image detection](https://help.aliyun.com/document_detail/475800.html).
    * 
    * @example
    * Standard
@@ -255,15 +267,16 @@ export class ImportImageRequest extends $dara.Model {
   detectionStrategy?: string;
   /**
    * @remarks
-   * Details about the custom images.
+   * A list of disk device mappings for the custom image.
    */
   diskDeviceMapping?: ImportImageRequestDiskDeviceMapping[];
   /**
    * @remarks
-   * Specifies whether to perform only a dry run, without performing the actual request. Valid values:
+   * Specifies whether to perform a dry run for the request. Valid values:
+   * 
+   * - `true`: performs a check request without executing the actual operation. The system checks whether the request parameters are valid, the request format is correct, and the required permissions are granted. If the check fails, the system returns an error message. If the check succeeds, the system returns the `DryRunOperation` error code.
    * 
-   * *   true: performs only a dry run. The system checks the request for potential issues, including invalid AccessKey pairs, unauthorized RAM users, and missing parameter values. 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: performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
+   * - `false`: sends a normal request. After the request passes the check, the system returns a 2xx HTTP status code and performs the operation.
    * 
    * Default value: false.
    * 
@@ -273,12 +286,12 @@ export class ImportImageRequest extends $dara.Model {
   dryRun?: boolean;
   /**
    * @remarks
-   * The attributes of the image.
+   * The properties of image features.
    */
   features?: ImportImageRequestFeatures;
   /**
    * @remarks
-   * The image name. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `acs:` or `aliyun`. The name cannot contain `http://` or `https://`. The name can contain letters, digits, periods (.), colons (:), underscores (_), and hyphens (-).
+   * The name of the image. The name must be 2 to 128 characters long and start with a letter or a Chinese character. It can contain digits, periods (.), colons (:), underscores (_), and hyphens (-). The name cannot start with `aliyun` or `acs:` or contain `http://` or `https://`.
    * 
    * @example
    * ImageTestName
@@ -286,24 +299,25 @@ export class ImportImageRequest extends $dara.Model {
   imageName?: string;
   /**
    * @remarks
-   * The type of the license used to activate the operating system after the image is imported. Valid values:
+   * The license type. This parameter sets the licensing model for instances that are created from the image by calling the [RunInstances](https://help.aliyun.com/document_detail/2679677.html) operation. This parameter applies only to Windows Server images. Valid values:
+   * 
+   * - Aliyun: Uses a license provided by Alibaba Cloud. When you start an instance created from this image, the system attempts to automatically connect to the Alibaba Cloud KMS server for activation. The fees for the instance include the cost of the Windows Server license.
    * 
-   * *   Auto: ECS checks the operating system of the image and allocates a license to the operating system. ECS first checks whether the operating system distribution specified by `Platform` has a license allocated through an official Alibaba Cloud channel. If yes, the allocated license is used. If no, the license that comes with the source operating system is used.
-   * *   Aliyun: The license allocated through an official Alibaba Cloud channel is used for the operating system distribution specified by `Platform`.
-   * *   BYOL: The license that comes with the source operating system is used. In this case, make sure that your license key is eligible for use in Alibaba Cloud.
+   * - BYOL: Bring Your Own License. When you start an instance created from this image, Alibaba Cloud does not provide activation. You must use your own license key to manually activate the operating system. The fees for the instance do not include the cost of the Windows Server license.
    * 
-   * Default value: Auto.
+   * Default value: Aliyun.
    * 
    * @example
-   * Auto
+   * BYOL
    */
   licenseType?: string;
   /**
    * @remarks
-   * The operating system platform. Valid values:
+   * The operating system type. Valid values:
    * 
-   * *   windows
-   * *   linux
+   * - `windows`: You must also set the `LicenseType` parameter.
+   * 
+   * - `linux`
    * 
    * Default value: linux.
    * 
@@ -316,32 +330,59 @@ export class ImportImageRequest extends $dara.Model {
    * @remarks
    * The operating system distribution. Valid values:
    * 
-   * *   Aliyun
-   * *   Anolis
-   * *   CentOS
-   * *   Ubuntu
-   * *   CoreOS
-   * *   SUSE
-   * *   Debian
-   * *   OpenSUSE
-   * *   FreeBSD
-   * *   RedHat
-   * *   Kylin
-   * *   UOS
-   * *   Fedora
-   * *   Fedora CoreOS
-   * *   CentOS Stream
-   * *   AlmaLinux
-   * *   Rocky Linux
-   * *   Gentoo
-   * *   Customized Linux
-   * *   Others Linux
-   * *   Windows Server 2022
-   * *   Windows Server 2019
-   * *   Windows Server 2016
-   * *   Windows Server 2012
-   * *   Windows Server 2008
-   * *   Windows Server 2003
+   * - Aliyun
+   * 
+   * - Anolis
+   * 
+   * - CentOS
+   * 
+   * - Ubuntu
+   * 
+   * - CoreOS
+   * 
+   * - SUSE
+   * 
+   * - Debian
+   * 
+   * - OpenSUSE
+   * 
+   * - FreeBSD
+   * 
+   * - RedHat
+   * 
+   * - Kylin
+   * 
+   * - UOS
+   * 
+   * - Fedora
+   * 
+   * - Fedora CoreOS
+   * 
+   * - CentOS Stream
+   * 
+   * - AlmaLinux
+   * 
+   * - Rocky Linux
+   * 
+   * - Gentoo
+   * 
+   * - Customized Linux
+   * 
+   * - Others Linux
+   * 
+   * - Windows Server 2022
+   * 
+   * - Windows Server 2019
+   * 
+   * - Windows Server 2016
+   * 
+   * - Windows Server 2012
+   * 
+   * - Windows Server 2008
+   * 
+   * - Windows Server 2003
+   * 
+   * - Other Windows
    * 
    * Default value: Others Linux.
    * 
@@ -351,7 +392,7 @@ export class ImportImageRequest extends $dara.Model {
   platform?: string;
   /**
    * @remarks
-   * The region ID of the source 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 source custom image is located. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to query the latest list of Alibaba Cloud regions.
    * 
    * This parameter is required.
    * 
@@ -361,7 +402,7 @@ export class ImportImageRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group to which to assign the image.
+   * The ID of the resource group to which the imported image belongs.
    * 
    * @example
    * rg-bp67acfmxazb4p****
@@ -379,11 +420,11 @@ export class ImportImageRequest extends $dara.Model {
   roleName?: string;
   /**
    * @remarks
-   * The Alibaba Cloud Resource Name (ARN) of the cloud box, which is used to uniquely identify a storage location in the cloud.
+   * The Alibaba Cloud Resource Name (ARN) of the CloudBox, which uniquely identifies the cloud storage location.
    * 
-   * >  Specify this parameter only if you import an image from OSS on CloudBox. Otherwise, you do not need to specify this parameter. For more information, see [What is OSS on CloudBox?](https://help.aliyun.com/document_detail/430190.html)
+   * > You must specify this parameter only when you import an image file from OSS ON CloudBox. If you do not use OSS ON CloudBox, do not specify this parameter. For more information, see [What is OSS ON CloudBox?](https://help.aliyun.com/document_detail/430190.html).
    * 
-   * The ARN must be in the following format: `arn:acs:cloudbox:{RegionId}:{AliUid}:cloudbox/{CloudBoxId}`. Replace `{RegionId}` with the region ID of the cloud box, `{AliUid}` with the ID of the Alibaba Cloud account to which the cloud box belongs, and `{CloudBoxId}` with the ID of the cloud box.
+   * The ARN must be in the `arn:acs:cloudbox:{RegionId}:{AliUid}:cloudbox/{CloudBoxId}` format. Replace `{RegionId}` with the ID of the region where the CloudBox is located, `{AliUid}` with the ID of your Alibaba Cloud account, and `{CloudBoxId}` with the ID of the CloudBox.
    * 
    * @example
    * arn:acs:cloudbox:cn-hangzhou:123456:cloudbox/cb-xx***123
@@ -391,7 +432,7 @@ export class ImportImageRequest extends $dara.Model {
   storageLocationArn?: string;
   /**
    * @remarks
-   * The image tags.
+   * The tags to add to the image.
    */
   tag?: ImportImageRequestTag[];
   static names(): { [key: string]: string } {

package/src/models/ImportKeyPairRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ImportKeyPairRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The key of tag N to add to the key pair. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain [http:// or https://](http://https://。). The tag key cannot start with acs: or aliyun.
+   * The key of tag N to add to the key pair. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain [http:// or https://](http://https://%E3%80%82). The tag key cannot start with acs: or aliyun.
    * 
    * @example
    * TestKey
@@ -13,7 +13,7 @@ export class ImportKeyPairRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The value of tag N to add to the key pair. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain [http:// or https://](http://https://。). The tag value cannot start with acs:.
+   * The value of tag N to add to the key pair. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain [http:// or https://](http://https://%E3%80%82). The tag value cannot start with acs:.
    * 
    * @example
    * TestValue
@@ -45,7 +45,7 @@ export class ImportKeyPairRequestTag extends $dara.Model {
 export class ImportKeyPairRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the key pair. The name must be unique. It must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
+   * The name of the key pair. The name must be unique. It must be 2 to 128 characters in length. It must start with a letter and cannot start with http\\:// or https\\://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
    * 
    * This parameter is required.
    *