@alicloud/ehpcinstant20230701 3.2.1 → 3.3.0

package/src/models/GetActionPlanResponseBody.ts

@@ -4,11 +4,22 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetActionPlanResponseBodyRegions extends $dara.Model {
   /**
+   * @remarks
+   * The region ID of the instance.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The list of security groups available for the execution plan in the region.
+   */
   securityGroupIds?: string[];
+  /**
+   * @remarks
+   * The list of VSwitches available for the execution plan in the region.
+   */
   vSwitchIds?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -43,11 +54,17 @@ export class GetActionPlanResponseBodyRegions extends $dara.Model {
 
 export class GetActionPlanResponseBodyResources extends $dara.Model {
   /**
+   * @remarks
+   * The number of CPUs in the running environment.
+   * 
    * @example
    * 64
    */
   cores?: number;
   /**
+   * @remarks
+   * The memory size of the running environment. Unit: GiB.
+   * 
    * @example
    * 128
    */
@@ -77,68 +94,122 @@ export class GetActionPlanResponseBodyResources extends $dara.Model {
 
 export class GetActionPlanResponseBody 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 type of the resource.
+   * 
    * @example
    * Standard
    */
   allocationSpec?: string;
   /**
+   * @remarks
+   * The ID of the application.
+   * 
    * @example
    * ci-vm-rYfypJKwlN9Y
    */
   appId?: string;
   /**
+   * @remarks
+   * The time when the execution plan was created.
+   * 
    * @example
    * 2025-08-10 18:28:05
    */
   createTime?: string;
   /**
+   * @remarks
+   * The expected scale of resources for the execution plan. If the ResourceType parameter is set to VcpuCapacity, the execution plan is expected to have 10000 vCPUs.
+   * 
    * @example
    * 1000
    */
   desiredCapacity?: number;
   /**
+   * @remarks
+   * The computing power level.
+   * 
    * @example
    * General
    */
   level?: string;
   /**
+   * @remarks
+   * The pre-processing script. Base64 encoding is required.
+   * 
    * @example
    * bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==
    */
   prologScript?: string;
+  /**
+   * @remarks
+   * The list of resource configurations in the region where the execution plan runs.
+   */
   regions?: GetActionPlanResponseBodyRegions[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 896D338C-E4F4-41EC-A154-D605E5DE****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Target resource type: the capacity of vCPUs or the number of execution nodes. Valid values:
+   * 
+   * *   VCpuCapacity
+   * *   ExecutorCapacity
+   * 
    * @example
    * VCpuCapacity
    */
   resourceType?: string;
+  /**
+   * @remarks
+   * The list of resource configurations of the execution plan runtime environment.
+   */
   resources?: GetActionPlanResponseBodyResources[];
   /**
+   * @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 You cannot modify the parameters of an execution plan in this state.
+   * 
    * @example
    * Active
    */
   status?: string;
   /**
+   * @remarks
+   * The size of the resources currently managed by the execution plan.
+   * 
    * @example
    * 1000
    */
   totalCapacity?: number;
   /**
+   * @remarks
+   * The time when the execution plan was last modified.
+   * 
    * @example
    * 2025-08-10 18:28:05
    */

package/src/models/GetAppVersionsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetAppVersionsRequest extends $dara.Model {
   /**
    * @remarks
+   * The application name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,21 +14,41 @@ export class GetAppVersionsRequest extends $dara.Model {
    */
   appName?: string;
   /**
+   * @remarks
+   * The source of the image. Valid values:
+   * 
+   * Public: public images provided by Alibaba Cloud.
+   * 
+   * Custom: the custom image that you added.
+   * 
    * @example
    * Public
    */
   imageCategory?: string;
   /**
+   * @remarks
+   * The type of the images. Valid values:
+   * 
+   * VM: Virtual Machine Image
+   * 
+   * Container: container image
+   * 
    * @example
    * VM
    */
   imageType?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries to return on each page. Default value: 20.
+   * 
    * @example
    * 10
    */

package/src/models/GetAppVersionsResponseBody.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetAppVersionsResponseBodyAppVersions extends $dara.Model {
   /**
    * @remarks
+   * The image ID of the application.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,11 +14,17 @@ export class GetAppVersionsResponseBodyAppVersions extends $dara.Model {
    */
   imageId?: string;
   /**
+   * @remarks
+   * The application name.
+   * 
    * @example
    * V-Ray
    */
   name?: string;
   /**
+   * @remarks
+   * The application version.
+   * 
    * @example
    * v1.0
    */
@@ -47,28 +55,51 @@ export class GetAppVersionsResponseBodyAppVersions extends $dara.Model {
 }
 
 export class GetAppVersionsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of application versions.
+   */
   appVersions?: GetAppVersionsResponseBodyAppVersions[];
   /**
+   * @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
    * 04F0F334-1335-436C-A1D7-6C044FE7****
    */
   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/GetImageRequest.ts

@@ -4,12 +4,37 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetImageRequest extends $dara.Model {
   additionalRegionIds?: string[];
+  /**
+   * @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 image ID.
+   * 
    * @example
    * m-2ze74g5mvy4pjg*****
    */
   imageId?: string;
+  /**
+   * @remarks
+   * The type of the images. Valid values:
+   * 
+   * *   VM: virtual machine image.
+   * *   Container: the container image.
+   * 
+   * Default value: VM
+   * 
+   * @example
+   * VM
+   */
   imageType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GetImageResponseBody.ts

@@ -33,16 +33,25 @@ export class GetImageResponseBodyImageAdditionalRegionsInfo extends $dara.Model
 
 export class GetImageResponseBodyImageContainerImageSpecRegistryCredential extends $dara.Model {
   /**
+   * @remarks
+   * The password of the logon user.
+   * 
    * @example
    * userpassword
    */
   password?: string;
   /**
+   * @remarks
+   * The registered address of the image repository.
+   * 
    * @example
    * registry-vpc.cn-hangzhou.aliyuncs.com
    */
   server?: string;
   /**
+   * @remarks
+   * The username of the logon user.
+   * 
    * @example
    * username
    */
@@ -75,24 +84,46 @@ export class GetImageResponseBodyImageContainerImageSpecRegistryCredential exten
 export class GetImageResponseBodyImageContainerImageSpec extends $dara.Model {
   architecture?: string;
   /**
+   * @remarks
+   * Whether the instance is an Alibaba Cloud image repository Enterprise Edition.
+   * 
+   * *   True
+   * *   False
+   * 
    * @example
    * True
    */
   isACREnterprise?: boolean;
   /**
+   * @remarks
+   * Whether it is an Alibaba Cloud image repository.
+   * 
+   * *   True
+   * *   False
+   * 
    * @example
    * True
    */
   isACRRegistry?: boolean;
   osTag?: string;
   platform?: string;
+  /**
+   * @remarks
+   * The authentication of the private image repository.
+   */
   registryCredential?: GetImageResponseBodyImageContainerImageSpecRegistryCredential;
   /**
+   * @remarks
+   * The ID of the Container Registry Enterprise Edition image repository.
+   * 
    * @example
    * cri-xyz795ygf8k9****
    */
   registryCriId?: string;
   /**
+   * @remarks
+   * The endpoint of the container image.
+   * 
    * @example
    * registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest
    */
@@ -166,21 +197,33 @@ export class GetImageResponseBodyImageDocumentInfo extends $dara.Model {
 
 export class GetImageResponseBodyImageVMImageSpec extends $dara.Model {
   /**
+   * @remarks
+   * The type of the architecture.
+   * 
    * @example
    * x86_64
    */
   architecture?: string;
   /**
+   * @remarks
+   * The image ID.
+   * 
    * @example
    * m-uf60twafjtaart******
    */
   imageId?: string;
   /**
+   * @remarks
+   * The ID of the specific OS version.
+   * 
    * @example
    * CentOS  7.6 64 bit
    */
   osTag?: string;
   /**
+   * @remarks
+   * The type of the platform.
+   * 
    * @example
    * CentOS
    */
@@ -215,16 +258,29 @@ export class GetImageResponseBodyImageVMImageSpec extends $dara.Model {
 export class GetImageResponseBodyImage extends $dara.Model {
   additionalRegionsInfo?: GetImageResponseBodyImageAdditionalRegionsInfo[];
   appId?: string;
+  /**
+   * @remarks
+   * The configuration details of the container image.
+   */
   containerImageSpec?: GetImageResponseBodyImageContainerImageSpec;
   /**
+   * @remarks
+   * The time when the image was created.
+   * 
    * @example
    * 2022-12-23T09:51:39Z
    */
   createTime?: string;
+  /**
+   * @remarks
+   * The description of the image.
+   */
   description?: string;
   documentInfo?: GetImageResponseBodyImageDocumentInfo;
   /**
    * @remarks
+   * The type of the image.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -232,18 +288,31 @@ export class GetImageResponseBodyImage extends $dara.Model {
    */
   imageType?: string;
   /**
+   * @remarks
+   * The name of the image.
+   * 
    * @example
    * app-image
    */
   name?: string;
   /**
+   * @remarks
+   * The size of the image. Unit: GiB.
+   * 
    * @example
    * 40 GiB
    */
   size?: string;
   status?: string;
+  /**
+   * @remarks
+   * The configuration details of the virtual machine image.
+   */
   VMImageSpec?: GetImageResponseBodyImageVMImageSpec;
   /**
+   * @remarks
+   * The version.
+   * 
    * @example
    * v1.0
    */
@@ -304,18 +373,34 @@ export class GetImageResponseBodyImage extends $dara.Model {
 }
 
 export class GetImageResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details of the image.
+   */
   image?: GetImageResponseBodyImage;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * *   true: The task is successful.
+   * *   false: The error occurred.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * The total amount of data in this request.
+   * 
    * @example
    * 10
    */

package/src/models/GetImageShrinkRequest.ts

@@ -4,12 +4,37 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetImageShrinkRequest extends $dara.Model {
   additionalRegionIdsShrink?: string;
+  /**
+   * @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 image ID.
+   * 
    * @example
    * m-2ze74g5mvy4pjg*****
    */
   imageId?: string;
+  /**
+   * @remarks
+   * The type of the images. Valid values:
+   * 
+   * *   VM: virtual machine image.
+   * *   Container: the container image.
+   * 
+   * Default value: VM
+   * 
+   * @example
+   * VM
+   */
   imageType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GetJobRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetJobRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the job.
+   * 
    * @example
    * job-xxxx
    */