@alicloud/ehpcinstant20230701 3.2.1 → 3.4.0

package/src/models/ListJobExecutorsResponseBody.ts

@@ -3,13 +3,62 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListJobExecutorsResponseBodyExecutorStatus extends $dara.Model {
+  /**
+   * @remarks
+   * The number of executers in the Deleted state.
+   * 
+   * @example
+   * 1
+   */
   deleted?: number;
+  /**
+   * @remarks
+   * The number of executers in the abnormal state.
+   * 
+   * @example
+   * 1
+   */
   exception?: number;
+  /**
+   * @remarks
+   * The number of executers in the Failed state.
+   * 
+   * @example
+   * 1
+   */
   failed?: number;
+  /**
+   * @remarks
+   * The number of executers in the initialized state.
+   * 
+   * @example
+   * 1
+   */
   initing?: number;
+  /**
+   * @remarks
+   * The number of executers in the queued state.
+   * 
+   * @example
+   * 1
+   */
   pending?: number;
   restarting?: number;
+  /**
+   * @remarks
+   * The number of executers in the running state.
+   * 
+   * @example
+   * 1
+   */
   running?: number;
+  /**
+   * @remarks
+   * The number of executoresin the Successful state.
+   * 
+   * @example
+   * 1
+   */
   succeeded?: number;
   suspended?: number;
   static names(): { [key: string]: string } {
@@ -50,7 +99,21 @@ export class ListJobExecutorsResponseBodyExecutorStatus extends $dara.Model {
 }
 
 export class ListJobExecutorsResponseBodyExecutorsTags 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 {
@@ -78,38 +141,94 @@ export class ListJobExecutorsResponseBodyExecutorsTags extends $dara.Model {
 export class ListJobExecutorsResponseBodyExecutors extends $dara.Model {
   allocationSpec?: string;
   /**
+   * @remarks
+   * The executor index number.
+   * 
    * @example
    * 0
    */
   arrayIndex?: number;
   blockDuration?: number;
   /**
+   * @remarks
+   * The time when the storage resource 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
+   * An array of node hostnames.
+   */
   hostName?: string[];
+  /**
+   * @remarks
+   * The list of node IP addresses.
+   */
   ipAddress?: string[];
   preemptible?: boolean;
+  /**
+   * @remarks
+   * The create 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
    * Creating executor
    */
   statusReason?: string;
+  /**
+   * @remarks
+   * The list of executor tags.
+   */
   tags?: ListJobExecutorsResponseBodyExecutorsTags[];
   static names(): { [key: string]: string } {
     return {
@@ -173,34 +292,60 @@ export class ListJobExecutorsResponseBodyExecutors extends $dara.Model {
 }
 
 export class ListJobExecutorsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Executor status statistics.
+   */
   executorStatus?: ListJobExecutorsResponseBodyExecutorStatus;
+  /**
+   * @remarks
+   * The executor list.
+   */
   executors?: ListJobExecutorsResponseBodyExecutors[];
   /**
+   * @remarks
+   * The job ID.
+   * 
    * @example
    * job-xxxx
    */
   jobId?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 896D338C-E4F4-41EC-A154-D605E5DE****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The job name.
+   * 
    * @example
    * task0
    */
   taskName?: string;
   /**
+   * @remarks
+   * The total number of list entries.
+   * 
    * @example
    * 50
    */

package/src/models/ListJobsRequest.ts

@@ -4,26 +4,53 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListJobsRequestFilter extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the job.
+   * 
    * @example
    * job-xxxx
    */
   jobId?: string;
   /**
+   * @remarks
+   * The job name. Fuzzy search is supported.
+   * 
    * @example
    * testJob
    */
   jobName?: string;
   /**
+   * @remarks
+   * The job status. Valid values:
+   * 
+   * *   Pending
+   * *   initing
+   * *   Succeed
+   * *   Failed
+   * *   Running
+   * *   Exception
+   * *   Retrying
+   * *   Expired
+   * *   Suspended
+   * *   Restarting
+   * *   Deleted
+   * 
    * @example
    * Running
    */
   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
    */
@@ -59,11 +86,23 @@ export class ListJobsRequestFilter extends $dara.Model {
 
 export class ListJobsRequestSortBy extends $dara.Model {
   /**
+   * @remarks
+   * The sorting label. Valid values:
+   * 
+   * *   time_start
+   * *   job_name
+   * 
    * @example
    * time_start
    */
   label?: string;
   /**
+   * @remarks
+   * The sorting order. Valid values:
+   * 
+   * *   ASC (default): ascending order
+   * *   DESC: descending order
+   * 
    * @example
    * ASC
    */
@@ -92,17 +131,35 @@ export class ListJobsRequestSortBy extends $dara.Model {
 }
 
 export class ListJobsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Queries job filter conditions.
+   */
   filter?: ListJobsRequestFilter;
   /**
+   * @remarks
+   * The page number.
+   * 
+   * Pages start from page 1.
+   * 
+   * Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries on the current page. Default value: 50. Maximum value: 100.
+   * 
    * @example
    * 50
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * The sorting method.
+   */
   sortBy?: ListJobsRequestSortBy;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListJobsResponseBody.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListJobsResponseBodyJobListTags extends $dara.Model {
+  /**
+   * @remarks
+   * The key of the job tag.
+   * 
+   * @example
+   * TestKey
+   */
   tagKey?: string;
+  /**
+   * @remarks
+   * The value of the job tag.
+   * 
+   * @example
+   * TestValue
+   */
   tagValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -29,60 +43,115 @@ export class ListJobsResponseBodyJobListTags extends $dara.Model {
 }
 
 export class ListJobsResponseBodyJobList extends $dara.Model {
+  /**
+   * @remarks
+   * The additional information about the application.
+   * 
+   * @example
+   * {\\"xxx\\": \\"xxxxx\\"}
+   */
   appExtraInfo?: string;
   appName?: string;
   /**
+   * @remarks
+   * The time when the job was submitted.
+   * 
    * @example
    * 2024-01-25 12:29:21
    */
   createTime?: string;
   /**
+   * @remarks
+   * The end time of the job.
+   * 
    * @example
    * 2024-01-25 12:35:23
    */
   endTime?: string;
   /**
+   * @remarks
+   * The number of running nodes.
+   * 
    * @example
    * 1
    */
   executorCount?: number;
   /**
+   * @remarks
+   * The description of the job.
+   * 
    * @example
    * Demo
    */
   jobDescription?: string;
   /**
+   * @remarks
+   * The ID of the job.
+   * 
    * @example
    * job-xxx
    */
   jobId?: string;
   /**
+   * @remarks
+   * The job name.
+   * 
    * @example
    * testJob
    */
   jobName?: string;
   /**
+   * @remarks
+   * The UID of the creator.
+   * 
    * @example
    * 129**********
    */
   ownerUid?: string;
   /**
+   * @remarks
+   * The start time of the job.
+   * 
    * @example
    * 2024-01-25 12:29:23
    */
   startTime?: string;
   /**
+   * @remarks
+   * The status of the job. Valid values:
+   * 
+   * *   Pending
+   * *   Initing
+   * *   Succeed
+   * *   Failed
+   * *   Running
+   * *   Exception
+   * *   Retrying
+   * *   Expired
+   * *   Deleting
+   * *   Deleted
+   * 
    * @example
    * Running
    */
   status?: string;
+  /**
+   * @remarks
+   * The list of job tags.
+   */
   tags?: ListJobsResponseBodyJobListTags[];
   /**
+   * @remarks
+   * The number of tasks.
+   * 
    * @example
    * 1
    */
   taskCount?: number;
   /**
+   * @remarks
+   * Indicate whether the job is a long-running job.
+   * 
    * @example
    * true
    */
@@ -138,23 +207,39 @@ export class ListJobsResponseBodyJobList extends $dara.Model {
 }
 
 export class ListJobsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of jobs.
+   */
   jobList?: ListJobsResponseBodyJobList[];
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries returned per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 896D338C-E4F4-41EC-A154-D605E5DE****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned. This parameter is optional and is not returned by default.
+   * 
    * @example
    * 1
    */

package/src/models/ListJobsShrinkRequest.ts

@@ -3,17 +3,35 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListJobsShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Queries job filter conditions.
+   */
   filterShrink?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
+   * Pages start from page 1.
+   * 
+   * Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries on the current page. Default value: 50. Maximum value: 100.
+   * 
    * @example
    * 50
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * The sorting method.
+   */
   sortByShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListPoolsRequest.ts

@@ -3,14 +3,28 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListPoolsRequestFilter extends $dara.Model {
+  /**
+   * @remarks
+   * Queries the list of resource pool names.
+   */
   poolName?: string[];
+  /**
+   * @remarks
+   * Queries resource pool status list.
+   */
   status?: string[];
   /**
+   * @remarks
+   * For node pools created after this time, the time in the region is converted into a UNIX timestamp.
+   * 
    * @example
    * 1703819914
    */
   timeCreatedAfter?: number;
   /**
+   * @remarks
+   * For node pools created before this time, the time in the region is converted into a UNIX timestamp.
+   * 
    * @example
    * 1703820113
    */
@@ -49,13 +63,23 @@ export class ListPoolsRequestFilter extends $dara.Model {
 }
 
 export class ListPoolsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Queries the filter conditions of a resource pool.
+   */
   filter?: ListPoolsRequestFilter;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries on each page. Maximum value: 50. Default value: 10.
+   * 
    * @example
    * 10
    */

package/src/models/ListPoolsResponseBody.ts

@@ -4,26 +4,56 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListPoolsResponseBodyPoolList extends $dara.Model {
   /**
+   * @remarks
+   * Indices whether the resource pool is the default resource pool. Valid values:
+   * 
+   * *   **true**
+   * *   **false**
+   * 
    * @example
    * true
    */
   isDefault?: boolean;
   /**
+   * @remarks
+   * The maximum number of execution nodes that can run concurrently in a resource pool.
+   * 
    * @example
    * 2000
    */
   maxExectorNum?: number;
   /**
+   * @remarks
+   * The name of the resource pool.
+   * 
+   * *   The value can be up to 15 characters in length.
+   * *   It can contain digits, uppercase letters, lowercase letters, underscores (_), and dots (.).
+   * 
    * @example
    * PoolTest
    */
   poolName?: string;
   /**
+   * @remarks
+   * The priority of the resource pool.
+   * 
+   * *   You can set a priority in the range of 1 to 99. The default value is 1, which is the lowest priority.
+   * *   Jobs submitted to a resource pool with a higher priority level value will be scheduled before pending jobs in a resource pool with a lower priority level value, and the priority level of the resource pool takes precedence over the priority of the job.
+   * 
    * @example
    * 1
    */
   priority?: number;
   /**
+   * @remarks
+   * The status of the resource pool. Valid values:
+   * 
+   * *   Creating: The resource pool is being created.
+   * *   Updating: The resource pool is being updated.
+   * *   Deleting: The resource pool is being deleted.
+   * *   Working: The resource pool is working.
+   * *   Deleted: The resource pool is deleted.
+   * 
    * @example
    * Working
    */
@@ -59,15 +89,25 @@ export class ListPoolsResponseBodyPoolList extends $dara.Model {
 
 export class ListPoolsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries on each page. Maximum value: 50. Default value: 10.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * Queries the resource pool list.
+   */
   poolList?: ListPoolsResponseBodyPoolList[];
   /**
    * @remarks
@@ -78,6 +118,9 @@ export class ListPoolsResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of list entries.
+   * 
    * @example
    * 2
    */