@alicloud/adb20211201 4.7.0 → 5.0.0

package/src/models/CstoreIndexModel.ts

@@ -4,14 +4,68 @@ import { FieldSchemaModel } from "./FieldSchemaModel";
 
 
 export class CstoreIndexModel extends $dara.Model {
+  /**
+   * @remarks
+   * The order of index columns.
+   */
   columnOrds?: string[];
+  /**
+   * @remarks
+   * The time when the index was created.
+   * 
+   * @example
+   * 2023-01-05 13:17:55
+   */
   createTime?: string;
+  /**
+   * @remarks
+   * The logical name of the database.
+   * 
+   * @example
+   * exampleDatabase
+   */
   databaseName?: string;
+  /**
+   * @remarks
+   * The index columns.
+   */
   indexColumns?: FieldSchemaModel[];
+  /**
+   * @remarks
+   * The name of the index.
+   * 
+   * @example
+   * indexName
+   */
   indexName?: string;
+  /**
+   * @remarks
+   * The type of the index.
+   * 
+   * @example
+   * NORMAL
+   */
   indexType?: string;
+  /**
+   * @remarks
+   * The properties.
+   */
   options?: { [key: string]: string };
+  /**
+   * @remarks
+   * The physical name of the table.
+   * 
+   * @example
+   * physicalDatabase
+   */
   physicalTableName?: string;
+  /**
+   * @remarks
+   * The time when the index was updated.
+   * 
+   * @example
+   * 2023-01-05 13:17:55
+   */
   updateTime?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DatabaseSummaryModel.ts

@@ -3,14 +3,49 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DatabaseSummaryModel extends $dara.Model {
+  /**
+   * @remarks
+   * Creation time.
+   * 
+   * @example
+   * 2023-01-05 13:17:55
+   */
   createTime?: string;
   createdBySource?: string;
   createdByUser?: string;
   dbType?: string;
+  /**
+   * @remarks
+   * Description.
+   * 
+   * @example
+   * description
+   */
   description?: string;
   location?: string;
+  /**
+   * @remarks
+   * Owner.
+   * 
+   * @example
+   * abc
+   */
   owner?: string;
+  /**
+   * @remarks
+   * logical database name.
+   * 
+   * @example
+   * testSchema
+   */
   schemaName?: string;
+  /**
+   * @remarks
+   * Update time.
+   * 
+   * @example
+   * 2023-01-05 13:17:55
+   */
   updateTime?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DeleteApsWebhookResponseBody.ts

@@ -38,6 +38,9 @@ export class DeleteApsWebhookResponseBody extends $dara.Model {
   /**
    * @remarks
    * The returned message.
+   * 
+   * @example
+   * Operation succeeded
    */
   message?: string;
   /**

package/src/models/DeleteFormationCrawlerRequest.ts

@@ -0,0 +1,72 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteFormationCrawlerRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The task ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 247
+   */
+  crawlerTaskId?: number;
+  /**
+   * @remarks
+   * The task name.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * wz_log
+   */
+  crawlerTaskName?: string;
+  /**
+   * @remarks
+   * The instance ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * amv-8vbc***
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query available region IDs.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      crawlerTaskId: 'CrawlerTaskId',
+      crawlerTaskName: 'CrawlerTaskName',
+      DBClusterId: 'DBClusterId',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      crawlerTaskId: 'number',
+      crawlerTaskName: 'string',
+      DBClusterId: 'string',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteFormationCrawlerResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DeleteFormationCrawlerResponseBody } from "./DeleteFormationCrawlerResponseBody";
+
+
+export class DeleteFormationCrawlerResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DeleteFormationCrawlerResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DeleteFormationCrawlerResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteFormationCrawlerResponseBody.ts

@@ -0,0 +1,86 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteFormationCrawlerResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The status code.
+   * 
+   * @example
+   * InvalidInput
+   */
+  code?: string;
+  /**
+   * @remarks
+   * Indicates whether the task is deleted. Valid values:
+   * - true: The task is deleted.
+   * - false: The task failed to be deleted.
+   * 
+   * @example
+   * True
+   */
+  data?: boolean;
+  /**
+   * @remarks
+   * The HTTP status code.
+   * 
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @remarks
+   * The error message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * E8DA77FA-FF0F-5516-A551-86C6E2D4BE92
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
+   * @example
+   * True
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      httpStatusCode: 'HttpStatusCode',
+      message: 'Message',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: 'boolean',
+      httpStatusCode: 'number',
+      message: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeletePerformanceViewRequest.ts

@@ -5,9 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DeletePerformanceViewRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
+   * <props="china">The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.
+   * <props="intl">The ID of the Data Lakehouse Edition cluster.
    * 
-   * >  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 clusters within a region.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/612397.html) operation to query the cluster ID.
    * 
    * This parameter is required.
    * 
@@ -20,8 +21,7 @@ export class DeletePerformanceViewRequest extends $dara.Model {
   /**
    * @remarks
    * The region ID.
-   * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the most recent region list.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the supported regions and zones, including region IDs.
    * 
    * This parameter is required.
    * 
@@ -33,12 +33,12 @@ export class DeletePerformanceViewRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The name of the view.
+   * The name of the monitoring view.
    * 
    * This parameter is required.
    * 
    * @example
-   * view_dwd_plan_double_term
+   * Custom-All metrics-2 columns-Linked
    */
   viewName?: string;
   static names(): { [key: string]: string } {

package/src/models/DeletePerformanceViewResponseBody.ts

@@ -6,8 +6,7 @@ export class DeletePerformanceViewResponseBody extends $dara.Model {
   /**
    * @remarks
    * The details about the access denial.
-   * 
-   * >  This parameter is returned only if Resource Access Management (RAM) permission verification failed.
+   * > This field is returned only when RAM authentication fails.
    * 
    * @example
    * {
@@ -23,7 +22,10 @@ export class DeletePerformanceViewResponseBody extends $dara.Model {
   accessDeniedDetail?: string;
   /**
    * @remarks
-   * The delete status.
+   * The deletion result. Valid values:
+   * 
+   * - **SUCCESS**: Succeeded.
+   * - **FAILED**: Failed.
    * 
    * @example
    * SUCCESS

package/src/models/DeleteSemanticViewRequest.ts

@@ -0,0 +1,60 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteSemanticViewRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the ADB cluster.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-bp11q28kvl688****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The name of the schema.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * adb_demo
+   */
+  schemaName?: string;
+  /**
+   * @remarks
+   * The name of the semantic view.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * adb_sv_name
+   */
+  viewName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      schemaName: 'SchemaName',
+      viewName: 'ViewName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      schemaName: 'string',
+      viewName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteSemanticViewResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DeleteSemanticViewResponseBody } from "./DeleteSemanticViewResponseBody";
+
+
+export class DeleteSemanticViewResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DeleteSemanticViewResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DeleteSemanticViewResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteSemanticViewResponseBody.ts

@@ -0,0 +1,34 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteSemanticViewResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the request.
+   * 
+   * @example
+   * 3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeAbnormalPatternDetectionResponseBody.ts

@@ -16,7 +16,7 @@ export class DescribeAbnormalPatternDetectionResponseBodyDetectionItemsResults e
    * The description of the detection result.
    * 
    * @example
-   * Two SQL patterns that have abnormal totalTime metric values are detected. This may result in increased CPU utilization, query slowdown, and degraded system stability. Go to the monitoring page to diagnose the issue and then perform optimization.
+   * Two SQL patterns that have abnormal totalTime metric values are detected. This may cause high CPU usage or slow queries, which affects system stability. Go to the monitoring page and use one-click diagnostics to view details and optimize the queries.
    */
   detail?: string;
   /**
@@ -50,7 +50,7 @@ export class DescribeAbnormalPatternDetectionResponseBodyDetectionItemsResults e
    * @example
    * Maximum query duration: 1.43s
    * Maximum peak memory: 20.73 MB
-   * Maximum read table data: 10.12 MB
+   * Maximum table read data volume: 10.12 MB
    */
   relatedMetrics?: string;
   /**

package/src/models/DescribeAccountAllPrivilegesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAccountAllPrivilegesRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the database account.
+   * The database account name for the cluster.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,8 @@ export class DescribeAccountAllPrivilegesRequest extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
+   * <props="china">The cluster ID for the Enterprise Edition, Basic Edition, or Data Lakehouse Edition.
+   * <props="intl">The cluster ID for the Data Lakehouse Edition.
    * 
    * This parameter is required.
    * 
@@ -25,7 +26,7 @@ export class DescribeAccountAllPrivilegesRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Specifies the start position marker from which to return results. If you receive a response indicating that the results are truncated, set this parameter to the value of the `Marker` parameter in the response that you received.
+   * If the response is truncated, use the `Marker` value from the response in this field to retrieve the next set of results.
    * 
    * @example
    * EXAMPLE
@@ -33,7 +34,7 @@ export class DescribeAccountAllPrivilegesRequest extends $dara.Model {
   marker?: string;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeAccountAllPrivilegesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject extends $dara.Model {
   /**
    * @remarks
-   * The name of the column.
+   * The column name.
    * 
    * @example
    * id
@@ -13,7 +13,7 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject e
   column?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * @example
    * tdb1
@@ -21,7 +21,7 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject e
   database?: string;
   /**
    * @remarks
-   * The description of the permission object.
+   * Description of the permission object.
    * 
    * @example
    * id of table
@@ -29,7 +29,7 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject e
   description?: string;
   /**
    * @remarks
-   * The name of the table.
+   * The table name.
    * 
    * @example
    * table1
@@ -65,12 +65,12 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject e
 export class DescribeAccountAllPrivilegesResponseBodyDataResult extends $dara.Model {
   /**
    * @remarks
-   * The objects on which the permission takes effect, including databases, tables, and columns. If Global is returned for the PrivilegeType parameter, an empty string is returned for this parameter.
+   * The permission object, represented as a trituple of database, table, and column. All fields are empty for Global-level permissions.
    */
   privilegeObject?: DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject;
   /**
    * @remarks
-   * The permission level of the database account. You can call the `DescribeEnabledPrivileges` operation to query the permission level of the database account.
+   * The permission level, returned by the `DescribeEnabledPrivileges` operation.
    * 
    * @example
    * Global
@@ -78,7 +78,7 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResult extends $dara.Mo
   privilegeType?: string;
   /**
    * @remarks
-   * The name of the permission, which is the same as the permission name returned by the `DescribeEnabledPrivileges` operation.
+   * List of permissions.
    */
   privileges?: string[];
   static names(): { [key: string]: string } {
@@ -115,7 +115,7 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResult extends $dara.Mo
 export class DescribeAccountAllPrivilegesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * Indicates the position where the results are truncated. When a value of `true` is returned for the `Truncated` parameter, this parameter is present and contains the value to use for the Marker parameter in a subsequent call.
+   * If the `Truncated` field in the response is `true`, pass this value in subsequent calls to retrieve the next set of results.
    * 
    * @example
    * 0573e74fd1ccb01739993a691e876074db6e1b6ad79f54115f0e98528432ba6a523cfec5780ade5189299cc3396f6ff7
@@ -123,12 +123,12 @@ export class DescribeAccountAllPrivilegesResponseBodyData extends $dara.Model {
   marker?: string;
   /**
    * @remarks
-   * The permissions.
+   * List of permissions.
    */
   result?: DescribeAccountAllPrivilegesResponseBodyDataResult[];
   /**
    * @remarks
-   * Indicates whether the results are truncated. If the results are truncated, a value of `true` is returned. In this case, you must call this operation again to obtain all the results until a value of `false` is returned for this parameter.
+   * If the response is truncated, this field is `true`. Continue calling this operation until this field becomes `false`.
    * 
    * @example
    * true
@@ -165,12 +165,12 @@ export class DescribeAccountAllPrivilegesResponseBodyData extends $dara.Model {
 export class DescribeAccountAllPrivilegesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Details of the permissions.
+   * Permission details.
    */
   data?: DescribeAccountAllPrivilegesResponseBodyData;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 3BB185E9-BB54-1727-B876-13243E4C0EB5