@alicloud/ehpcinstant20230701 3.2.0 → 3.3.0

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

package/src/models/ListPoolsShrinkRequest.ts

@@ -3,13 +3,23 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListPoolsShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Queries the filter conditions of a resource pool.
+   */
   filterShrink?: string;
   /**
+   * @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/ListTagResourcesRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListTagResourcesRequestTag extends $dara.Model {
   /**
+   * @remarks
+   * The key of the tag.
+   * 
    * @example
    * TestKey
    */
   key?: string;
   /**
+   * @remarks
+   * The value of the tag.
+   * 
    * @example
    * TestValue
    */
@@ -38,24 +44,43 @@ export class ListTagResourcesRequestTag extends $dara.Model {
 
 export class ListTagResourcesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The number of records per page.
+   * 
    * @example
    * 20
    */
   maxResult?: number;
   /**
+   * @remarks
+   * A pagination token.
+   * 
    * @example
    * 1d2db86scXXXXXXXXXX
    */
   nextToken?: string;
+  /**
+   * @remarks
+   * The list of resource IDs. Valid values of N: 1 to 50.
+   */
   resourceId?: string[];
   /**
    * @remarks
+   * The type of the resource. Valid values:
+   * 
+   * *   Job
+   * *   Executor
+   * 
    * This parameter is required.
    * 
    * @example
    * Job
    */
   resourceType?: string;
+  /**
+   * @remarks
+   * The tags to add to the replication pair-consistent group. You can specify up to 20 tags.
+   */
   tag?: ListTagResourcesRequestTag[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListTagResourcesResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListTagResourcesResponseBodyTagResourcesTagResource extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the resource.
+   * 
    * @example
    * job-xxxxxxxx
    */
   resourceId?: string;
   /**
+   * @remarks
+   * The type of the resource.
+   * 
    * @example
    * Job
    */
   resourceType?: string;
   /**
+   * @remarks
+   * The key of the tag that is added to the resource.
+   * 
    * @example
    * TestKey
    */
   tagKey?: string;
   /**
+   * @remarks
+   * The value of the tag.
+   * 
    * @example
    * TestValue
    */
@@ -78,15 +90,25 @@ export class ListTagResourcesResponseBodyTagResources extends $dara.Model {
 
 export class ListTagResourcesResponseBody extends $dara.Model {
   /**
+   * @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.
+   * 
    * @example
    * 1d2db86scXXXXXXXXXX
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE7****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The resource list.
+   */
   tagResources?: ListTagResourcesResponseBodyTagResources;
   static names(): { [key: string]: string } {
     return {

package/src/models/RemoveImageRequest.ts

@@ -5,12 +5,24 @@ import * as $dara from '@darabonba/typescript';
 export class RemoveImageRequest extends $dara.Model {
   /**
    * @remarks
+   * The image ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * m-bp14wakr1rkxtb******
    */
   imageId?: string;
+  /**
+   * @remarks
+   * The type of the images. Valid values:
+   * 
+   * *   VM: Virtual Machine Image
+   * *   Container: container image
+   * 
+   * @example
+   * VM
+   */
   imageType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/RemoveImageResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class RemoveImageResponseBody extends $dara.Model {
   /**
+   * @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
    */

package/src/models/SynchronizeAppRequest.ts

@@ -5,12 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class SynchronizeAppRequest extends $dara.Model {
   /**
    * @remarks
+   * The application ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * ci-vm-rYfypJKwlN9Y
    */
   appId?: string;
+  /**
+   * @remarks
+   * The list of arrays that are synchronized to the specified region. If \\"all\\" is included, it is synchronized to all other unsynchronized regions by default.
+   */
   targetRegionIds?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/SynchronizeAppResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class SynchronizeAppResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 896D338C-E4F4-41EC-A154-D605E5DE****
    */

package/src/models/SynchronizeAppShrinkRequest.ts

@@ -5,12 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class SynchronizeAppShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The application ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * ci-vm-rYfypJKwlN9Y
    */
   appId?: string;
+  /**
+   * @remarks
+   * The list of arrays that are synchronized to the specified region. If \\"all\\" is included, it is synchronized to all other unsynchronized regions by default.
+   */
   targetRegionIdsShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/TagResourcesRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class TagResourcesRequestTag extends $dara.Model {
   /**
    * @remarks
+   * The key of the tag. 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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,6 +14,9 @@ export class TagResourcesRequestTag extends $dara.Model {
    */
   key?: string;
   /**
+   * @remarks
+   * The value of the tag. You can specify empty strings as tag values. The tag value can be up to 128 characters in length and cannot contain http:// or https://.
+   * 
    * @example
    * TestValue
    */
@@ -42,11 +47,18 @@ export class TagResourcesRequestTag extends $dara.Model {
 export class TagResourcesRequest extends $dara.Model {
   /**
    * @remarks
+   * The list of resource IDs. Valid values of N: 1 to 50.
+   * 
    * This parameter is required.
    */
   resourceId?: string[];
   /**
    * @remarks
+   * The type of the resource. Valid values:
+   * 
+   * *   Job
+   * *   Executor
+   * 
    * This parameter is required.
    * 
    * @example
@@ -55,6 +67,8 @@ export class TagResourcesRequest extends $dara.Model {
   resourceType?: string;
   /**
    * @remarks
+   * The tags to add to the replication pair-consistent group. You can specify up to 20 tags.
+   * 
    * This parameter is required.
    */
   tag?: TagResourcesRequestTag[];

package/src/models/TagResourcesResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class TagResourcesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 896D338C-E4F4-41EC-A154-D605E5DE****
    */

package/src/models/UnTagResourcesRequest.ts

@@ -4,23 +4,37 @@ import * as $dara from '@darabonba/typescript';
 
 export class UnTagResourcesRequest extends $dara.Model {
   /**
+   * @remarks
+   * Whether to delete all tags of the target resource. This field takes effect only when TagKey.N is left empty. Default False
+   * 
    * @example
    * False
    */
   all?: boolean;
   /**
    * @remarks
+   * The list of resource IDs. Valid values of N: 1 to 50.
+   * 
    * This parameter is required.
    */
   resourceId?: string[];
   /**
    * @remarks
+   * The type of the resource. Valid values:
+   * 
+   * *   Job
+   * *   Executor
+   * 
    * This parameter is required.
    * 
    * @example
    * Job
    */
   resourceType?: string;
+  /**
+   * @remarks
+   * The list of tag keys, which can contain a maximum of 20 child items.
+   */
   tagKey?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UnTagResourcesResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UnTagResourcesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 896D338C-E4F4-41EC-A154-D605E5DE****
    */