@alicloud/ehpcinstant20230701 3.2.1 → 3.4.0

package/src/models/AddImageRequest.ts

@@ -6,16 +6,25 @@ import * as $dara from '@darabonba/typescript';
  */
 export class AddImageRequestContainerImageSpecRegistryCredential 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
    */
@@ -47,22 +56,44 @@ export class AddImageRequestContainerImageSpecRegistryCredential extends $dara.M
 
 export class AddImageRequestContainerImageSpec extends $dara.Model {
   /**
+   * @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;
+  /**
+   * @remarks
+   * The authentication of the private image repository.
+   */
   registryCredential?: AddImageRequestContainerImageSpecRegistryCredential;
   /**
+   * @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
    */
@@ -101,6 +132,9 @@ export class AddImageRequestContainerImageSpec extends $dara.Model {
 
 export class AddImageRequestVMImageSpec extends $dara.Model {
   /**
+   * @remarks
+   * The image ID.
+   * 
    * @example
    * m-bp1akkkr1rkxtb******
    */
@@ -127,22 +161,52 @@ export class AddImageRequestVMImageSpec extends $dara.Model {
 }
 
 export class AddImageRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The configurations of the container image.
+   */
   containerImageSpec?: AddImageRequestContainerImageSpec;
+  /**
+   * @remarks
+   * The description of the image.
+   * 
+   * @example
+   * Test image
+   */
   description?: string;
+  /**
+   * @remarks
+   * The type of the images. Valid values:
+   * 
+   * *   VM: virtual machine image.
+   * *   Container: the container image.
+   * 
+   * @example
+   * VM
+   */
   imageType?: string;
   /**
+   * @remarks
+   * The version of the image.
+   * 
    * @example
    * V1.0
    */
   imageVersion?: string;
   /**
    * @remarks
+   * The name of the custom image.
+   * 
    * This parameter is required.
    * 
    * @example
    * app-image
    */
   name?: string;
+  /**
+   * @remarks
+   * The image configuration of the virtual machine.
+   */
   VMImageSpec?: AddImageRequestVMImageSpec;
   static names(): { [key: string]: string } {
     return {

package/src/models/AddImageResponseBody.ts

@@ -4,16 +4,28 @@ import * as $dara from '@darabonba/typescript';
 
 export class AddImageResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The image ID.
+   * 
    * @example
    * m-bp1akkkr1rkxtb******
    */
   imageId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
    * @example
    * True
    */

package/src/models/AddImageShrinkRequest.ts

@@ -3,22 +3,52 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AddImageShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The configurations of the container image.
+   */
   containerImageSpecShrink?: string;
+  /**
+   * @remarks
+   * The description of the image.
+   * 
+   * @example
+   * Test image
+   */
   description?: string;
+  /**
+   * @remarks
+   * The type of the images. Valid values:
+   * 
+   * *   VM: virtual machine image.
+   * *   Container: the container image.
+   * 
+   * @example
+   * VM
+   */
   imageType?: string;
   /**
+   * @remarks
+   * The version of the image.
+   * 
    * @example
    * V1.0
    */
   imageVersion?: string;
   /**
    * @remarks
+   * The name of the custom image.
+   * 
    * This parameter is required.
    * 
    * @example
    * app-image
    */
   name?: string;
+  /**
+   * @remarks
+   * The image configuration of the virtual machine.
+   */
   VMImageSpecShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateActionPlanRequest.ts

@@ -4,12 +4,23 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateActionPlanRequestRegions extends $dara.Model {
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The list of security groups available for the execution plan in the region. You can have 0 to 5 security groups.
+   */
   securityGroupId?: string[];
   securityGroupIds?: string[];
+  /**
+   * @remarks
+   * The list of VSwitches available for the execution plan in the region. Supports 0 to 5 VSwitches.
+   */
   vSwitchIds?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -49,11 +60,17 @@ export class CreateActionPlanRequestRegions extends $dara.Model {
 
 export class CreateActionPlanRequestResources extends $dara.Model {
   /**
+   * @remarks
+   * The number of CPUs in the running environment.
+   * 
    * @example
    * 2
    */
   cores?: number;
   /**
+   * @remarks
+   * The memory size of the running environment. Unit: GiB.
+   * 
    * @example
    * 4
    */
@@ -83,43 +100,90 @@ export class CreateActionPlanRequestResources extends $dara.Model {
 
 export class CreateActionPlanRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the execution plan.
+   * 
    * @example
    * TestActionPlan
    */
   actionPlanName?: string;
   /**
+   * @remarks
+   * The type of the resource.
+   * 
+   * *   Standard
+   * *   Dedicated: You must enable a whitelist for use.
+   * *   Economic: You must enable a whitelist for use.
+   * 
    * @example
    * Standard
    */
   allocationSpec?: string;
   /**
+   * @remarks
+   * The ID of the application.
+   * 
    * @example
    * ci-vm-rYfypJKwlN9Y
    */
   appId?: 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. This value is valid only when the resource type is Economic. The following disk categories are supported:
+   * 
+   * *   General
+   * *   Performance
+   * 
+   * Default value: General
+   * 
    * @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?: CreateActionPlanRequestRegions[];
   /**
+   * @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. You can configure 1 to 10 resources.
+   * 
+   * @example
+   * 1000
+   */
   resources?: CreateActionPlanRequestResources[];
   /**
+   * @remarks
+   * The running-job script. Base64 encoding is required.
+   * 
    * @example
    * bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==
    */

package/src/models/CreateActionPlanResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateActionPlanResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the execution plan.
+   * 
    * @example
    * ap-hz036ubmx2qmw93k****
    */
   actionPlanId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 896D338C-E4F4-41EC-A154-D605E5DE****
    */

package/src/models/CreateActionPlanShrinkRequest.ts

@@ -4,43 +4,90 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateActionPlanShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the execution plan.
+   * 
    * @example
    * TestActionPlan
    */
   actionPlanName?: string;
   /**
+   * @remarks
+   * The type of the resource.
+   * 
+   * *   Standard
+   * *   Dedicated: You must enable a whitelist for use.
+   * *   Economic: You must enable a whitelist for use.
+   * 
    * @example
    * Standard
    */
   allocationSpec?: string;
   /**
+   * @remarks
+   * The ID of the application.
+   * 
    * @example
    * ci-vm-rYfypJKwlN9Y
    */
   appId?: 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. This value is valid only when the resource type is Economic. The following disk categories are supported:
+   * 
+   * *   General
+   * *   Performance
+   * 
+   * Default value: General
+   * 
    * @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.
+   */
   regionsShrink?: 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. You can configure 1 to 10 resources.
+   * 
+   * @example
+   * 1000
+   */
   resourcesShrink?: string;
   /**
+   * @remarks
+   * The running-job script. Base64 encoding is required.
+   * 
    * @example
    * bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==
    */