@alicloud/adb20211201 4.7.0 → 5.0.0

package/src/models/CreateDbresourceGroupShrinkRequest.ts

@@ -3,30 +3,46 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateDBResourceGroupShrinkRequest extends $dara.Model {
+  atmConfigShrink?: string;
   /**
+   * @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
+   * SQL
+   */
+  classification?: string;
+  /**
+   * @remarks
+   * A reserved parameter (not applicable).
    * 
    * @example
-   * N/A
+   * -
    */
   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.
    * 
@@ -36,33 +52,44 @@ export class CreateDBResourceGroupShrinkRequest 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\\"}
    */
   engineParamsShrink?: string;
+  /**
+   * @remarks
+   * The GPU time-sharing elastic plan.
+   */
   gpuElasticPlanShrink?: string;
   /**
    * @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.
    * 
@@ -73,11 +100,9 @@ export class CreateDBResourceGroupShrinkRequest 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.
    * 
@@ -87,18 +112,17 @@ export class CreateDBResourceGroupShrinkRequest 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
@@ -106,23 +130,25 @@ export class CreateDBResourceGroupShrinkRequest 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
@@ -130,15 +156,23 @@ export class CreateDBResourceGroupShrinkRequest 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.
+   */
   rayConfigShrink?: string;
   /**
    * @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
@@ -146,22 +180,41 @@ export class CreateDBResourceGroupShrinkRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The job resubmission rules.
+   * The job routing rules.
    */
   rulesShrink?: string;
   /**
    * @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 {
+      atmConfigShrink: 'AtmConfig',
       autoStopInterval: 'AutoStopInterval',
+      classification: 'Classification',
       clusterMode: 'ClusterMode',
       clusterSizeResource: 'ClusterSizeResource',
       DBClusterId: 'DBClusterId',
@@ -180,6 +233,7 @@ export class CreateDBResourceGroupShrinkRequest extends $dara.Model {
       rayConfigShrink: 'RayConfig',
       regionId: 'RegionId',
       rulesShrink: 'Rules',
+      scalePolicy: 'ScalePolicy',
       specName: 'SpecName',
       targetResourceGroupName: 'TargetResourceGroupName',
     };
@@ -187,7 +241,9 @@ export class CreateDBResourceGroupShrinkRequest extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      atmConfigShrink: 'string',
       autoStopInterval: 'string',
+      classification: 'string',
       clusterMode: 'string',
       clusterSizeResource: 'string',
       DBClusterId: 'string',
@@ -206,6 +262,7 @@ export class CreateDBResourceGroupShrinkRequest extends $dara.Model {
       rayConfigShrink: 'string',
       regionId: 'string',
       rulesShrink: 'string',
+      scalePolicy: 'string',
       specName: 'string',
       targetResourceGroupName: 'string',
     };

package/src/models/CreateFormationCrawlerRequest.ts

@@ -0,0 +1,81 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateFormationCrawlerRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The JSON string that contains the complete crawler configuration. This is the most important parameter. For the internal JSON structure, see the CrawlerInfo structure definition section.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * {
+   *   "sourceType": "OSSWAREHOUSE",
+   *   "dbName": "your_target_db",
+   *   "sourceInfo": {
+   *     "ossSourceInfo": {
+   *       "sourceMode": "WAREHOUSE",
+   *       "ossLocations": ["oss://your-bucket/your-path/"],
+   *       "exclusions": [],
+   *       "inclusions": []
+   *     }
+   *   },
+   *   "classifiers": ["csv"],
+   *   "schemaChangePolicy": {
+   *     "updateRule": "ONLY_ADD_COLUMN",
+   *     "deleteRule": "IGNORE"
+   *   },
+   *   "frequency": {
+   *     "type": "monthly",
+   *     "cron": "0+00+00+1+*+?+*"
+   *   },
+   *   "configuration": "adb.crawler.csv.columns.specify.delimiter.char=auto\\nadb.crawler.csv.columns.specify.quote.char=auto\\n"
+   * }
+   */
+  crawlerInfo?: string;
+  /**
+   * @remarks
+   * The ADB instance ID. This specifies the resource-level scope of the operation.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-bp*****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The region ID of the instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      crawlerInfo: 'CrawlerInfo',
+      DBClusterId: 'DBClusterId',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      crawlerInfo: 'string',
+      DBClusterId: 'string',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/{GetApsManagedDatabasesResponse.ts → CreateFormationCrawlerResponse.ts}

@@ -1,12 +1,12 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { GetApsManagedDatabasesResponseBody } from "./GetApsManagedDatabasesResponseBody";
+import { CreateFormationCrawlerResponseBody } from "./CreateFormationCrawlerResponseBody";
 
 
-export class GetApsManagedDatabasesResponse extends $dara.Model {
+export class CreateFormationCrawlerResponse extends $dara.Model {
   headers?: { [key: string]: string };
   statusCode?: number;
-  body?: GetApsManagedDatabasesResponseBody;
+  body?: CreateFormationCrawlerResponseBody;
   static names(): { [key: string]: string } {
     return {
       headers: 'headers',
@@ -19,7 +19,7 @@ export class GetApsManagedDatabasesResponse extends $dara.Model {
     return {
       headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
       statusCode: 'number',
-      body: GetApsManagedDatabasesResponseBody,
+      body: CreateFormationCrawlerResponseBody,
     };
   }
 

package/src/models/CreateFormationCrawlerResponseBody.ts

@@ -0,0 +1,96 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateFormationCrawlerResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The status code.
+   * 
+   * @example
+   * 200
+   */
+  code?: string;
+  /**
+   * @remarks
+   * Indicates whether the request is processed.
+   * 
+   * @example
+   * True
+   */
+  data?: boolean;
+  /**
+   * @remarks
+   * The HTTP status code. A value of 200 indicates success.
+   * 
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message. A value of OK indicates success.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 019F3BE7-E8FA-3DC5-8EE7-501A90B5A54D
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the call is successful. Valid values:
+   * - **true**: The call is successful.
+   * - **false**: The call failed.
+   * 
+   * @example
+   * True
+   */
+  success?: boolean;
+  /**
+   * @remarks
+   * The operation result. A value of true indicates that the task is created.
+   * 
+   * @example
+   * 241
+   */
+  taskId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      httpStatusCode: 'HttpStatusCode',
+      message: 'Message',
+      requestId: 'RequestId',
+      success: 'Success',
+      taskId: 'TaskId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: 'boolean',
+      httpStatusCode: 'number',
+      message: 'string',
+      requestId: 'string',
+      success: 'boolean',
+      taskId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateLakeStorageRequest.ts

@@ -13,7 +13,7 @@ export class CreateLakeStorageRequestPermissions extends $dara.Model {
   account?: string;
   /**
    * @remarks
-   * The read permissions.
+   * The read permission.
    * 
    * @example
    * -
@@ -29,7 +29,7 @@ export class CreateLakeStorageRequestPermissions extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The write permissions.
+   * The write permission.
    * 
    * @example
    * -
@@ -65,8 +65,7 @@ export class CreateLakeStorageRequestPermissions extends $dara.Model {
 export class CreateLakeStorageRequest extends $dara.Model {
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request.
-   * You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * -
    * 
    * @example
    * ******
@@ -74,7 +73,7 @@ export class CreateLakeStorageRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL cluster with which you want to associate the lake storage.
+   * The instance ID of the ADB instance attached to the lake storage.
    * 
    * @example
    * amv-******
@@ -90,7 +89,7 @@ export class CreateLakeStorageRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The permissions that you want to grant on the lake storage to the Alibaba Cloud account besides the permissions that are automatically granted to the Resource Access Management (RAM) user or the Alibaba Cloud account.
+   * When lake storage is created, permissions are automatically granted to the Resource Access Management (RAM) users performing the operation and the Alibaba Cloud account. You can increase additional Alibaba Cloud account authorizations here.
    * 
    * @example
    * -
@@ -98,7 +97,7 @@ export class CreateLakeStorageRequest extends $dara.Model {
   permissions?: CreateLakeStorageRequestPermissions[];
   /**
    * @remarks
-   * The region ID.
+   * RegionId
    * 
    * @example
    * cn-hangzhou

package/src/models/CreateLakeStorageResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateLakeStorageResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code or the error code.
+   * The API status or POP error code.
    * 
    * @example
    * InvalidInput
@@ -13,7 +13,7 @@ export class CreateLakeStorageResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The usage details of cluster resources.
+   * The resource usage details of the cluster.
    * 
    * @example
    * true
@@ -21,7 +21,7 @@ export class CreateLakeStorageResponseBody extends $dara.Model {
   data?: string;
   /**
    * @remarks
-   * The HTTP status code. The status code 200 indicates that the request was successful.
+   * The HTTP status code returned. A value of 200 indicates that the request was successful.
    * 
    * @example
    * 200
@@ -29,7 +29,7 @@ export class CreateLakeStorageResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The returned message. If the operation is asynchronously implemented, the job ID is returned.
+   * If the creation operation is implemented asynchronously, a specific JobId is returned.
    * 
    * @example
    * OK
@@ -37,7 +37,7 @@ export class CreateLakeStorageResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID
+   * Id of the request
    * 
    * @example
    * ******
@@ -45,10 +45,9 @@ export class CreateLakeStorageResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * *   **true**
-   * *   **false**
+   * Indicates whether the call was successful. Valid values:
+   * - **true**: Successful.
+   * - **false**: Failed.
    * 
    * @example
    * true

package/src/models/CreateLakeStorageShrinkRequest.ts

@@ -5,8 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateLakeStorageShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request.
-   * You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * -
    * 
    * @example
    * ******
@@ -14,7 +13,7 @@ export class CreateLakeStorageShrinkRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL cluster with which you want to associate the lake storage.
+   * The instance ID of the ADB instance attached to the lake storage.
    * 
    * @example
    * amv-******
@@ -30,7 +29,7 @@ export class CreateLakeStorageShrinkRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The permissions that you want to grant on the lake storage to the Alibaba Cloud account besides the permissions that are automatically granted to the Resource Access Management (RAM) user or the Alibaba Cloud account.
+   * When lake storage is created, permissions are automatically granted to the Resource Access Management (RAM) users performing the operation and the Alibaba Cloud account. You can increase additional Alibaba Cloud account authorizations here.
    * 
    * @example
    * -
@@ -38,7 +37,7 @@ export class CreateLakeStorageShrinkRequest extends $dara.Model {
   permissionsShrink?: string;
   /**
    * @remarks
-   * The region ID.
+   * RegionId
    * 
    * @example
    * cn-hangzhou