@alicloud/ehpcinstant20230701 3.2.1 → 3.4.0

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
    */

package/src/models/ListImagesResponseBody.ts

@@ -5,18 +5,39 @@ import * as $dara from '@darabonba/typescript';
 export class ListImagesResponseBodyImages extends $dara.Model {
   /**
    * @remarks
+   * The application ID.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ci-vm-kHLPzEWun6zz****
    */
   appId?: string;
   /**
+   * @remarks
+   * The time when the storage resource was created.
+   * 
    * @example
    * 2022-12-09T07:06:34Z
    */
   createTime?: string;
+  /**
+   * @remarks
+   * The description of the image.
+   */
   description?: string;
+  /**
+   * @remarks
+   * The document ID.
+   * 
+   * @example
+   * 30
+   */
   documentId?: number;
   /**
    * @remarks
+   * The image ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -25,6 +46,8 @@ export class ListImagesResponseBodyImages extends $dara.Model {
   imageId?: string;
   /**
    * @remarks
+   * The type of the image.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -32,17 +55,44 @@ export class ListImagesResponseBodyImages extends $dara.Model {
    */
   imageType?: string;
   /**
+   * @remarks
+   * The name of the image.
+   * 
    * @example
    * app-image
    */
   name?: string;
+  /**
+   * @remarks
+   * The ID of the specific OS version.
+   * 
+   * @example
+   * Ubuntu  22.04 64 bit
+   */
   osTag?: string;
+  /**
+   * @remarks
+   * The time when the image was updated.
+   * 
+   * @example
+   * 2024-09-25 14:15:28
+   */
   updateTime?: string;
   /**
+   * @remarks
+   * The version of the image.
+   * 
    * @example
    * v1.0
    */
   version?: string;
+  /**
+   * @remarks
+   * The weight.
+   * 
+   * @example
+   * 70
+   */
   weight?: number;
   static names(): { [key: string]: string } {
     return {
@@ -86,28 +136,50 @@ export class ListImagesResponseBodyImages extends $dara.Model {
 }
 
 export class ListImagesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of image information.
+   */
   images?: ListImagesResponseBodyImages[];
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries returned per page.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 896D338C-E4F4-41EC-A154-D605E5DE****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 1
    */

package/src/models/ListImagesShrinkRequest.ts

@@ -3,17 +3,65 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListImagesShrinkRequest 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.
+   */
   imageIdsShrink?: string;
+  /**
+   * @remarks
+   * The array of image names.
+   */
   imageNamesShrink?: 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
    */

package/src/models/ListJobExecutorsRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListJobExecutorsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the job.
+   * 
    * @example
    * job-xxx
    */
   jobId?: string;
   /**
+   * @remarks
+   * The page number of the page to return.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The job name.
+   * 
    * @example
    * task0
    */