@alicloud/dms20250414 4.0.0 → 4.2.0

package/src/models/AgentServiceOrderVo.ts

@@ -3,70 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AgentServiceOrderVO extends $dara.Model {
-  /**
-   * @remarks
-   * The agent service.
-   */
   agentService?: string;
-  /**
-   * @remarks
-   * The deep research quota.
-   */
   deepResearchQuota?: number;
-  /**
-   * @remarks
-   * The quantity of deep research used.
-   */
   deepResearchUsed?: number;
-  /**
-   * @remarks
-   * The service expiration time, specified in UTC.
-   */
   expireTime?: string;
-  /**
-   * @remarks
-   * The order creation time, specified in UTC.
-   */
   gmtCreate?: string;
-  /**
-   * @remarks
-   * The order modification time, specified in UTC.
-   */
   gmtModified?: string;
-  /**
-   * @remarks
-   * The model call quota.
-   */
   modelCallQuota?: number;
-  /**
-   * @remarks
-   * The number of model calls used.
-   */
   modelCallUsed?: number;
-  /**
-   * @remarks
-   * The order instance ID.
-   */
   orderInstanceId?: string;
-  /**
-   * @remarks
-   * The number of services.
-   */
   serviceNum?: number;
-  /**
-   * @remarks
-   * The skill plan call quota.
-   */
   skillPlanCallQuota?: number;
-  /**
-   * @remarks
-   * The number of skill plan calls used.
-   */
   skillPlanCallUsed?: number;
-  /**
-   * @remarks
-   * The order status.
-   */
   status?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/AgenticCatalog.ts

@@ -3,16 +3,103 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AgenticCatalog extends $dara.Model {
+  /**
+   * @remarks
+   * The business attributes of the catalog, returned as key-value pairs. The following keys may be included:
+   * 
+   * - **ALIAS**: the alias of the data source
+   * - **HOST**: the endpoint of the data source
+   * - **PORT**: the connection port of the data source
+   * - **ENV_TYPE**: the environment type of the data source
+   * - **VERSION**: the database version of the data source
+   * - **SYNC_ALIAS**: whether automatic synchronization of instance aliases is enabled
+   */
   catalogBizAttrs?: { [key: string]: any };
+  /**
+   * @remarks
+   * The type of the catalog. Valid values:
+   * 
+   * - **JDBC**: relational database catalog
+   * - **DataLake**: data lake catalog
+   * - **Dataset**: knowledge base catalog
+   * 
+   * @example
+   * JDBC
+   */
   catalogType?: string;
+  /**
+   * @remarks
+   * The unique identifier of the catalog.
+   * 
+   * @example
+   * mc-HZ-OfjcNc2z***
+   */
   catalogUuid?: string;
+  /**
+   * @remarks
+   * The unique identifier of the data source associated with the catalog.
+   * 
+   * @example
+   * ds-HZ-Xk2Pq9Lm***
+   */
   dataSourceUuid?: string;
+  /**
+   * @remarks
+   * The database type of the data source associated with the catalog. The value is the uppercase name of the database type, such as MYSQL.
+   * 
+   * @example
+   * MYSQL
+   */
   dbType?: string;
+  /**
+   * @remarks
+   * The description of the catalog.
+   * 
+   * @example
+   * Order production database
+   */
   description?: string;
+  /**
+   * @remarks
+   * The name of the catalog.
+   * 
+   * @example
+   * prod_mysql_order
+   */
   name?: string;
+  /**
+   * @remarks
+   * The extended properties of the catalog, returned as key-value pairs.
+   */
   properties?: { [key: string]: any };
+  /**
+   * @remarks
+   * The region ID of the data source associated with the catalog.
+   * 
+   * @example
+   * cn-hangzhou
+   */
   regionId?: string;
+  /**
+   * @remarks
+   * The status of the catalog. Valid values:
+   * 
+   * - **0**: Normal. This value is set when the data source is created.
+   * - **-1**: Deleted. This value is set when the data source is deleted.
+   * 
+   * Disabling a data source does not change the status of the catalog.
+   * 
+   * @example
+   * 0
+   */
   state?: number;
+  /**
+   * @remarks
+   * The storage location. This property is returned only for catalogs of the DataLake type.
+   * 
+   * @example
+   * oss://examplebucket/datalake/
+   */
   storageLocation?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/AgenticDatabase.ts

@@ -7,72 +7,119 @@ export class AgenticDatabase extends $dara.Model {
   /**
    * @remarks
    * The name of the catalog.
+   * 
+   * @example
+   * prod_mysql_order
    */
   catalogName?: string;
   /**
    * @remarks
-   * The type of the catalog.
+   * The type of the catalog. Valid values:
+   * 
+   * - **JDBC**: relational database catalog
+   * - **DataLake**: data lake catalog
+   * - **Dataset**: knowledge base catalog
+   * 
+   * @example
+   * JDBC
    */
   catalogType?: string;
   /**
    * @remarks
-   * The unique identifier of the catalog.
+   * The UUID of the catalog.
+   * 
+   * @example
+   * mc-HZ-OfjcNc2z***
    */
   catalogUuid?: string;
   /**
    * @remarks
-   * The database\\"s business attributes.
+   * The business attributes of the database, returned as key-value pairs. Currently, this may include **ENV_TYPE**, which indicates the environment type of the database.
    */
   databaseBizAttrs?: { [key: string]: any };
   /**
    * @remarks
    * The unique identifier of the database.
+   * 
+   * @example
+   * md-HZ-fp9K7r***
    */
   databaseUuid?: string;
+  /**
+   * @remarks
+   * The database type inherited from the catalog. The value is the uppercase name of the database type, such as MYSQL.
+   * 
+   * @example
+   * MYSQL
+   */
   dbType?: string;
   /**
    * @remarks
-   * The database description.
+   * The description of the database.
+   * 
+   * @example
+   * Order database
    */
   description?: string;
   /**
    * @remarks
-   * The metadata for the database engine.
+   * The metadata of the database engine. This field is returned only for databases under a JDBC catalog.
    */
   engineMeta?: AgenticDatabaseEngineMeta;
   /**
    * @remarks
-   * The name of the database.
+   * The name of the database. For databases that distinguish schemas, such as PostgreSQL, this is the schema name.
+   * 
+   * @example
+   * order_db
    */
   name?: string;
   /**
    * @remarks
-   * The database\\"s extended properties.
+   * The extended properties of the database, returned as key-value pairs. This field is returned only for databases under a DataLake catalog.
    */
   properties?: { [key: string]: any };
   /**
    * @remarks
-   * The fully qualified name of the database.
+   * The fully qualified name of the database. For databases that distinguish schemas, such as PostgreSQL, the format is database name.schema name.
+   * 
+   * @example
+   * order_db
    */
   qualifiedName?: string;
   /**
    * @remarks
    * The region ID of the database.
+   * 
+   * @example
+   * cn-hangzhou
    */
   regionId?: string;
   /**
    * @remarks
-   * The name used to search the database.
+   * The search name of the database. SearchAgenticDatabase matches search keywords against this name.
+   * 
+   * @example
+   * order_db
    */
   searchName?: string;
   /**
    * @remarks
-   * The database state.
+   * The status of the database. Valid values:
+   * 
+   * - **0**: normal
+   * - **-1**: deleted
+   * 
+   * @example
+   * 0
    */
   state?: number;
   /**
    * @remarks
-   * The database storage location.
+   * The storage location. This field is returned only for databases under a DataLake catalog.
+   * 
+   * @example
+   * oss://examplebucket/datalake/order_db/
    */
   storageLocation?: string;
   static names(): { [key: string]: string } {

package/src/models/AgenticDatabaseEngineMeta.ts

@@ -5,22 +5,34 @@ import * as $dara from '@darabonba/typescript';
 export class AgenticDatabaseEngineMeta extends $dara.Model {
   /**
    * @remarks
-   * The name of the database catalog.
+   * The catalog name in the database engine.
+   * 
+   * @example
+   * def
    */
   catalogName?: string;
   /**
    * @remarks
-   * The character encoding for the database.
+   * The character set encoding of the database.
+   * 
+   * @example
+   * utf8mb4
    */
   encoding?: string;
   /**
    * @remarks
-   * The name of the database schema.
+   * The schema name.
+   * 
+   * @example
+   * public
    */
   schemaName?: string;
   /**
    * @remarks
-   * The storage capacity of the database, in GB.
+   * The storage capacity of the database, in MB.
+   * 
+   * @example
+   * 1024
    */
   storageCapacity?: number;
   static names(): { [key: string]: string } {

package/src/models/AgenticDatabaseObject.ts

@@ -3,35 +3,11 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AgenticDatabaseObject extends $dara.Model {
-  /**
-   * @remarks
-   * The fully qualified name of the database. This name uniquely identifies the database within the system.
-   */
   databaseQualifiedName?: string;
-  /**
-   * @remarks
-   * The unique identifier (UUID) of the database that contains the object.
-   */
   databaseUuid?: string;
-  /**
-   * @remarks
-   * The Data Definition Language (DDL) SQL statement that defines the object\\"s structure.
-   */
   ddlSql?: string;
-  /**
-   * @remarks
-   * The name of the database object, such as a table, view, or index.
-   */
   objectName?: string;
-  /**
-   * @remarks
-   * The fully qualified name that uniquely identifies the object, typically formatted as <database>.<schema>.<object>.
-   */
   objectQualifiedName?: string;
-  /**
-   * @remarks
-   * The type of the database object. For example, `TABLE`, `VIEW`, or `INDEX`.
-   */
   objectType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/AgenticDmsInstanceSyncTask.ts

@@ -6,6 +6,7 @@ export class AgenticDmsInstanceSyncTask extends $dara.Model {
   actorId?: string;
   actorName?: string;
   actorType?: string;
+  authorizeAddVpcNatWhiteList?: boolean;
   errorCode?: string;
   errorSummary?: string;
   failedCount?: number;
@@ -24,6 +25,7 @@ export class AgenticDmsInstanceSyncTask extends $dara.Model {
       actorId: 'ActorId',
       actorName: 'ActorName',
       actorType: 'ActorType',
+      authorizeAddVpcNatWhiteList: 'AuthorizeAddVpcNatWhiteList',
       errorCode: 'ErrorCode',
       errorSummary: 'ErrorSummary',
       failedCount: 'FailedCount',
@@ -45,6 +47,7 @@ export class AgenticDmsInstanceSyncTask extends $dara.Model {
       actorId: 'string',
       actorName: 'string',
       actorType: 'string',
+      authorizeAddVpcNatWhiteList: 'boolean',
       errorCode: 'string',
       errorSummary: 'string',
       failedCount: 'number',

package/src/models/AgenticResourceOwner.ts

@@ -5,7 +5,47 @@ import * as $dara from '@darabonba/typescript';
 export class AgenticResourceOwner extends $dara.Model {
   /**
    * @remarks
-   * The UUID of the Catalog to which the resource belongs.
+   * The instance alias. This display property comes from the catalog to which the resource belongs and is used only for frontend display to align with the data permission list. It is populated only in the My Assets or Managed Resources query scenarios and is null in other scenarios.
+   * 
+   * @example
+   * Production database
+   */
+  catalogAlias?: string;
+  /**
+   * @remarks
+   * The instance data source type, used only for frontend display. It is populated only in the My Assets or Managed Resources query scenarios and is null in other scenarios.
+   * 
+   * @example
+   * MYSQL
+   */
+  catalogDataSourceType?: string;
+  /**
+   * @remarks
+   * The instance environment type, used only for frontend display. It is populated only in the My Assets or Managed Resources query scenarios and is null in other scenarios.
+   * 
+   * @example
+   * prod
+   */
+  catalogEnvType?: string;
+  /**
+   * @remarks
+   * The instance host, used only for frontend display. Built-in sample data sources are masked as ******. It is populated only in the My Assets or Managed Resources query scenarios and is null in other scenarios.
+   * 
+   * @example
+   * rm-xxxxxxxx.mysql.rds.aliyuncs.com
+   */
+  catalogHost?: string;
+  /**
+   * @remarks
+   * The instance port, used only for frontend display. Built-in sample data sources are masked as ******. It is populated only in the My Assets or Managed Resources query scenarios and is null in other scenarios.
+   * 
+   * @example
+   * 3306
+   */
+  catalogPort?: string;
+  /**
+   * @remarks
+   * The UUID of the catalog to which the resource belongs.
    * 
    * @example
    * mc-HZ-5d9fbt8wW4AnGZNddXg4f
@@ -13,7 +53,15 @@ export class AgenticResourceOwner extends $dara.Model {
   catalogUuid?: string;
   /**
    * @remarks
-   * The qualified name of the database. This field has a value only when ResourceType is DATABASE and the downstream backfills the value. This field is provided for direct display on the frontend. For MySQL, this is the database name itself. For PostgreSQL or SQL Server, this is in the format of DatabaseName.SchemaName.
+   * The UUID of the instance data source to which the resource belongs. It is used only for frontend display and instance locating. Non-sensitive connection information is not masked. It is populated only in the My Assets or Managed Resources query scenarios and is null in other scenarios.
+   * 
+   * @example
+   * dsc-HZ-3f2b9a7c1d
+   */
+  dataSourceUuid?: string;
+  /**
+   * @remarks
+   * The fully qualified name of the database. It has a value only when ResourceType is DATABASE and is populated by the downstream service, which facilitates direct frontend display. For MySQL, it is the database name itself. For PostgreSQL or SQL Server, it is in the format of DatabaseName.SchemaName.
    * 
    * @example
    * finance.public
@@ -21,7 +69,7 @@ export class AgenticResourceOwner extends $dara.Model {
   databaseQualifiedName?: string;
   /**
    * @remarks
-   * The UUID of the database. This field has a value only when ResourceType is DATABASE.
+   * The UUID of the database. It has a value only when ResourceType is DATABASE.
    * 
    * @example
    * md-HZ-vXR1ezNGjiDjiV13Gos1N
@@ -29,7 +77,7 @@ export class AgenticResourceOwner extends $dara.Model {
   databaseUuid?: string;
   /**
    * @remarks
-   * The principal ID of the operator who registered this ownership relationship. In the "My Assets" scenario, the downstream does not return this field, and the value is null.
+   * The principal ID of the operator who registered the ownership relationship. The downstream service does not return this field in the My Assets query scenario, and the value is null.
    * 
    * @example
    * usr_6ieggks7zuy6gpfdmgzsjdso
@@ -37,11 +85,7 @@ export class AgenticResourceOwner extends $dara.Model {
   grantBy?: string;
   /**
    * @remarks
-   * The source channel of the ownership. Valid values:
-   * - CONSOLE: Manually registered in the console.
-   * - Other values: Written by the system built-in ownership mechanism.
-   * 
-   * In the "My Assets" scenario, the downstream does not return this field, and the value is null.
+   * The source channel of the ownership. CONSOLE indicates manual registration in the console. Other values indicate that the ownership is written by the built-in system. The downstream service does not return this field in the My Assets query scenario, and the value is null.
    * 
    * @example
    * CONSOLE
@@ -49,7 +93,7 @@ export class AgenticResourceOwner extends $dara.Model {
   grantFrom?: string;
   /**
    * @remarks
-   * The Owner principal ID. This is a gateway internal principal ID with the usr_ or agt_ prefix, not an Alibaba Cloud UID.
+   * The principal ID of the owner. This is the internal principal ID of the gateway with a usr_ or agt_ prefix, not the Alibaba Cloud UID.
    * 
    * @example
    * usr_wlwp5a7uruanebg5bbdqqf5n
@@ -57,9 +101,9 @@ export class AgenticResourceOwner extends $dara.Model {
   ownerPrincipalId?: string;
   /**
    * @remarks
-   * The Owner principal type. Valid values:
+   * The principal type of the owner. Valid values:
    * - USER: Human user.
-   * - AGENT: Managed Agent.
+   * - AGENT: Managed agent.
    * 
    * @example
    * USER
@@ -68,8 +112,8 @@ export class AgenticResourceOwner extends $dara.Model {
   /**
    * @remarks
    * The ownership level. Valid values:
-   * - INSTANCE: Instance-level ownership. The coordinate contains only CatalogUuid.
-   * - DATABASE: Database-level ownership. The coordinate contains CatalogUuid + DatabaseUuid.
+   * - INSTANCE: Instance-level ownership. The coordinate includes only CatalogUuid.
+   * - DATABASE: Database-level ownership. The coordinate includes CatalogUuid and DatabaseUuid.
    * 
    * @example
    * DATABASE
@@ -77,7 +121,13 @@ export class AgenticResourceOwner extends $dara.Model {
   resourceType?: string;
   static names(): { [key: string]: string } {
     return {
+      catalogAlias: 'CatalogAlias',
+      catalogDataSourceType: 'CatalogDataSourceType',
+      catalogEnvType: 'CatalogEnvType',
+      catalogHost: 'CatalogHost',
+      catalogPort: 'CatalogPort',
       catalogUuid: 'CatalogUuid',
+      dataSourceUuid: 'DataSourceUuid',
       databaseQualifiedName: 'DatabaseQualifiedName',
       databaseUuid: 'DatabaseUuid',
       grantBy: 'GrantBy',
@@ -90,7 +140,13 @@ export class AgenticResourceOwner extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      catalogAlias: 'string',
+      catalogDataSourceType: 'string',
+      catalogEnvType: 'string',
+      catalogHost: 'string',
+      catalogPort: 'string',
       catalogUuid: 'string',
+      dataSourceUuid: 'string',
       databaseQualifiedName: 'string',
       databaseUuid: 'string',
       grantBy: 'string',

package/src/models/AgenticTableBaseInfo.ts

@@ -4,13 +4,73 @@ import { AgenticTableEngineMeta } from "./AgenticTableEngineMeta";
 
 
 export class AgenticTableBaseInfo extends $dara.Model {
+  /**
+   * @remarks
+   * The type of the catalog to which the table belongs. Valid values:
+   * - **JDBC**: relational database catalog
+   * - **DataLake**: data lake catalog
+   * - **Dataset**: knowledge base catalog
+   * 
+   * @example
+   * JDBC
+   */
   catalogType?: string;
+  /**
+   * @remarks
+   * The fully qualified name of the database to which the table belongs.
+   * 
+   * @example
+   * order_db
+   */
   databaseQualifiedName?: string;
+  /**
+   * @remarks
+   * The UUID of the database to which the table belongs.
+   * 
+   * @example
+   * md-HZ-fp9K7r***
+   */
   databaseUuid?: string;
+  /**
+   * @remarks
+   * The description of the table.
+   * 
+   * @example
+   * Order table
+   */
   description?: string;
+  /**
+   * @remarks
+   * The engine metadata of the table.
+   */
   engineMeta?: AgenticTableEngineMeta;
+  /**
+   * @remarks
+   * The table name.
+   * 
+   * @example
+   * orders
+   */
   name?: string;
+  /**
+   * @remarks
+   * The fully qualified name of the table. You can use this name as the TableQualifiedName parameter for GetAgenticTableColumn and GetAgenticTableIndex. For SQL Server, the format is schema name.table name.
+   * 
+   * @example
+   * orders
+   */
   qualifiedName?: string;
+  /**
+   * @remarks
+   * The table type. Valid values:
+   * - **NORMAL**: regular table
+   * - **VIEW**: view
+   * - **FOREIGN**: foreign table
+   * - **SYNONYM**: synonym, supported only for Oracle data sources
+   * 
+   * @example
+   * NORMAL
+   */
   tableType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/AgenticTableColumn.ts

@@ -6,27 +6,39 @@ import { AgenticTableColumnEngineMeta } from "./AgenticTableColumnEngineMeta";
 export class AgenticTableColumn extends $dara.Model {
   /**
    * @remarks
-   * The name of the column.
+   * The column name.
+   * 
+   * @example
+   * id
    */
   columnName?: string;
   /**
    * @remarks
-   * The data type of the column.
+   * The column type, which is the native type definition of the database.
+   * 
+   * @example
+   * bigint
    */
   columnType?: string;
   /**
    * @remarks
-   * The description of the column.
+   * The column description.
+   * 
+   * @example
+   * Primary key ID
    */
   description?: string;
   /**
    * @remarks
-   * Engine-specific metadata for the column.
+   * The engine metadata of the column.
    */
   engineMeta?: AgenticTableColumnEngineMeta;
   /**
    * @remarks
-   * The 1-based ordinal position of the column within the table.
+   * The position of the column in the table, starting from 1.
+   * 
+   * @example
+   * 1
    */
   position?: number;
   static names(): { [key: string]: string } {