@alicloud/adb20211201 4.7.0 → 5.0.0

package/src/models/CreateDbresourceGroupRequest.ts

@@ -2,8 +2,119 @@
 import * as $dara from '@darabonba/typescript';
 
 
+export class CreateDBResourceGroupRequestAtmConfig extends $dara.Model {
+  /**
+   * @example
+   * 2
+   */
+  authNodeNum?: number;
+  /**
+   * @example
+   * 8ACU
+   */
+  authNodeSpec?: string;
+  /**
+   * @example
+   * 2
+   */
+  insertNodeNum?: number;
+  /**
+   * @example
+   * 8ACU
+   */
+  insertNodeSpec?: string;
+  /**
+   * @example
+   * 10
+   */
+  selectNodeCacheSize?: number;
+  /**
+   * @example
+   * 1
+   */
+  selectNodeNum?: number;
+  /**
+   * @example
+   * 8ACU
+   */
+  selectNodeSpec?: string;
+  /**
+   * @example
+   * 1
+   */
+  storageNodeDiskSize?: number;
+  /**
+   * @example
+   * essd_pl1
+   */
+  storageNodeDiskType?: string;
+  /**
+   * @example
+   * 2
+   */
+  storageNodeNum?: number;
+  /**
+   * @example
+   * 8ACU
+   */
+  storageNodeSpec?: string;
+  static names(): { [key: string]: string } {
+    return {
+      authNodeNum: 'AuthNodeNum',
+      authNodeSpec: 'AuthNodeSpec',
+      insertNodeNum: 'InsertNodeNum',
+      insertNodeSpec: 'InsertNodeSpec',
+      selectNodeCacheSize: 'SelectNodeCacheSize',
+      selectNodeNum: 'SelectNodeNum',
+      selectNodeSpec: 'SelectNodeSpec',
+      storageNodeDiskSize: 'StorageNodeDiskSize',
+      storageNodeDiskType: 'StorageNodeDiskType',
+      storageNodeNum: 'StorageNodeNum',
+      storageNodeSpec: 'StorageNodeSpec',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      authNodeNum: 'number',
+      authNodeSpec: 'string',
+      insertNodeNum: 'number',
+      insertNodeSpec: 'string',
+      selectNodeCacheSize: 'number',
+      selectNodeNum: 'number',
+      selectNodeSpec: 'string',
+      storageNodeDiskSize: 'number',
+      storageNodeDiskType: 'string',
+      storageNodeNum: 'number',
+      storageNodeSpec: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CreateDBResourceGroupRequestGpuElasticPlanRules extends $dara.Model {
+  /**
+   * @remarks
+   * The end time as a cron expression. The interval must be at least 1 hour.
+   * 
+   * @example
+   * 0 0 3 * * ?
+   */
   endCronExpression?: string;
+  /**
+   * @remarks
+   * The start time as a cron expression. The interval must be at least 1 hour.
+   * 
+   * @example
+   * 0 0 2 * * ?
+   */
   startCronExpression?: string;
   static names(): { [key: string]: string } {
     return {
@@ -29,7 +140,20 @@ export class CreateDBResourceGroupRequestGpuElasticPlanRules extends $dara.Model
 }
 
 export class CreateDBResourceGroupRequestGpuElasticPlan extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to enable the elastic plan immediately after creation. Valid values:
+   * - true: enables the elastic plan immediately.
+   * - false: does not enable the elastic plan.
+   * 
+   * @example
+   * true
+   */
   enabled?: boolean;
+  /**
+   * @remarks
+   * The list of rules.
+   */
   rules?: CreateDBResourceGroupRequestGpuElasticPlanRules[];
   static names(): { [key: string]: string } {
     return {
@@ -59,36 +183,57 @@ export class CreateDBResourceGroupRequestGpuElasticPlan extends $dara.Model {
 
 export class CreateDBResourceGroupRequestRayConfigWorkerGroups extends $dara.Model {
   /**
+   * @remarks
+   * The allocation unit.
+   * 
    * @example
    * 1
    */
   allocateUnit?: string;
   /**
+   * @remarks
+   * The name of the worker group.
+   * 
    * @example
    * test
    */
   groupName?: string;
   /**
+   * @remarks
+   * The maximum number of workers.
+   * 
    * @example
    * 2
    */
   maxWorkerQuantity?: number;
   /**
+   * @remarks
+   * The minimum number of workers.
+   * 
    * @example
    * 1
    */
   minWorkerQuantity?: number;
   /**
+   * @remarks
+   * The disk size of the worker node.
+   * 
    * @example
    * 100G
    */
   workerDiskCapacity?: string;
   /**
+   * @remarks
+   * The node specifications of the worker node.
+   * 
    * @example
    * xlarge
    */
   workerSpecName?: string;
   /**
+   * @remarks
+   * The resource type of the worker node.
+   * 
    * @example
    * GPU
    */
@@ -128,19 +273,58 @@ export class CreateDBResourceGroupRequestRayConfigWorkerGroups extends $dara.Mod
 
 export class CreateDBResourceGroupRequestRayConfig extends $dara.Model {
   /**
+   * @remarks
+   * The Ray cluster type. Valid values:
+   * 
+   * - BASIC: basic type, non-high-availability
+   * - HIGH_AVAILABILITY: high-availability type
+   * 
    * @example
    * BASIC
    */
   category?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable user ENI connectivity.
+   */
   enableUserEni?: boolean;
+  /**
+   * @remarks
+   * The allocation unit of the head node.
+   * 
+   * @example
+   * 1
+   */
   headAllocateUnit?: string;
+  /**
+   * @remarks
+   * The disk size of the head node.
+   * 
+   * @example
+   * 100G
+   */
   headDiskCapacity?: string;
   /**
+   * @remarks
+   * The node specifications of the head node.
+   * 
    * @example
    * xlarge
    */
   headSpec?: string;
+  /**
+   * @remarks
+   * The resource type of the head node.
+   * 
+   * @example
+   * CPU
+   */
   headSpecType?: string;
+  userDefinedRequirements?: string;
+  /**
+   * @remarks
+   * The list of Ray worker group configurations.
+   */
   workerGroups?: CreateDBResourceGroupRequestRayConfigWorkerGroups[];
   static names(): { [key: string]: string } {
     return {
@@ -150,6 +334,7 @@ export class CreateDBResourceGroupRequestRayConfig extends $dara.Model {
       headDiskCapacity: 'HeadDiskCapacity',
       headSpec: 'HeadSpec',
       headSpecType: 'HeadSpecType',
+      userDefinedRequirements: 'UserDefinedRequirements',
       workerGroups: 'WorkerGroups',
     };
   }
@@ -162,6 +347,7 @@ export class CreateDBResourceGroupRequestRayConfig extends $dara.Model {
       headDiskCapacity: 'string',
       headSpec: 'string',
       headSpecType: 'string',
+      userDefinedRequirements: 'string',
       workerGroups: { 'type': 'array', 'itemType': CreateDBResourceGroupRequestRayConfigWorkerGroups },
     };
   }
@@ -182,10 +368,9 @@ export class CreateDBResourceGroupRequestRules extends $dara.Model {
   /**
    * @remarks
    * The name of the resource group.
-   * 
-   * *   The name can be up to 255 characters in length.
-   * *   The name must start with a letter or digit.
-   * *   The name can contain letters, digits, hyphens (-), and underscores (_).
+   * - The name can be up to 255 characters in length.
+   * - The name must start with a digit, an uppercase letter, or a lowercase letter.
+   * - The name can contain digits, uppercase letters, lowercase letters, hyphens (-), and underscores (_).
    * 
    * @example
    * test_group
@@ -193,7 +378,7 @@ export class CreateDBResourceGroupRequestRules extends $dara.Model {
   groupName?: string;
   /**
    * @remarks
-   * The execution duration of the query. Unit: milliseconds.
+   * The query execution time threshold. Unit: milliseconds (ms).
    * 
    * @example
    * 180000
@@ -201,7 +386,7 @@ export class CreateDBResourceGroupRequestRules extends $dara.Model {
   queryTime?: string;
   /**
    * @remarks
-   * The name of the resource group to which you want to resubmit the query job.
+   * The name of the destination resource group.
    * 
    * @example
    * job
@@ -233,30 +418,46 @@ export class CreateDBResourceGroupRequestRules extends $dara.Model {
 }
 
 export class CreateDBResourceGroupRequest extends $dara.Model {
+  atmConfig?: CreateDBResourceGroupRequestAtmConfig;
   /**
+   * @remarks
+   * The automatic stop interval. Unit: minutes (m).
+   * 
    * @example
    * 5m
    */
   autoStopInterval?: string;
   /**
    * @remarks
-   * A reserved parameter.
+   * The classification of the resource group. Valid values:
+   * - SQL
+   * - SparkSQL
+   * - MultiCluster
+   * - AI
    * 
    * @example
-   * N/A
+   * SQL
+   */
+  classification?: string;
+  /**
+   * @remarks
+   * A reserved parameter (not applicable).
+   * 
+   * @example
+   * -
    */
   clusterMode?: string;
   /**
    * @remarks
-   * A reserved parameter.
+   * A reserved parameter (not applicable).
    * 
    * @example
-   * N/A
+   * -
    */
   clusterSizeResource?: string;
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
+   * The ID of the Dedicated Edition, Basic Edition, or Data Lakehouse Edition cluster.
    * 
    * This parameter is required.
    * 
@@ -266,33 +467,44 @@ export class CreateDBResourceGroupRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Specifies whether to enable the spot instance feature for the resource group. After you enable the spot instance feature, you are charged for resources at a lower unit price but the resources are probably released. You can enable the spot instance feature only for job resource groups. Valid values:
-   * 
-   * *   **True**
-   * *   **False**
+   * Specifies whether to enable the spot instance feature for the resource group. After the spot instance feature is enabled, the unit price of resources is reduced, but the resources may be released. Only Job resource groups support this feature. Valid values:
+   * - **True**: enables the spot instance feature.
+   * - **False**: disables the spot instance feature.
    * 
    * @example
    * True
    */
   enableSpot?: boolean;
   /**
+   * @remarks
+   * The database engine. Valid values:
+   * 
+   * - **AnalyticDB** (default): the AnalyticDB for MySQL engine.
+   * - **SparkWarehouse**: the SparkWarehouse engine.
+   * 
    * @example
    * SparkWarehouse
    */
   engine?: string;
   /**
+   * @remarks
+   * The engine configuration.
+   * 
    * @example
    * {\\"spark.adb.version\\":\\"3.5\\"}
    */
   engineParams?: { [key: string]: any };
+  /**
+   * @remarks
+   * The GPU time-sharing elastic plan.
+   */
   gpuElasticPlan?: CreateDBResourceGroupRequestGpuElasticPlan;
   /**
    * @remarks
    * The name of the resource group.
-   * 
-   * *   The name can be up to 255 characters in length.
-   * *   The name must start with a letter or a digit.
-   * *   The name can contain letters, digits, hyphens (_), and underscores (_).
+   * - The name can be up to 255 characters in length.
+   * - The name must start with a digit, an uppercase letter, or a lowercase letter.
+   * - The name can contain digits, uppercase letters, lowercase letters, hyphens (-), and underscores (_).
    * 
    * This parameter is required.
    * 
@@ -303,11 +515,9 @@ export class CreateDBResourceGroupRequest extends $dara.Model {
   /**
    * @remarks
    * The type of the resource group. Valid values:
-   * 
-   * *   **Interactive**
-   * *   **Job**
-   * 
-   * >  For more information about resource groups, see [Resource group overview](https://help.aliyun.com/document_detail/428610.html).
+   * - **Interactive**
+   * - **Job**
+   * > For more information about Data Lakehouse Edition resource groups, see [Resource group overview (Data Lakehouse Edition)](https://help.aliyun.com/document_detail/428610.html).
    * 
    * This parameter is required.
    * 
@@ -317,18 +527,17 @@ export class CreateDBResourceGroupRequest extends $dara.Model {
   groupType?: string;
   /**
    * @remarks
-   * A reserved parameter.
+   * A reserved parameter (not applicable).
    * 
    * @example
-   * N/A
+   * -
    */
   maxClusterCount?: number;
   /**
    * @remarks
-   * The maximum reserved computing resources.
-   * 
-   * *   If GroupType is set to Interactive, the maximum amount of reserved computing resources refers to the amount of resources that are not allocated in the cluster. Set this parameter to a value in increments of 16ACU.
-   * *   If GroupType is set to Job, the maximum amount of reserved computing resources refers to the amount of resources that are not allocated in the cluster. Set this parameter to a value in increments of 8ACU.
+   * The maximum amount of reserved computing resources. Unit: ACUs.
+   * - If the resource group type is Interactive, the maximum reserved computing resources is the current unallocated resources of the cluster, in increments of 16 ACUs.
+   * - If the resource group type is Job, the maximum reserved computing resources is the current unallocated resources of the cluster, in increments of 8 ACUs.
    * 
    * @example
    * 48ACU
@@ -336,23 +545,25 @@ export class CreateDBResourceGroupRequest extends $dara.Model {
   maxComputeResource?: string;
   /**
    * @remarks
-   * A reserved parameter.
+   * The maximum number of GPUs.
+   * 
+   * @example
+   * 2
    */
   maxGpuQuantity?: number;
   /**
    * @remarks
-   * A reserved parameter.
+   * A reserved parameter (not applicable).
    * 
    * @example
-   * N/A
+   * -
    */
   minClusterCount?: number;
   /**
    * @remarks
-   * The minimum reserved computing resources.
-   * 
-   * *   When GroupType is set to Interactive, set this parameter to 16ACU.
-   * *   When GroupType is set to Job, set this parameter to 0ACU.
+   * The minimum amount of reserved computing resources. Unit: ACUs.
+   * - If the resource group type is Interactive, the minimum reserved computing resources is 16 ACUs.
+   * - If the resource group type is Job, the minimum reserved computing resources is 0 ACUs.
    * 
    * @example
    * 0ACU
@@ -360,15 +571,23 @@ export class CreateDBResourceGroupRequest extends $dara.Model {
   minComputeResource?: string;
   /**
    * @remarks
-   * A reserved parameter.
+   * The minimum number of GPUs.
+   * 
+   * @example
+   * 1
    */
   minGpuQuantity?: number;
+  /**
+   * @remarks
+   * The Ray configuration.
+   * > This parameter is required when the resource group is an AI resource group and the corresponding engine is RayCluster.
+   */
   rayConfig?: CreateDBResourceGroupRequestRayConfig;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID.
    * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/612393.html) operation to query the most recent region list.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/612393.html) operation to query the region IDs of AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters.
    * 
    * @example
    * cn-hangzhou
@@ -376,22 +595,41 @@ export class CreateDBResourceGroupRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The job resubmission rules.
+   * The job routing rules.
    */
   rules?: CreateDBResourceGroupRequestRules[];
   /**
    * @remarks
-   * A reserved parameter.
+   * The scaling policy of the resource group. Valid values:
+   * - AutoScaling: enables the AutoScaling automatic scaling policy.
+   * - Disable: disables automatic scaling.
+   * - MultiCluster: enables the MultiCluster automatic scaling policy.
+   * 
+   * @example
+   * AutoScaling
+   */
+  scalePolicy?: string;
+  /**
+   * @remarks
+   * The specification name.
+   * 
+   * @example
+   * ADB.MLLarge.2
    */
   specName?: string;
   /**
    * @remarks
-   * A reserved parameter.
+   * The name of the destination resource group.
+   * 
+   * @example
+   * test
    */
   targetResourceGroupName?: string;
   static names(): { [key: string]: string } {
     return {
+      atmConfig: 'AtmConfig',
       autoStopInterval: 'AutoStopInterval',
+      classification: 'Classification',
       clusterMode: 'ClusterMode',
       clusterSizeResource: 'ClusterSizeResource',
       DBClusterId: 'DBClusterId',
@@ -410,6 +648,7 @@ export class CreateDBResourceGroupRequest extends $dara.Model {
       rayConfig: 'RayConfig',
       regionId: 'RegionId',
       rules: 'Rules',
+      scalePolicy: 'ScalePolicy',
       specName: 'SpecName',
       targetResourceGroupName: 'TargetResourceGroupName',
     };
@@ -417,7 +656,9 @@ export class CreateDBResourceGroupRequest extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      atmConfig: CreateDBResourceGroupRequestAtmConfig,
       autoStopInterval: 'string',
+      classification: 'string',
       clusterMode: 'string',
       clusterSizeResource: 'string',
       DBClusterId: 'string',
@@ -436,12 +677,16 @@ export class CreateDBResourceGroupRequest extends $dara.Model {
       rayConfig: CreateDBResourceGroupRequestRayConfig,
       regionId: 'string',
       rules: { 'type': 'array', 'itemType': CreateDBResourceGroupRequestRules },
+      scalePolicy: 'string',
       specName: 'string',
       targetResourceGroupName: 'string',
     };
   }
 
   validate() {
+    if(this.atmConfig && typeof (this.atmConfig as any).validate === 'function') {
+      (this.atmConfig as any).validate();
+    }
     if(this.engineParams) {
       $dara.Model.validateMap(this.engineParams);
     }