@alicloud/ecs20140526 7.8.4 → 7.8.6

package/src/models/DescribeAvailableResourceRequest.ts

@@ -4,22 +4,69 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAvailableResourceRequest extends $dara.Model {
   /**
+   * @remarks
+   * The number of vCPU cores for the instance type. For more information, see [Instance families](https://help.aliyun.com/document_detail/25378.html).
+   * 
+   * This parameter applies only when `DestinationResource` is set to `InstanceType`.
+   * 
    * @example
    * 2
    */
   cores?: number;
   /**
+   * @remarks
+   * The category of the data disk. Valid values:
+   * 
+   * - cloud: basic cloud disk.
+   * 
+   * - cloud_efficiency: ultra cloud disk.
+   * 
+   * - cloud_ssd: SSD cloud disk.
+   * 
+   * - ephemeral_ssd: local SSD disk.
+   * 
+   * - cloud_essd: ESSD cloud disk.
+   * 
+   * - cloud_auto: ESSD AutoPL cloud disk.
+   * 
+   * <props="china">
+   * 
+   * - cloud_essd_entry: ESSD Entry cloud disk.
+   * 
    * @example
    * cloud_ssd
    */
   dataDiskCategory?: string;
   /**
+   * @remarks
+   * The ID of the dedicated host.
+   * 
    * @example
    * dh-bp165p6xk2tlw61e****
    */
   dedicatedHostId?: string;
   /**
    * @remarks
+   * The type of resource to query. Valid values:
+   * 
+   * - Zone: availability zone.
+   * 
+   * - IoOptimized: I/O optimized.
+   * 
+   * - InstanceType: instance type.
+   * 
+   * - Network: network type.
+   * 
+   * - ddh: dedicated host.
+   * 
+   * - SystemDisk: system disk.
+   * 
+   * - DataDisk: data disk.
+   * 
+   * > When `DestinationResource` is set to `SystemDisk`, you must specify `InstanceType` because available system disks depend on the instance type.
+   * 
+   * For details on how to specify this parameter, see the **API description** section.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -27,26 +74,61 @@ export class DescribeAvailableResourceRequest extends $dara.Model {
    */
   destinationResource?: string;
   /**
+   * @remarks
+   * The billing method of the resource. For more information, see [Billing overview](https://help.aliyun.com/document_detail/25398.html). Valid values:
+   * 
+   * - PrePaid: The subscription billing method.
+   * 
+   * - PostPaid: The pay-as-you-go billing method.
+   * 
+   * Default value: PostPaid.
+   * 
    * @example
    * PrePaid
    */
   instanceChargeType?: string;
   /**
+   * @remarks
+   * The instance type. For more information, see [Instance families](https://help.aliyun.com/document_detail/25378.html). You can also call the [DescribeInstanceTypes](https://help.aliyun.com/document_detail/25620.html) operation to get the latest list of instance types.
+   * 
+   * For details on how to specify this parameter, see the **API description** section.
+   * 
    * @example
    * ecs.g5.large
    */
   instanceType?: string;
   /**
+   * @remarks
+   * Specifies whether the instance is I/O optimized. Valid values:
+   * 
+   * - none: The instance is not I/O optimized.
+   * 
+   * - optimized: The instance is I/O optimized.
+   * 
+   * Default value: optimized.
+   * 
    * @example
    * optimized
    */
   ioOptimized?: string;
   /**
+   * @remarks
+   * The memory size for the instance type, in GiB. For more information, see [Instance families](https://help.aliyun.com/document_detail/25378.html).
+   * 
+   * This parameter applies only when `DestinationResource` is set to `InstanceType`.
+   * 
    * @example
    * 8.0
    */
   memory?: number;
   /**
+   * @remarks
+   * The network type. Valid values:
+   * 
+   * - vpc: VPC.
+   * 
+   * - classic: classic network.
+   * 
    * @example
    * vpc
    */
@@ -55,6 +137,8 @@ export class DescribeAvailableResourceRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
+   * The ID of the region. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to get the latest list of Alibaba Cloud regions.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -64,31 +148,108 @@ export class DescribeAvailableResourceRequest extends $dara.Model {
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
+   * @remarks
+   * The resource type. Valid values:
+   * 
+   * - instance: ECS instance.
+   * 
+   * - disk: cloud disk.
+   * 
+   * - reservedinstance: reserved instance.
+   * 
+   * - ddh: dedicated host.
+   * 
    * @example
    * instance
    */
   resourceType?: string;
   /**
+   * @remarks
+   * The scope of the reserved instance. Valid values:
+   * 
+   * - Region: The reserved instance is scoped to a region.
+   * 
+   * - Zone: The reserved instance is scoped to an availability zone.
+   * 
    * @example
    * Region
    */
   scope?: string;
   /**
+   * @remarks
+   * The protection period for the spot instance. Unit: hours. Default value: 1. Valid values:
+   * 
+   * - 1: Alibaba Cloud guarantees that the instance will not be automatically reclaimed within 1 hour of creation. After the 1-hour protection period ends, the system compares the bid price with the market price and checks the resource inventory to determine whether to retain or reclaim the instance.
+   * 
+   * - 0: Alibaba Cloud does not guarantee that the instance runs for 1 hour. The system compares the bid price with the market price and checks the resource inventory to determine whether to retain or reclaim the instance.
+   * 
+   * Alibaba Cloud sends a notification through ECS system events 5 minutes before reclaiming an instance. Spot instances are billed by the second. We recommend that you select a protection period based on the expected runtime of your tasks.
+   * 
+   * > This parameter applies only when `InstanceChargeType` is set to `PostPaid` and `SpotStrategy` is set to `SpotWithPriceLimit` or `SpotAsPriceGo`.
+   * 
    * @example
    * 1
    */
   spotDuration?: number;
   /**
+   * @remarks
+   * The bidding strategy for pay-as-you-go instances. Valid values:
+   * 
+   * - NoSpot: A standard pay-as-you-go instance.
+   * 
+   * - SpotWithPriceLimit: A spot instance for which you specify a maximum hourly price.
+   * 
+   * - SpotAsPriceGo: A spot instance for which the system automatically bids based on the current market price, up to the pay-as-you-go price.
+   * 
+   * Default value: NoSpot.
+   * 
+   * This parameter applies only when `InstanceChargeType` is set to `PostPaid`.
+   * 
    * @example
    * NoSpot
    */
   spotStrategy?: string;
   /**
+   * @remarks
+   * The category of the system disk. Valid values:
+   * 
+   * - cloud: basic cloud disk.
+   * 
+   * - cloud_efficiency: ultra cloud disk.
+   * 
+   * - cloud_ssd: SSD cloud disk.
+   * 
+   * - ephemeral_ssd: local SSD disk.
+   * 
+   * - cloud_essd: ESSD cloud disk.
+   * 
+   * - cloud_auto: ESSD AutoPL cloud disk.
+   * 
+   * <props="china">
+   * 
+   * - cloud_essd_entry: ESSD Entry cloud disk.
+   * 
+   * 
+   * 
+   * 
+   * About the default value:
+   * 
+   * - If `InstanceType` specifies a discontinued instance type, the default value is `cloud`.
+   * 
+   * - Otherwise, the default value is `cloud_efficiency`. <props="china">After January 30, 2026, for instance types that support only ESSD cloud disks, the default value changes from cloud_efficiency to cloud_essd PL0. For more information, see the [official announcement](https://www.aliyun.com/notice/117844).
+   * 
+   * > When `ResourceType` is set to `instance` and `DestinationResource` is set to `DataDisk`, this parameter is required.
+   * 
    * @example
    * cloud_ssd
    */
   systemDiskCategory?: string;
   /**
+   * @remarks
+   * The ID of the availability zone.
+   * 
+   * This parameter has no default value. If you do not specify this parameter, the operation returns resources that meet the query conditions in all availability zones within the specified region.
+   * 
    * @example
    * cn-hangzhou-e
    */

package/src/models/DescribeAvailableResourceResponseBody.ts

@@ -186,8 +186,15 @@ export class DescribeAvailableResourceResponseBodyAvailableZones extends $dara.M
 }
 
 export class DescribeAvailableResourceResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Information about the availability zones.
+   */
   availableZones?: DescribeAvailableResourceResponseBodyAvailableZones;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0041D94C-FB92-4C49-B115-259DA1C*****
    */

package/src/models/DescribeBandwidthLimitationRequest.ts

@@ -7,8 +7,8 @@ export class DescribeBandwidthLimitationRequest extends $dara.Model {
    * @remarks
    * The billing method of the instance. For more information, see [Billing overview](https://help.aliyun.com/document_detail/25398.html). Valid values:
    * 
-   * *   PrePaid: subscription
-   * *   PostPaid: pay-as-you-go
+   * - PrePaid: subscription.
+   * - PostPaid: pay-as-you-go.
    * 
    * Default value: PostPaid.
    * 
@@ -18,7 +18,7 @@ export class DescribeBandwidthLimitationRequest extends $dara.Model {
   instanceChargeType?: string;
   /**
    * @remarks
-   * The instance type. For information about the values, see [Overview of ECS instance families](https://help.aliyun.com/document_detail/25378.html).
+   * The instance type. For more information, see [Instance families](https://help.aliyun.com/document_detail/25378.html).
    * 
    * This parameter is required.
    * 
@@ -28,11 +28,11 @@ export class DescribeBandwidthLimitationRequest extends $dara.Model {
   instanceType?: string;
   /**
    * @remarks
-   * Specifies the operation for which to query the maximum public bandwidth. Valid values:
+   * The operation type for querying public bandwidth limits. Valid values:
    * 
-   * *   Upgrade: upgrades the public bandwidth.
-   * *   Downgrade: downgrades the public bandwidth.
-   * *   Create: creates an ECS instance.
+   * - Upgrade: upgrades the public bandwidth.
+   * - Downgrade: downgrades the public bandwidth.
+   * - Create: creates an ECS instance.
    * 
    * Default value: Create.
    * 
@@ -44,7 +44,7 @@ export class DescribeBandwidthLimitationRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The region ID. 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 target region. You can call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to query the most recent region list.
    * 
    * This parameter is required.
    * 
@@ -56,7 +56,7 @@ export class DescribeBandwidthLimitationRequest extends $dara.Model {
    * @remarks
    * The resource ID.
    * 
-   * >  This parameter is required when the OperationType parameter is set to Upgrade or Downgrade.
+   * > When you set the OperationType parameter to Upgrade or Downgrade, the ResourceId parameter is required.
    * 
    * @example
    * i-bp67acfmxazb4ph***
@@ -66,15 +66,15 @@ export class DescribeBandwidthLimitationRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The bidding policy for the pay-as-you-go instance. Valid values:
+   * The bidding strategy for pay-as-you-go instances. Valid values:
    * 
-   * *   NoSpot: The instance is a pay-as-you-go instance.
-   * *   SpotWithPriceLimit: The instance is a spot instance for which you can specify the maximum hourly price.
-   * *   SpotAsPriceGo: The instance is a spot instance for which the market price at the time of purchase is automatically used as the bid price. The market price can be up to the pay-as-you-go price.
+   * - NoSpot: a regular pay-as-you-go instance.
+   * - SpotWithPriceLimit: a preemptible instance with a user-defined maximum hourly price.
+   * - SpotAsPriceGo: a preemptible instance priced at the market price at the time of purchase.
    * 
    * Default value: NoSpot.
    * 
-   * >  The SpotStrategy parameter takes effect only when the InstanceChargeType parameter is set to PostPaid.
+   * > The SpotStrategy parameter takes effect only when the InstanceChargeType parameter is set to PostPaid.
    * 
    * @example
    * NoSpot

package/src/models/DescribeBandwidthPackagesRequest.ts

@@ -3,14 +3,32 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeBandwidthPackagesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the bandwidth package.
+   */
   bandwidthPackageId?: string;
+  /**
+   * @remarks
+   * The ID of the nat gateway. If specified, the operation returns only bandwidth packages associated with the specified nat gateway.
+   */
   natGatewayId?: string;
   ownerAccount?: string;
   ownerId?: number;
+  /**
+   * @remarks
+   * The page number. Starting value: 1. Default value: 1.
+   */
   pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.
+   */
   pageSize?: number;
   /**
    * @remarks
+   * The ID of the region where the bandwidth package is located.
+   * 
    * This parameter is required.
    */
   regionId?: string;

package/src/models/DescribeBandwidthPackagesResponseBody.ts

@@ -149,10 +149,30 @@ export class DescribeBandwidthPackagesResponseBodyBandwidthPackages extends $dar
 }
 
 export class DescribeBandwidthPackagesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Details of the queried bandwidth packages.
+   */
   bandwidthPackages?: DescribeBandwidthPackagesResponseBodyBandwidthPackages;
+  /**
+   * @remarks
+   * The page number.
+   */
   pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page.
+   */
   pageSize?: number;
+  /**
+   * @remarks
+   * The request ID.
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * The total number of matching entries.
+   */
   totalCount?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeCapacityReservationInstancesRequest.ts

@@ -40,8 +40,9 @@ export class DescribeCapacityReservationInstancesRequest extends $dara.Model {
    * @remarks
    * The number of entries per page.
    * 
-   * *   Valid values: 1 to 100.
-   * *   Default value: 10.
+   * - Valid values: 1 to 100.
+   * 
+   * - Default value: 10.
    * 
    * @example
    * 10

package/src/models/DescribeCapacityReservationsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCapacityReservationsRequestPrivatePoolOptions extends $dara.Model {
   /**
    * @remarks
-   * The IDs of capacity reservations. The value can be a JSON array that consists of up to 100 capacity reservation IDs. Separate the IDs with commas (,).
+   * The IDs of the capacity reservations. The value can be a JSON array that consists of up to 100 capacity reservation IDs.
    * 
    * @example
    * ["crp-bp1gubrkqutenqdd****", "crp-bp67acfmxazb5****"]
@@ -35,9 +35,9 @@ export class DescribeCapacityReservationsRequestPrivatePoolOptions extends $dara
 export class DescribeCapacityReservationsRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The key of tag N of the capacity reservation. Valid values of N: 1 to 20.
+   * The key of the Nth tag. You can specify up to 20 tags.
    * 
-   * If you specify a single tag to query resources, up to 1,000 resources to which the tag is added are returned. If you specify multiple tags to query resources, up to 1,000 resources to which all specified tags are added are returned. To query more than 1,000 resources that have specified tags added, call the [ListTagResources](https://help.aliyun.com/document_detail/110425.html) operation.
+   * A maximum of 1,000 resources that match the specified tags can be returned. If you specify multiple tags, only resources that have all of these tags are returned. If the number of matching resources exceeds 1,000, call the [ListTagResources](https://help.aliyun.com/document_detail/110425.html) operation to query the resources.
    * 
    * @example
    * TestKey
@@ -45,7 +45,7 @@ export class DescribeCapacityReservationsRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The value of tag N of the capacity reservation. Valid values of N: 1 to 20.
+   * The value of the Nth tag. You can specify up to 20 tags.
    * 
    * @example
    * TestValue
@@ -80,8 +80,9 @@ export class DescribeCapacityReservationsRequest extends $dara.Model {
    * @remarks
    * The billing method of the instance. Valid values:
    * 
-   * *   PostPaid: pay-as-you-go.
-   * *   PrePaid: subscription.
+   * - PostPaid: pay-as-you-go.
+   * 
+   * - PrePaid: subscription.
    * 
    * Default value: PostPaid.
    * 
@@ -91,7 +92,7 @@ export class DescribeCapacityReservationsRequest extends $dara.Model {
   instanceChargeType?: string;
   /**
    * @remarks
-   * The instance type of the capacity reservation. You can specify this parameter to query only effective capacity reservations. To query capacity reservations that are released, you must specify PrivatePoolOptions.Ids.
+   * The instance type. You can use this parameter to query only active capacity reservations. To query released capacity reservations, you must specify `PrivatePoolOptions.Ids`.
    * 
    * @example
    * ecs.c6.large
@@ -99,9 +100,9 @@ export class DescribeCapacityReservationsRequest extends $dara.Model {
   instanceType?: string;
   /**
    * @remarks
-   * The maximum number of entries per page.
+   * The number of entries to return on each page.
    * 
-   * Maximum value: 100
+   * Maximum value: 100.
    * 
    * Default value: 10.
    * 
@@ -111,7 +112,7 @@ export class DescribeCapacityReservationsRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of the NextToken parameter.
+   * The query token. Set the value to the `NextToken` value returned in the previous call to retrieve the next page of results.
    * 
    * @example
    * caeba0bbb2be03f84eb48b699f0a4883
@@ -123,9 +124,11 @@ export class DescribeCapacityReservationsRequest extends $dara.Model {
    * @remarks
    * The operating system of the instance. Valid values:
    * 
-   * *   windows: Windows operating systems.
-   * *   linux: Linux operating systems.
-   * *   all: all operating system types.
+   * - windows: Returns only capacity reservations for Windows.
+   * 
+   * - linux: Returns only capacity reservations for Linux.
+   * 
+   * - all: Returns all capacity reservations.
    * 
    * Default value: all.
    * 
@@ -135,7 +138,7 @@ export class DescribeCapacityReservationsRequest extends $dara.Model {
   platform?: string;
   /**
    * @remarks
-   * The region ID of the capacity reservation. 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 capacity reservation. 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.
    * 
@@ -145,9 +148,9 @@ export class DescribeCapacityReservationsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group to which the capacity reservation belongs. If you specify this parameter to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.
+   * The ID of the resource group. When you use this parameter to filter resources, the operation returns a maximum of 1,000 resources.
    * 
-   * > Resources in the default resource group are displayed in the response regardless of whether you specify this parameter.
+   * > Filtering by the default resource group is not supported.
    * 
    * @example
    * rg-bp67acfmxazb4p****
@@ -159,14 +162,19 @@ export class DescribeCapacityReservationsRequest extends $dara.Model {
    * @remarks
    * The status of the capacity reservation. Valid values:
    * 
-   * *   All: All states.
-   * *   Pending: The capacity reservation is being initialized. Scheduled capacity reservations enter the Pending state after they are created.
-   * *   Preparing: The capacity reservation is being prepared. Scheduled capacity reservations are in the Preparing state while resources are being provisioned.
-   * *   Prepared: The capacity reservation is to take effect. After resources are provisioned, scheduled capacity reservations remain in the Prepared state until they take effect.
-   * *   Active: The capacity reservation is in effect.
-   * *   Released: The capacity reservation is manually or automatically released when it expires.
+   * - All: all statuses.
+   * 
+   * - Pending: The capacity reservation is initializing. This is the initial status of a scheduled capacity reservation.
+   * 
+   * - Preparing: The system is preparing resources for the scheduled capacity reservation.
+   * 
+   * - Prepared: The resources are prepared, and the scheduled capacity reservation is waiting to take effect.
+   * 
+   * - Active: The capacity reservation is active.
+   * 
+   * - Released: The capacity reservation is released, either manually or automatically upon expiration.
    * 
-   * If you do not specify this parameter, capacity reservations in states other than Pending and Released are queried.
+   * If you do not specify this parameter, the operation returns capacity reservations in all states except `Pending` and `Released`.
    * 
    * @example
    * Active
@@ -174,7 +182,7 @@ export class DescribeCapacityReservationsRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The tags of the capacity reservation.
+   * The tags attached to the capacity reservations.
    */
   tag?: DescribeCapacityReservationsRequestTag[];
   /**

package/src/models/DescribeCapacityReservationsResponseBody.ts

@@ -317,7 +317,7 @@ export class DescribeCapacityReservationsResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * A pagination token. It can be used in the next request to retrieve a new page of results.If NextToken is empty, no next page exists.
+   * The token to retrieve the next page of results.
    * 
    * @example
    * caeba0bbb2be03f84eb48b699f0a****
@@ -333,7 +333,7 @@ export class DescribeCapacityReservationsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of capacity reservations that match the query.
    * 
    * @example
    * 1

package/src/models/DescribeCloudAssistantSettingsRequest.ts

@@ -19,7 +19,7 @@ export class DescribeCloudAssistantSettingsRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The Cloud Assistant configurations.
+   * The service settings to query.
    * 
    * This parameter is required.
    */