@alicloud/ehpcinstant20230701 3.2.1 → 3.3.0

package/src/models/ListActionPlansRequest.ts

@@ -3,13 +3,27 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListActionPlansRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The IDs of the execution plans to be queried.
+   */
   actionPlanIds?: string[];
   /**
+   * @remarks
+   * The maximum number of entries per page.
+   * 
+   * Valid values: 1 to 100.
+   * 
+   * Default value: 20.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * A pagination token.
+   * 
    * @example
    * 1d2db86scXXXXXXXXXX
    */

package/src/models/ListActionPlansResponseBody.ts

@@ -4,26 +4,45 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListActionPlansResponseBodyActionPlans extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the execution plan.
+   * 
    * @example
    * ap-hz036ubmx2qmw93k****
    */
   actionPlanId?: string;
   /**
+   * @remarks
+   * The name of the execution plan.
+   * 
    * @example
    * TestActionPlan
    */
   actionPlanName?: string;
   /**
+   * @remarks
+   * The time when the execution plan was created.
+   * 
    * @example
    * 2025-08-10 17:58:24
    */
   createTime?: string;
   /**
+   * @remarks
+   * The status of the execution plan. The possible values are as follows:
+   * 
+   * *   Active Instant tasks are dynamically managed only when the execution plan is in the Active state.
+   * *   Inactive Instant tasks are no longer managed by execution plans in the Inactive state.
+   * *   Deleting: The execution plan is being deleted. You cannot modify the parameters of an execution plan in this state.
+   * 
    * @example
    * Active
    */
   status?: string;
   /**
+   * @remarks
+   * The time when the execution plan was last modified. The time follows the ISO 8601 standard and UTC +0. The format is yyyy-MM-ddTHH:mmZ.
+   * 
    * @example
    * 2025-08-10 17:58:24
    */
@@ -58,14 +77,23 @@ export class ListActionPlansResponseBodyActionPlans extends $dara.Model {
 }
 
 export class ListActionPlansResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of execution plan results.
+   */
   actionPlans?: ListActionPlansResponseBodyActionPlans[];
   /**
+   * @remarks
+   * The maximum number of records returned in this request.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
    * @remarks
+   * Indicates the read position returned by the current call. An empty value means all data has been read.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -73,11 +101,17 @@ export class ListActionPlansResponseBody extends $dara.Model {
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE7****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Total data count under the current request conditions (optional; not returned by default).
+   * 
    * @example
    * 10
    */

package/src/models/ListActionPlansShrinkRequest.ts

@@ -3,13 +3,27 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListActionPlansShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The IDs of the execution plans to be queried.
+   */
   actionPlanIdsShrink?: string;
   /**
+   * @remarks
+   * The maximum number of entries per page.
+   * 
+   * Valid values: 1 to 100.
+   * 
+   * Default value: 20.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * A pagination token.
+   * 
    * @example
    * 1d2db86scXXXXXXXXXX
    */

package/src/models/ListExecutorsRequest.ts

@@ -3,25 +3,61 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListExecutorsRequestFilter extends $dara.Model {
+  /**
+   * @remarks
+   * The list of executor IDs. A maximum of 100 IDs are supported.
+   */
   executorIds?: string[];
+  /**
+   * @remarks
+   * Executor image.
+   * 
+   * @example
+   * m-f8z0dfa96luxxxxx
+   */
   image?: string;
+  /**
+   * @remarks
+   * The list of internal IP addresses. A maximum of 100 IP addresses are supported.
+   */
   ipAddresses?: string[];
   /**
+   * @remarks
+   * The job name. Exact filtering. Fuzzy query is not supported.
+   * 
    * @example
    * testJob
    */
   jobName?: string;
+  /**
+   * @remarks
+   * Executor status list.
+   */
   status?: string[];
   /**
+   * @remarks
+   * For jobs submitted after this time, the time in the region is converted into a UNIX timestamp (UI8).
+   * 
    * @example
    * 1703819914
    */
   timeCreatedAfter?: number;
   /**
+   * @remarks
+   * For jobs submitted before this time, the time in the region is converted into a Unix timestamp (for domestic sites, the UI8 region).
+   * 
    * @example
    * 1703820113
    */
   timeCreatedBefore?: number;
+  vpcId?: string;
+  /**
+   * @remarks
+   * The ID of the vSwitch.
+   * 
+   * @example
+   * vsw-xxx
+   */
   vswitchId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -32,6 +68,7 @@ export class ListExecutorsRequestFilter extends $dara.Model {
       status: 'Status',
       timeCreatedAfter: 'TimeCreatedAfter',
       timeCreatedBefore: 'TimeCreatedBefore',
+      vpcId: 'VpcId',
       vswitchId: 'VswitchId',
     };
   }
@@ -45,6 +82,7 @@ export class ListExecutorsRequestFilter extends $dara.Model {
       status: { 'type': 'array', 'itemType': 'string' },
       timeCreatedAfter: 'number',
       timeCreatedBefore: 'number',
+      vpcId: 'string',
       vswitchId: 'string',
     };
   }
@@ -68,13 +106,25 @@ export class ListExecutorsRequestFilter extends $dara.Model {
 }
 
 export class ListExecutorsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Queries the Executor filter conditions.
+   */
   filter?: ListExecutorsRequestFilter;
   /**
+   * @remarks
+   * The current page number.\\
+   * Starting value: 1\\
+   * Default value: 1
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. The number of entries returned per page. Default value: 50. Maximum value: 100.
+   * 
    * @example
    * 50
    */

package/src/models/ListExecutorsResponseBody.ts

@@ -3,7 +3,24 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListExecutorsResponseBodyExecutorsResourceDisks extends $dara.Model {
+  /**
+   * @remarks
+   * The size of the disk.
+   * 
+   * @example
+   * 10
+   */
   size?: number;
+  /**
+   * @remarks
+   * The category of the disk. The following disk categories are supported:
+   * 
+   * *   System: system disk.
+   * *   Data: data disk.
+   * 
+   * @example
+   * System
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -29,9 +46,27 @@ export class ListExecutorsResponseBodyExecutorsResourceDisks extends $dara.Model
 }
 
 export class ListExecutorsResponseBodyExecutorsResource extends $dara.Model {
+  /**
+   * @remarks
+   * The number of running CPUs.
+   * 
+   * @example
+   * 1
+   */
   cores?: number;
+  /**
+   * @remarks
+   * The array of the disks.
+   */
   disks?: ListExecutorsResponseBodyExecutorsResourceDisks[];
   instanceType?: string;
+  /**
+   * @remarks
+   * The total amount of memory resources. Unit: GiB.
+   * 
+   * @example
+   * 4
+   */
   memory?: number;
   static names(): { [key: string]: string } {
     return {
@@ -64,7 +99,21 @@ export class ListExecutorsResponseBodyExecutorsResource extends $dara.Model {
 }
 
 export class ListExecutorsResponseBodyExecutorsTags extends $dara.Model {
+  /**
+   * @remarks
+   * The key of the executor tag.
+   * 
+   * @example
+   * TestKey
+   */
   tagKey?: string;
+  /**
+   * @remarks
+   * The value of the executor tag.
+   * 
+   * @example
+   * TestValue
+   */
   tagValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -93,62 +142,156 @@ export class ListExecutorsResponseBodyExecutors extends $dara.Model {
   allocationSpec?: string;
   appName?: string;
   /**
+   * @remarks
+   * The executor number.
+   * 
    * @example
    * 0
    */
   arrayIndex?: number;
   blockDuration?: number;
   /**
+   * @remarks
+   * The time when the instance was created.
+   * 
    * @example
    * 2024-02-20 10:04:10
    */
   createTime?: string;
   /**
+   * @remarks
+   * The end time.
+   * 
    * @example
    * 2024-02-20 10:04:18
    */
   endTime?: string;
   /**
+   * @remarks
+   * The executor ID. The format is JobId-TaskName-ArrayIndex.
+   * 
    * @example
    * job-xxxx-task0-1
    */
   executorId?: string;
   expirationTime?: string;
+  /**
+   * @remarks
+   * The list of public IP addresses of the nodes.
+   */
   externalIpAddress?: string[];
+  /**
+   * @remarks
+   * The list of hostnames.
+   */
   hostName?: string[];
+  /**
+   * @remarks
+   * Executor image.
+   * 
+   * @example
+   * m-f8z0dfa96luxxxxx
+   */
   image?: string;
+  /**
+   * @remarks
+   * The list of internal IP addresses.
+   */
   ipAddress?: string[];
   /**
+   * @remarks
+   * The job ID.
+   * 
    * @example
    * job-hy1nggvyukuvkr******
    */
   jobId?: string;
   /**
+   * @remarks
+   * The job name.
+   * 
    * @example
    * testJob
    */
   jobName?: string;
   preemptible?: boolean;
+  /**
+   * @remarks
+   * The resource information.
+   */
   resource?: ListExecutorsResponseBodyExecutorsResource;
+  /**
+   * @remarks
+   * The type of the resource.
+   * 
+   * @example
+   * ECI
+   */
   resourceType?: string;
+  /**
+   * @remarks
+   * The start time.
+   * 
+   * @example
+   * 2024-02-20 10:04:13
+   */
   startTime?: string;
   /**
+   * @remarks
+   * The status of the executor. Valid values:
+   * 
+   * *   Pending
+   * *   Initing
+   * *   Succeed
+   * *   Failed
+   * *   Running
+   * *   Unknown
+   * *   Exception
+   * *   Retrying
+   * *   Expired
+   * *   Deleted
+   * 
    * @example
    * Running
    */
   status?: string;
   /**
+   * @remarks
+   * The description of the status reason.
+   * 
    * @example
    * Succeeded to release executor resource
    */
   statusReason?: string;
+  /**
+   * @remarks
+   * The list of executor tags.
+   */
   tags?: ListExecutorsResponseBodyExecutorsTags[];
   /**
+   * @remarks
+   * The name of the task.
+   * 
    * @example
    * task0
    */
   taskName?: string;
+  /**
+   * @remarks
+   * Indicate whether the job is a long-running job.
+   * 
+   * @example
+   * true
+   */
   taskSustainable?: boolean;
+  vpcId?: string;
+  /**
+   * @remarks
+   * The ID of the vSwitch.
+   * 
+   * @example
+   * vsw-xxx
+   */
   vswitchId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -175,6 +318,7 @@ export class ListExecutorsResponseBodyExecutors extends $dara.Model {
       tags: 'Tags',
       taskName: 'TaskName',
       taskSustainable: 'TaskSustainable',
+      vpcId: 'VpcId',
       vswitchId: 'VswitchId',
     };
   }
@@ -204,6 +348,7 @@ export class ListExecutorsResponseBodyExecutors extends $dara.Model {
       tags: { 'type': 'array', 'itemType': ListExecutorsResponseBodyExecutorsTags },
       taskName: 'string',
       taskSustainable: 'boolean',
+      vpcId: 'string',
       vswitchId: 'string',
     };
   }
@@ -233,23 +378,39 @@ export class ListExecutorsResponseBodyExecutors extends $dara.Model {
 }
 
 export class ListExecutorsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Executor list.
+   */
   executors?: ListExecutorsResponseBodyExecutors[];
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries returned per page.
+   * 
    * @example
    * 50
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 896D338C-E4F4-41EC-A154-D605E5DE****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 40
    */

package/src/models/ListExecutorsShrinkRequest.ts

@@ -3,13 +3,25 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListExecutorsShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Queries the Executor filter conditions.
+   */
   filterShrink?: string;
   /**
+   * @remarks
+   * The current page number.\\
+   * Starting value: 1\\
+   * Default value: 1
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. The number of entries returned per page. Default value: 50. Maximum value: 100.
+   * 
    * @example
    * 50
    */

package/src/models/ListImagesRequest.ts

@@ -3,17 +3,65 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListImagesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The source of the image. Valid values:
+   * 
+   * *   Public: public images provided by Alibaba Cloud.
+   * *   Custom: the custom image that you added.
+   * 
+   * @example
+   * Custom
+   */
   imageCategory?: string;
+  /**
+   * @remarks
+   * The array of image IDs.
+   */
   imageIds?: string[];
+  /**
+   * @remarks
+   * The array of image names.
+   */
   imageNames?: string[];
+  /**
+   * @remarks
+   * The type of the images. Valid values:
+   * 
+   * *   VM: virtual machine image.
+   * *   Container: the container image.
+   * 
+   * Default value: VM
+   * 
+   * @example
+   * VM
+   */
   imageType?: string;
+  /**
+   * @remarks
+   * The query mode. Valid values:
+   * 
+   * *   List: queries the list of all corresponding image versions.
+   * *   Merge: merges images to query the latest version list.
+   * 
+   * @example
+   * Merge
+   */
   mode?: string;
   /**
+   * @remarks
+   * The number of the page to return.\\
+   * Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of pieces per page.\\
+   * Default value: 20.
+   * 
    * @example
    * 10
    */