@alicloud/dms20250414 2.1.0 → 3.0.0

package/src/models/AgenticResourceOwner.ts

@@ -0,0 +1,112 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AgenticResourceOwner extends $dara.Model {
+  /**
+   * @remarks
+   * The UUID of the Catalog to which the resource belongs.
+   * 
+   * @example
+   * mc-HZ-5d9fbt8wW4AnGZNddXg4f
+   */
+  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.
+   * 
+   * @example
+   * finance.public
+   */
+  databaseQualifiedName?: string;
+  /**
+   * @remarks
+   * The UUID of the database. This field has a value only when ResourceType is DATABASE.
+   * 
+   * @example
+   * md-HZ-vXR1ezNGjiDjiV13Gos1N
+   */
+  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.
+   * 
+   * @example
+   * usr_6ieggks7zuy6gpfdmgzsjdso
+   */
+  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.
+   * 
+   * @example
+   * CONSOLE
+   */
+  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.
+   * 
+   * @example
+   * usr_wlwp5a7uruanebg5bbdqqf5n
+   */
+  ownerPrincipalId?: string;
+  /**
+   * @remarks
+   * The Owner principal type. Valid values:
+   * - USER: Human user.
+   * - AGENT: Managed Agent.
+   * 
+   * @example
+   * USER
+   */
+  ownerPrincipalType?: string;
+  /**
+   * @remarks
+   * The ownership level. Valid values:
+   * - INSTANCE: Instance-level ownership. The coordinate contains only CatalogUuid.
+   * - DATABASE: Database-level ownership. The coordinate contains CatalogUuid + DatabaseUuid.
+   * 
+   * @example
+   * DATABASE
+   */
+  resourceType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      catalogUuid: 'CatalogUuid',
+      databaseQualifiedName: 'DatabaseQualifiedName',
+      databaseUuid: 'DatabaseUuid',
+      grantBy: 'GrantBy',
+      grantFrom: 'GrantFrom',
+      ownerPrincipalId: 'OwnerPrincipalId',
+      ownerPrincipalType: 'OwnerPrincipalType',
+      resourceType: 'ResourceType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      catalogUuid: 'string',
+      databaseQualifiedName: 'string',
+      databaseUuid: 'string',
+      grantBy: 'string',
+      grantFrom: 'string',
+      ownerPrincipalId: 'string',
+      ownerPrincipalType: 'string',
+      resourceType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAgentRequest.ts

@@ -5,11 +5,37 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAgentRequest extends $dara.Model {
   /**
    * @remarks
+   * The agent name. The name must be unique within the same tenant. Maximum length: 128 characters.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * order-analysis-agent
    */
   agentName?: string;
+  /**
+   * @remarks
+   * The permission inheritance type of the agent, which specifies the permission source. Default value: HUMAN_BOUND.
+   * 
+   * @example
+   * HUMAN_BOUND
+   */
   agentType?: string;
+  /**
+   * @remarks
+   * The description of the agent. Maximum length: 512 characters.
+   * 
+   * @example
+   * An agent for querying and analyzing order data
+   */
   description?: string;
+  /**
+   * @remarks
+   * The validity period of the automatically issued API key, in seconds. Valid values: 1 to 31536000 (up to 1 year).
+   * 
+   * @example
+   * 2592000
+   */
   expireAfterSeconds?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateAgentResponseBody.ts

@@ -3,20 +3,122 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateAgentResponseBodyDataApiKey extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the agent to which the API key belongs.
+   * 
+   * @example
+   * agt-1a2b3c4d5e6f
+   */
   agentId?: string;
+  /**
+   * @remarks
+   * The name of the agent to which the API key belongs.
+   * 
+   * @example
+   * order-analysis-agent
+   */
   agentName?: string;
+  /**
+   * @remarks
+   * The permission inheritance type of the agent to which the API key belongs.
+   * 
+   * @example
+   * HUMAN_BOUND
+   */
   agentType?: string;
+  /**
+   * @remarks
+   * The time when the API key was created. The value is a time string in RFC 3339 format.
+   * 
+   * @example
+   * 2025-12-11T14:04:32Z
+   */
   createdAt?: string;
+  /**
+   * @remarks
+   * The user ID of the user who created the API key.
+   * 
+   * @example
+   * usr-1a2b3c4d
+   */
   creatorId?: string;
+  /**
+   * @remarks
+   * The name of the user who created the API key.
+   * 
+   * @example
+   * John Doe
+   */
   creatorName?: string;
+  /**
+   * @remarks
+   * The description of the API key.
+   * 
+   * @example
+   * Access Token automatically issued when the Agent is created
+   */
   description?: string;
+  /**
+   * @remarks
+   * The expiration time of the API key. The value is a time string in RFC 3339 format.
+   * 
+   * @example
+   * 2026-12-11T14:04:32Z
+   */
   expireTime?: string;
+  /**
+   * @remarks
+   * The primary key ID of the API key.
+   * 
+   * @example
+   * 1001
+   */
   id?: number;
+  /**
+   * @remarks
+   * Indicates whether the API key has been revoked.
+   */
   isRevoked?: boolean;
+  /**
+   * @remarks
+   * The non-sensitive visible prefix of the API key plaintext, used to identify the credential. The plaintext secret is not returned again.
+   * 
+   * @example
+   * dms_sk_1a2b
+   */
   keyPrefix?: string;
+  /**
+   * @remarks
+   * The time when the API key was last used. The value is a time string in RFC 3339 format. This parameter is empty if the API key has never been used.
+   * 
+   * @example
+   * 2025-12-12T09:30:00Z
+   */
   lastUsedTime?: string;
+  /**
+   * @remarks
+   * The name of the API key.
+   * 
+   * @example
+   * order-analysis-agent-default
+   */
   name?: string;
+  /**
+   * @remarks
+   * The plaintext secret of the API key. This value is returned only once in this creation response. Store it securely. Subsequent API calls do not return the plaintext secret again.
+   * 
+   * @example
+   * dms_sk_1a2b3c4d****
+   */
   secret?: string;
+  /**
+   * @remarks
+   * The credential source. Valid values: console (issued from the console), oauth (issued through the OAuth flow), install_token (issued through the install-and-authenticate flow). The API key automatically issued by this operation is always console.
+   * 
+   * @example
+   * console
+   */
   source?: string;
   static names(): { [key: string]: string } {
     return {
@@ -68,14 +170,74 @@ export class CreateAgentResponseBodyDataApiKey extends $dara.Model {
 }
 
 export class CreateAgentResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The globally unique ID of the agent.
+   * 
+   * @example
+   * agt-1a2b3c4d5e6f
+   */
   agentId?: string;
+  /**
+   * @remarks
+   * The agent name.
+   * 
+   * @example
+   * order-analysis-agent
+   */
   agentName?: string;
+  /**
+   * @remarks
+   * The permission inheritance type of the agent. Valid values: HUMAN_BOUND (inherits user permissions), PERMISSION_NARROW (narrows permissions), STANDALONE (operates as an independent identity principal without inheriting permissions from other principals).
+   * 
+   * @example
+   * HUMAN_BOUND
+   */
   agentType?: string;
+  /**
+   * @remarks
+   * The automatically issued API key for the new agent. The plaintext secret is returned only once in this response.
+   */
   apiKey?: CreateAgentResponseBodyDataApiKey;
+  /**
+   * @remarks
+   * The time when the agent was created. The value is a time string in RFC 3339 format.
+   * 
+   * @example
+   * 2025-12-11T14:04:32Z
+   */
   createdAt?: string;
+  /**
+   * @remarks
+   * The creation method of the agent. Valid values: manual (manually created in the console), auto (automatic creation by the system). Agents created by this operation are always manual.
+   * 
+   * @example
+   * manual
+   */
   creationType?: string;
+  /**
+   * @remarks
+   * The description of the agent.
+   * 
+   * @example
+   * An agent for querying and analyzing order data
+   */
   description?: string;
+  /**
+   * @remarks
+   * The user ID of the agent owner, which is the current user who initiated the creation request.
+   * 
+   * @example
+   * usr-1a2b3c4d
+   */
   ownerId?: string;
+  /**
+   * @remarks
+   * The status of the agent. Valid values: active (enabled), disabled (disabled), deleted (deleted). A newly created agent is always active.
+   * 
+   * @example
+   * active
+   */
   status?: string;
   static names(): { [key: string]: string } {
     return {
@@ -118,10 +280,39 @@ export class CreateAgentResponseBodyData extends $dara.Model {
 }
 
 export class CreateAgentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The agent information and the automatically issued API key returned after the agent is created.
+   */
   data?: CreateAgentResponseBodyData;
+  /**
+   * @remarks
+   * The status code of the request result. A value of success indicates success. A specific error code is returned upon failure.
+   * 
+   * @example
+   * success
+   */
   errorCode?: string;
+  /**
+   * @remarks
+   * The error message returned when the request fails. This parameter is empty when the request succeeds.
+   * 
+   * @example
+   * agentName must not be blank
+   */
   errorMessage?: string;
+  /**
+   * @remarks
+   * The unique ID of the request. You can use this ID for troubleshooting and tracing.
+   * 
+   * @example
+   * 67E910F2-4B62-5B0C-ACA3-7547695C****
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request was successful.
+   */
   success?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateAirflowRequest.ts

@@ -16,15 +16,15 @@ export class CreateAirflowRequest extends $dara.Model {
   airflowName?: string;
   /**
    * @remarks
-   * The Airflow version. Supported versions: 2.10 and 3.1.
+   * The Airflow version. Valid values: "3.2.2", "3.1.0", "2.10.4", and "3.0.6".
    * 
    * @example
-   * 3.1
+   * 3.2.2
    */
   airflowVersion?: string;
   /**
    * @remarks
-   * The compute specifications for the Airflow instance. Valid values: **SMALL**, **MEDIUM**, **LARGE**, **XLARGE**, or **X2LARGE**.
+   * The specification of the Airflow instance. Valid values: **SMALL**, **MEDIUM**, **LARGE**, **XLARGE**, and **X2LARGE**.
    * 
    * This parameter is required.
    * 
@@ -34,7 +34,7 @@ export class CreateAirflowRequest extends $dara.Model {
   appSpec?: string;
   /**
    * @remarks
-   * A client token to ensure request idempotence.
+   * The client token that is used to ensure the idempotence of the request.
    * 
    * @example
    * token-****
@@ -42,7 +42,7 @@ export class CreateAirflowRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The path to the DAG directory for Airflow to scan.
+   * The DAG directory scanned by Airflow.
    * 
    * @example
    * default/dags
@@ -50,7 +50,7 @@ export class CreateAirflowRequest extends $dara.Model {
   dagsDir?: string;
   /**
    * @remarks
-   * A list of data mount configurations.
+   * The list of data mount information.
    */
   dataMountInfoList?: DataMountInfo[];
   /**
@@ -63,12 +63,12 @@ export class CreateAirflowRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Specifies whether to enable worker elasticity.
+   * Specifies whether to enable Worker elasticity.
    */
   enableServerless?: boolean;
   /**
    * @remarks
-   * The graceful shutdown timeout for workers, in seconds.
+   * The timeout period for the Worker to gracefully shut down.
    * 
    * @example
    * 60
@@ -86,7 +86,7 @@ export class CreateAirflowRequest extends $dara.Model {
   ossBucketName?: string;
   /**
    * @remarks
-   * The OSS path for log storage.
+   * The OSS path for storing logs.
    * 
    * This parameter is required.
    * 
@@ -96,7 +96,7 @@ export class CreateAirflowRequest extends $dara.Model {
   ossPath?: string;
   /**
    * @remarks
-   * The path to the plugin directory for the Airflow instance to scan.
+   * The plugin directory scanned by the Airflow instance.
    * 
    * @example
    * default/plugins
@@ -104,7 +104,7 @@ export class CreateAirflowRequest extends $dara.Model {
   pluginsDir?: string;
   /**
    * @remarks
-   * The path to the Python requirements file.
+   * The path of the package installation file.
    * 
    * @example
    * default/requirements.txt
@@ -112,7 +112,7 @@ export class CreateAirflowRequest extends $dara.Model {
   requirementFile?: string;
   /**
    * @remarks
-   * The security group ID.
+   * The ID of the security group.
    * 
    * This parameter is required.
    * 
@@ -122,7 +122,7 @@ export class CreateAirflowRequest extends $dara.Model {
   securityGroupId?: string;
   /**
    * @remarks
-   * The path to the startup script in the Airflow container.
+   * The startup script of the Airflow container.
    * 
    * @example
    * default/startup.sh
@@ -130,7 +130,7 @@ export class CreateAirflowRequest extends $dara.Model {
   startupFile?: string;
   /**
    * @remarks
-   * The vSwitch ID.
+   * The ID of the vSwitch.
    * 
    * This parameter is required.
    * 
@@ -140,7 +140,7 @@ export class CreateAirflowRequest extends $dara.Model {
   vSwitchId?: string;
   /**
    * @remarks
-   * The VPC ID.
+   * VPC ID。
    * 
    * This parameter is required.
    * 
@@ -150,7 +150,7 @@ export class CreateAirflowRequest extends $dara.Model {
   vpcId?: string;
   /**
    * @remarks
-   * The number of elastic worker nodes.
+   * The number of extended Worker node replicas.
    * 
    * This parameter is required.
    * 
@@ -160,7 +160,7 @@ export class CreateAirflowRequest extends $dara.Model {
   workerServerlessReplicas?: number;
   /**
    * @remarks
-   * The ID of the DMS workspace.
+   * The ID of the Data Management workspace.
    * 
    * This parameter is required.
    * 
@@ -170,7 +170,7 @@ export class CreateAirflowRequest extends $dara.Model {
   workspaceId?: string;
   /**
    * @remarks
-   * The ID of the zone where the instance will be created.
+   * The zone ID within the region.
    * 
    * @example
    * cn-hangzhou-h

package/src/models/CreateAirflowResponseBody.ts

@@ -6,7 +6,7 @@ import { DataMountInfo } from "./DataMountInfo";
 export class CreateAirflowResponseBodyRoot extends $dara.Model {
   /**
    * @remarks
-   * The ID of the Airflow instance.
+   * The instance ID of the Airflow instance.
    * 
    * @example
    * af-****
@@ -38,7 +38,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   appSpec?: string;
   /**
    * @remarks
-   * The application type. This value is always airflow.
+   * The type.
    * 
    * @example
    * airflow
@@ -46,7 +46,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   appType?: string;
   /**
    * @remarks
-   * Custom Airflow configurations.
+   * The custom Airflow configuration.
    */
   customAirflowCfg?: string[];
   /**
@@ -59,12 +59,12 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   dagsDir?: string;
   /**
    * @remarks
-   * A list of data mount configurations.
+   * The list of data mount information.
    */
   dataMountInfoList?: DataMountInfo[];
   /**
    * @remarks
-   * The deployment error message.
+   * The error log information.
    * 
    * @example
    * vpc not found
@@ -80,12 +80,12 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Indicates whether to enable serverless workers.
+   * Specifies whether to enable Worker elasticity.
    */
   enableServerless?: boolean;
   /**
    * @remarks
-   * The time the instance was created.
+   * The creation time.
    * 
    * @example
    * 2025-08-12T05:46:01.000+0000
@@ -93,7 +93,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   gmtCreated?: string;
   /**
    * @remarks
-   * The timeout period for a graceful shutdown, in seconds.
+   * The timeout period for the Worker to gracefully shut down.
    * 
    * @example
    * 60
@@ -117,7 +117,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   ossPath?: string;
   /**
    * @remarks
-   * The plugin directory that Airflow scans.
+   * The directory that Airflow scans for plugins.
    * 
    * @example
    * default/plugins
@@ -125,7 +125,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   pluginsDir?: string;
   /**
    * @remarks
-   * The path to the requirements file.
+   * The path of the installable package.
    * 
    * @example
    * default/requirements.txt
@@ -133,7 +133,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   requirementFile?: string;
   /**
    * @remarks
-   * The security group ID.
+   * The ID of the security group.
    * 
    * @example
    * sg-2ze1nak7h0alg1xxx
@@ -141,7 +141,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   securityGroupId?: string;
   /**
    * @remarks
-   * The file that is loaded when the Airflow instance starts. You can use this file to set environment variables.
+   * The file loaded when the Airflow instance starts. You can use this file to set environment variables and other configurations.
    * 
    * @example
    * default/startup.sh
@@ -149,7 +149,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   startupFile?: string;
   /**
    * @remarks
-   * The status of the Airflow instance.
+   * The instance status of the Airflow instance.
    * 
    * @example
    * DEPLOYING
@@ -157,7 +157,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The VSwitch ID.
+   * The ID of the vSwitch.
    * 
    * @example
    * vsw-8vbaf073jawozfpbg****
@@ -165,7 +165,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   vSwitchId?: string;
   /**
    * @remarks
-   * The VPC ID.
+   * VPC ID。
    * 
    * @example
    * vpc-uf63r6coyiw9o5gf****
@@ -173,7 +173,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
   vpcId?: string;
   /**
    * @remarks
-   * The number of scaled-out worker nodes.
+   * The number of worker scale-out nodes.
    * 
    * @example
    * 0
@@ -273,7 +273,7 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
 export class CreateAirflowResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Details of the access denial.
+   * The details of the access denial.
    * 
    * @example
    * NOT_FOUND
@@ -297,7 +297,7 @@ export class CreateAirflowResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The response message.
+   * The log information.
    * 
    * @example
    * Successful
@@ -318,10 +318,9 @@ export class CreateAirflowResponseBody extends $dara.Model {
   root?: CreateAirflowResponseBodyRoot;
   /**
    * @remarks
-   * Indicates whether the request succeeded. Valid values:
-   * 
-   * - **true**: The request succeeded.
+   * Indicates whether the request was successful. Valid values:
    * 
+   * - **true**: The request was successful.
    * - **false**: The request failed.
    * 
    * @example