@alicloud/adb20211201 4.1.0 → 4.1.2

package/src/models/DescribeAdbMySqlIndexesRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAdbMySqlIndexesRequest extends $dara.Model {
   /**
    * @remarks
+   * The cluster ID.
+   * 
+   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a region.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,10 @@ export class DescribeAdbMySqlIndexesRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
+   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/612393.html) operation to query the most recent region list.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,11 +28,19 @@ export class DescribeAdbMySqlIndexesRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The name of the database.
+   * 
    * @example
    * tpch_oss
    */
   schema?: string;
   /**
+   * @remarks
+   * The name of the table.
+   * 
+   * >  If you leave this parameter empty, the information about all the current tables in the cluster is returned.
+   * 
    * @example
    * orders
    */

package/src/models/DescribeAdbMySqlIndexesResponseBody.ts

@@ -5,32 +5,64 @@ import { DescribeAdbMySqlIndexesResponseBodyIndexes } from "./DescribeAdbMySqlIn
 
 export class DescribeAdbMySqlIndexesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The number of indexes.````
+   * 
    * @example
    * 10
    */
   indexCount?: number;
+  /**
+   * @remarks
+   * The queried indexes.
+   */
   indexes?: DescribeAdbMySqlIndexesResponseBodyIndexes[];
   /**
+   * @remarks
+   * The returned message. Valid values:
+   * 
+   * *   If the request was successful, a success message is returned.****
+   * *   If the request failed, an error message is returned.
+   * 
    * @example
    * Success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F0983B43-B2EC-536A-8791-142B5CF1E9B6
    */
   requestId?: string;
   /**
+   * @remarks
+   * The name of the database.
+   * 
+   * **
+   * 
+   * ****\\
+   * 
    * @example
    * adb_demo
    */
   schema?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * *   **true**
+   * *   **false**
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * The name of the table.
+   * 
    * @example
    * test
    */

package/src/models/DescribeAdbMySqlIndexesResponseBodyIndexes.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAdbMySqlIndexesResponseBodyIndexes extends $dara.Model {
   /**
+   * @remarks
+   * The name of the column.
+   * 
    * @example
    * preclcu
    */
   column?: string;
   /**
+   * @remarks
+   * The name of the index.
+   * 
    * @example
    * ttl
    */
   name?: string;
   /**
+   * @remarks
+   * The index type.
+   * 
    * @example
    * normal
    */

package/src/models/DescribeAdbMySqlTableMetaRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAdbMySqlTableMetaRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
+   * 
+   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,10 @@ export class DescribeAdbMySqlTableMetaRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
+   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query the most recent region list.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +29,8 @@ export class DescribeAdbMySqlTableMetaRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +39,10 @@ export class DescribeAdbMySqlTableMetaRequest extends $dara.Model {
   schema?: string;
   /**
    * @remarks
+   * The name of the table.
+   * 
+   * >  If you leave this parameter empty, the information about all the current tables in the cluster is returned.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeAdbMySqlTableMetaResponseBody.ts

@@ -5,20 +5,39 @@ import { DescribeAdbMySqlTableMetaResponseBodyTableMeta } from "./DescribeAdbMyS
 
 export class DescribeAdbMySqlTableMetaResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The returned message. Valid values:
+   * 
+   * *   If the request was successful, a success message is returned.****
+   * *   If the request failed, an error message is returned.
+   * 
    * @example
    * Success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 2FED790E-FB61-4721-8C1C-07C627FA5A19
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * *   **true**
+   * *   **false**
+   * 
    * @example
    * true
    */
   success?: boolean;
+  /**
+   * @remarks
+   * The queried table metadata.
+   */
   tableMeta?: DescribeAdbMySqlTableMetaResponseBodyTableMeta;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeAdbMySqlTableMetaResponseBodyTableMeta.ts

@@ -4,76 +4,128 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAdbMySqlTableMetaResponseBodyTableMeta extends $dara.Model {
   /**
+   * @remarks
+   * The time when the table was created.
+   * 
    * @example
    * 2025-03-14 02:18:08.0
    */
   createTime?: string;
   /**
+   * @remarks
+   * The distribution key column.
+   * 
    * @example
    * customer_id
    */
   distributeColumn?: string;
   /**
+   * @remarks
+   * The distribution type.
+   * 
    * @example
    * hash
    */
   distributeType?: string;
   /**
+   * @remarks
+   * Indicates whether full-column indexes are used.
+   * 
    * @example
    * false
    */
   isAllIndex?: boolean;
   /**
+   * @remarks
+   * Indicates whether dictionary encoding is used.
+   * 
    * @example
    * true
    */
   isDictEncode?: boolean;
   /**
+   * @remarks
+   * Indicates whether full-text indexes are used.
+   * 
    * @example
    * true
    */
   isFullTextDict?: boolean;
   /**
+   * @remarks
+   * Indicates whether pages are hidden.
+   * 
+   * *   **false**
+   * *   **true**
+   * 
    * @example
    * true
    */
   isHidden?: boolean;
   /**
+   * @remarks
+   * The partition key column.
+   * 
    * @example
    * DATE_FORMAT(login_time, \\"%Y%m%d\\")
    */
   partitionColumn?: string;
   /**
+   * @remarks
+   * The type of the partition.
+   * 
    * @example
    * value
    */
   partitionType?: string;
   /**
+   * @remarks
+   * The primary key column.
+   * 
    * @example
    * login_time,customer_id,phone_num
    */
   primaryKeyColumn?: string;
   /**
+   * @remarks
+   * The table engine.
+   * 
    * @example
    * XUANWU
    */
   tableEngine?: string;
   /**
+   * @remarks
+   * The name of the table.
+   * 
+   * **
+   * 
+   * ****
+   * 
    * @example
    * external_supplier
    */
   tableName?: string;
   /**
+   * @remarks
+   * The database to which the table belongs.
+   * 
    * @example
    * tpch
    */
   tableSchema?: string;
   /**
+   * @remarks
+   * The type of the table.
+   * 
    * @example
    * fact_table
    */
   tableType?: string;
   /**
+   * @remarks
+   * The time when the table was updated.
+   * 
    * @example
    * 2024-07-25 02:07:23.0
    */

package/src/models/DescribeClusterAccessWhiteListResponseBodyItemsIparray.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeClusterAccessWhiteListResponseBodyItemsIPArray extends $dara.Model {
   /**
    * @remarks
-   * The attribute of the whitelist.
+   * The attribute of the IP address whitelist.
    * 
-   * > Whitelists with the **hidden** attribute are not displayed in the console. Those whitelists are used to access Data Transmission Service (DTS) and PolarDB.
+   * >  The IP address whitelists that have the **hidden** attribute are not displayed in the console. These IP address whitelists are used to access services such as Data Transmission Service (DTS) and PolarDB.
    * 
    * @example
    * hidden

package/src/models/DescribeDbclusterAttributeResponseBodyItemsDbcluster.ts

@@ -5,6 +5,8 @@ import { DescribeDBClusterAttributeResponseBodyItemsDBClusterTaskInfo } from "./
 
 
 export class DescribeDBClusterAttributeResponseBodyItemsDBCluster extends $dara.Model {
+  AINodeNumber?: number;
+  AINodeSpec?: string;
   /**
    * @remarks
    * The cache size of the ClickHouse wide table engine. Unit: GB. If a value of -1 is returned, the ClickHouse wide table engine is disabled. If a value other than -1 is returned, this parameter indicates the disk cache size.
@@ -392,6 +394,8 @@ export class DescribeDBClusterAttributeResponseBodyItemsDBCluster extends $dara.
   zoneId?: string;
   static names(): { [key: string]: string } {
     return {
+      AINodeNumber: 'AINodeNumber',
+      AINodeSpec: 'AINodeSpec',
       clickhouseEngineCacheSize: 'ClickhouseEngineCacheSize',
       clickhouseEngineEnabled: 'ClickhouseEngineEnabled',
       commodityCode: 'CommodityCode',
@@ -443,6 +447,8 @@ export class DescribeDBClusterAttributeResponseBodyItemsDBCluster extends $dara.
 
   static types(): { [key: string]: any } {
     return {
+      AINodeNumber: 'number',
+      AINodeSpec: 'string',
       clickhouseEngineCacheSize: 'number',
       clickhouseEngineEnabled: 'boolean',
       commodityCode: 'string',

package/src/models/DescribeDbclustersRequest.ts

@@ -27,22 +27,13 @@ export class DescribeDBClustersRequest extends $dara.Model {
   DBClusterIds?: string;
   /**
    * @remarks
-   * The state of the cluster. Valid values:
+   * The status of the cluster. Valid values:
    * 
    * *   **Preparing**
-   * 
-   * <!---->
-   * 
    * *   **Creating**
    * *   **Running**
    * *   **Deleting**
-   * 
-   * <!---->
-   * 
    * *   **Restoring**
-   * 
-   * <!---->
-   * 
    * *   **ClassChanging**
    * *   **NetAddressCreating**
    * *   **NetAddressDeleting**
@@ -54,11 +45,11 @@ export class DescribeDBClustersRequest extends $dara.Model {
   DBClusterStatus?: string;
   /**
    * @remarks
-   * The database engine version of the cluster. Valid values:
+   * The version number corresponding to the edition of the cluster. Valid values:
    * 
-   * *   3.0: Data Warehouse Edition.
-   * *   5.0 (default): Data Lakehouse Edition, Enterprise Edition, and Basic Edition.
-   * *   All: Data Warehouse Edition, Data Lakehouse Edition, Enterprise Edition, and Basic Edition.
+   * *   **3.0**: Data Warehouse Edition.
+   * *   **5.0** (default): includes Data Lakehouse Edition, Enterprise Edition, and Basic Edition.
+   * *   **All**: all editions, including Data Warehouse Edition, Data Lakehouse Edition, Enterprise Edition, and Basic Edition.
    * 
    * @example
    * 5.0
@@ -88,10 +79,10 @@ export class DescribeDBClustersRequest extends $dara.Model {
    * @remarks
    * The edition of the cluster. Valid values:
    * 
-   * *   EnterpriseVersion: Enterprise Edition.
-   * *   BasicVersion: Basic Edition.
+   * *   **EnterpriseVersion**: Enterprise Edition.
+   * *   **BasicVersion**: Basic Edition.
    * 
-   * If you leave this parameter empty, the information about clusters of all editions is returned.
+   * >  If you leave this parameter empty, the information about clusters of all editions is returned.
    * 
    * @example
    * BasicVersion

package/src/models/DescribeDbclustersResponseBodyItemsDbcluster.ts

@@ -72,7 +72,7 @@ export class DescribeDBClustersResponseBodyItemsDBCluster extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The network type of the cluster. **VPC** is returned.
+   * The network type of the cluster. Only **VPC** is supported.
    * 
    * @example
    * VPC
@@ -83,19 +83,10 @@ export class DescribeDBClustersResponseBodyItemsDBCluster extends $dara.Model {
    * The status of the cluster. Valid values:
    * 
    * *   **Preparing**
-   * 
-   * <!---->
-   * 
    * *   **Creating**
    * *   **Running**
    * *   **Deleting**
-   * 
-   * <!---->
-   * 
    * *   **Restoring**
-   * 
-   * <!---->
-   * 
    * *   **ClassChanging**
    * *   **NetAddressCreating**
    * *   **NetAddressDeleting**
@@ -139,7 +130,7 @@ export class DescribeDBClustersResponseBodyItemsDBCluster extends $dara.Model {
   DBNodeStorage?: number;
   /**
    * @remarks
-   * The engine version of the AnalyticDB for MySQL Data Lakehouse Edition cluster. **5.0** is returned.
+   * The version number corresponding to the edition of the cluster. Only **5.0** is supported.
    * 
    * @example
    * 5.0
@@ -297,8 +288,8 @@ export class DescribeDBClustersResponseBodyItemsDBCluster extends $dara.Model {
    * @remarks
    * The service type of the cluster. Valid values:
    * 
-   * *   LegacyForm
-   * *   IntegrationForm
+   * *   **LegacyForm**
+   * *   **IntegrationForm**
    * 
    * @example
    * IntegrationForm
@@ -378,12 +369,12 @@ export class DescribeDBClustersResponseBodyItemsDBCluster extends $dara.Model {
   tags?: DescribeDBClustersResponseBodyItemsDBClusterTags;
   /**
    * @remarks
-   * The job progress.
+   * The information about the job.
    */
   taskInfo?: DescribeDBClustersResponseBodyItemsDBClusterTaskInfo;
   /**
    * @remarks
-   * The ID of the cluster that resides in the VPC.
+   * The VPC endpoint.
    * 
    * @example
    * am-bp163885f8q21****-controller

package/src/models/DescribeDiagnosisRecordsRequest.ts

@@ -15,9 +15,9 @@ export class DescribeDiagnosisRecordsRequest extends $dara.Model {
   clientIp?: string;
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
+   * The Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster ID.
    * 
-   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/612397.html) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.
+   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/612397.html) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeDiagnosisRecordsResponseBodyQuerys.ts

@@ -62,6 +62,10 @@ export class DescribeDiagnosisRecordsResponseBodyQuerys extends $dara.Model {
    * 1
    */
   outputRows?: number;
+  /**
+   * @example
+   * -5575924945138******
+   */
   patternId?: string;
   /**
    * @remarks
@@ -79,6 +83,12 @@ export class DescribeDiagnosisRecordsResponseBodyQuerys extends $dara.Model {
    * 2021093000414401000000023503151******
    */
   processId?: string;
+  /**
+   * @remarks
+   * The query properties.
+   * 
+   * >  For information about common properties, see [Config and hint configuration parameters](https://help.aliyun.com/document_detail/408955.html).
+   */
   queryProperties?: DescribeDiagnosisRecordsResponseBodyQuerysQueryProperties[];
   /**
    * @remarks

package/src/models/DescribeDiagnosisRecordsResponseBodyQuerysQueryProperties.ts

@@ -3,7 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeDiagnosisRecordsResponseBodyQuerysQueryProperties extends $dara.Model {
+  /**
+   * @example
+   * max_select_items_count
+   */
   name?: string;
+  /**
+   * @example
+   * 1024
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeLlmsimilarQuestionsRequest.ts

@@ -4,6 +4,11 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeLLMSimilarQuestionsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The cluster ID.
+   * 
+   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.
+   * 
    * @example
    * am-bp1565u55p32****
    */
@@ -12,10 +17,17 @@ export class DescribeLLMSimilarQuestionsRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
+   * The question proposed by a user.
+   * 
    * This parameter is required.
    */
   query?: string;
   /**
+   * @remarks
+   * The region ID
+   * 
+   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/612393.html) operation to query the most recent region list.
+   * 
    * @example
    * cn-hangzhou
    */

package/src/models/DescribeLlmsimilarQuestionsResponseBody.ts

@@ -4,13 +4,23 @@ import { DescribeLLMSimilarQuestionsResponseBodyItems } from "./DescribeLlmsimil
 
 
 export class DescribeLLMSimilarQuestionsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The queried similar questions.
+   */
   items?: DescribeLLMSimilarQuestionsResponseBodyItems[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 96A55627-28E9-5E47-B8F6-D786BE551349
    */
   requestId?: string;
   /**
+   * @remarks
+   * The session ID.
+   * 
    * @example
    * 4847
    */

package/src/models/DescribeLlmsimilarQuestionsResponseBodyItems.ts

@@ -3,21 +3,46 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeLLMSimilarQuestionsResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * The answer to the similar question.
+   */
   answer?: string;
   /**
+   * @remarks
+   * The ID of the similar question.
+   * 
    * @example
    * 2389899
    */
   id?: string;
   /**
+   * @remarks
+   * The similarity of the similar question.
+   * 
    * @example
    * 0.58
    */
   score?: number;
+  /**
+   * @remarks
+   * The source of the similar question.
+   */
   source?: string;
+  /**
+   * @remarks
+   * The summary of the similar question.
+   */
   summary?: string;
+  /**
+   * @remarks
+   * The content of the similar question.
+   */
   title?: string;
   /**
+   * @remarks
+   * The URL of the answer to the similar question.
+   * 
    * @example
    * www.aliyun.com/product
    */

package/src/models/DescribeResourceGroupSpecRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeResourceGroupSpecRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
+   * The Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster ID.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeSparkAppDiagnosisInfoRequest.ts

@@ -29,7 +29,10 @@ export class DescribeSparkAppDiagnosisInfoRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The execution language of the Spark application.
+   * The language in which you want to display the results. Valid values:
+   * 
+   * *   en: English.
+   * *   zh (default): Chinese.
    * 
    * This parameter is required.
    *