@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/ConfigAirflowShrinkRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ConfigAirflowShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique ID of the Airflow instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,11 +15,15 @@ export class ConfigAirflowShrinkRequest extends $dara.Model {
   airflowId?: string;
   /**
    * @remarks
+   * The list of custom Airflow configurations.
+   * 
    * This parameter is required.
    */
   customAirflowCfgShrink?: string;
   /**
    * @remarks
+   * The DMS workspace ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateAirflowLoginTokenRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAirflowLoginTokenRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the Airflow instance. You can view the instance ID on the [Airflow Instances](https://help.aliyun.com/document_detail/2881043.html) page.
+   * The ID of the Airflow instance. For more information, see [Airflow instances]().
    * 
    * This parameter is required.
    * 

package/src/models/CreateAirflowLoginTokenResponseBody.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAirflowLoginTokenResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The endpoint that is used to access the Airflow instance.
+   * The endpoint of the Airflow instance.
    * 
    * @example
-   * https://data-dms.aliyuncs.com/airflow/x/xxxx/af-ehrmszbxxxxxxx
+   * https://data-dms.aliyuncs.com/airflow/x/xxxx/af-ehrmszb****
    */
   host?: string;
   /**
@@ -16,7 +16,7 @@ export class CreateAirflowLoginTokenResponseBodyData extends $dara.Model {
    * The generated token.
    * 
    * @example
-   * f432d77de03b6b95fc24f91414e29c
+   * f432d77de03b6b95fc24f9****
    */
   token?: string;
   static names(): { [key: string]: string } {
@@ -45,7 +45,7 @@ export class CreateAirflowLoginTokenResponseBodyData extends $dara.Model {
 export class CreateAirflowLoginTokenResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code. The status code 200 indicates that the request was successful.
+   * The status code. A value of 200 indicates that the request is successful.
    * 
    * @example
    * 200
@@ -53,17 +53,18 @@ export class CreateAirflowLoginTokenResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The result of the site monitoring task.
+   * The returned data.
    */
   data?: CreateAirflowLoginTokenResponseBodyData;
   /**
    * @remarks
-   * The error code returned if the call failed. Variable description:
+   * The error code.
    * 
-   * *   If the request was successful, this parameter is not returned.
-   * *   This parameter is returned only if the request failed.
+   * - If the request is successful, this parameter is not returned.
    * 
-   * For more information, see the "Error codes" section in this topic.
+   * - If the request fails, this parameter is returned.
+   * 
+   * For more information, see the error codes in this topic.
    * 
    * @example
    * Success
@@ -71,7 +72,7 @@ export class CreateAirflowLoginTokenResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The description of the error code.
+   * The error code description.
    * 
    * @example
    * 200
@@ -79,7 +80,7 @@ export class CreateAirflowLoginTokenResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The error message returned.
+   * The error message.
    * 
    * @example
    * Successful
@@ -87,7 +88,7 @@ export class CreateAirflowLoginTokenResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID. You can use the ID to locate logs and troubleshoot issues.
+   * The request ID.
    * 
    * @example
    * 4284D079-30F4-5B23-ADC4-28F291622C9A
@@ -97,8 +98,9 @@ export class CreateAirflowLoginTokenResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   True
-   * *   False
+   * - True: The request was successful.
+   * 
+   * - False: The request failed.
    * 
    * @example
    * True

package/src/models/CreateAirflowRequest.ts

@@ -6,6 +6,8 @@ import { DataMountInfo } from "./DataMountInfo";
 export class CreateAirflowRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the Airflow instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,12 +15,17 @@ export class CreateAirflowRequest extends $dara.Model {
    */
   airflowName?: string;
   /**
+   * @remarks
+   * The Airflow version. Supported versions: 2.10 and 3.1.
+   * 
    * @example
    * 3.1
    */
   airflowVersion?: string;
   /**
    * @remarks
+   * The compute specifications for the Airflow instance. Valid values: **SMALL**, **MEDIUM**, **LARGE**, **XLARGE**, or **X2LARGE**.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -26,29 +33,51 @@ export class CreateAirflowRequest extends $dara.Model {
    */
   appSpec?: string;
   /**
+   * @remarks
+   * A client token to ensure request idempotence.
+   * 
    * @example
    * token-****
    */
   clientToken?: string;
   /**
+   * @remarks
+   * The path to the DAG directory for Airflow to scan.
+   * 
    * @example
    * default/dags
    */
   dagsDir?: string;
+  /**
+   * @remarks
+   * A list of data mount configurations.
+   */
   dataMountInfoList?: DataMountInfo[];
   /**
+   * @remarks
+   * The description of the Airflow instance.
+   * 
    * @example
    * order scheduler
    */
   description?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable worker elasticity.
+   */
   enableServerless?: boolean;
   /**
+   * @remarks
+   * The graceful shutdown timeout for workers, in seconds.
+   * 
    * @example
    * 60
    */
   gracefulShutdownTimeout?: number;
   /**
    * @remarks
+   * The name of the OSS bucket.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -57,6 +86,8 @@ export class CreateAirflowRequest extends $dara.Model {
   ossBucketName?: string;
   /**
    * @remarks
+   * The OSS path for log storage.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -64,17 +95,25 @@ export class CreateAirflowRequest extends $dara.Model {
    */
   ossPath?: string;
   /**
+   * @remarks
+   * The path to the plugin directory for the Airflow instance to scan.
+   * 
    * @example
    * default/plugins
    */
   pluginsDir?: string;
   /**
+   * @remarks
+   * The path to the Python requirements file.
+   * 
    * @example
    * default/requirements.txt
    */
   requirementFile?: string;
   /**
    * @remarks
+   * The security group ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -82,12 +121,17 @@ export class CreateAirflowRequest extends $dara.Model {
    */
   securityGroupId?: string;
   /**
+   * @remarks
+   * The path to the startup script in the Airflow container.
+   * 
    * @example
    * default/startup.sh
    */
   startupFile?: string;
   /**
    * @remarks
+   * The vSwitch ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -96,7 +140,7 @@ export class CreateAirflowRequest extends $dara.Model {
   vSwitchId?: string;
   /**
    * @remarks
-   * VPC ID。
+   * The VPC ID.
    * 
    * This parameter is required.
    * 
@@ -106,6 +150,8 @@ export class CreateAirflowRequest extends $dara.Model {
   vpcId?: string;
   /**
    * @remarks
+   * The number of elastic worker nodes.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -114,6 +160,8 @@ export class CreateAirflowRequest extends $dara.Model {
   workerServerlessReplicas?: number;
   /**
    * @remarks
+   * The ID of the DMS workspace.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -121,6 +169,9 @@ export class CreateAirflowRequest extends $dara.Model {
    */
   workspaceId?: string;
   /**
+   * @remarks
+   * The ID of the zone where the instance will be created.
+   * 
    * @example
    * cn-hangzhou-h
    */

package/src/models/CreateAirflowResponseBody.ts

@@ -5,117 +5,192 @@ import { DataMountInfo } from "./DataMountInfo";
 
 export class CreateAirflowResponseBodyRoot extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the Airflow instance.
+   * 
    * @example
    * af-****
    */
   airflowId?: string;
   /**
+   * @remarks
+   * The name of the Airflow instance.
+   * 
    * @example
    * testairflow
    */
   airflowName?: string;
   /**
+   * @remarks
+   * The Airflow version.
+   * 
    * @example
    * 3.1
    */
   airflowVersion?: string;
   /**
+   * @remarks
+   * The specifications of the Airflow instance.
+   * 
    * @example
    * SMALL
    */
   appSpec?: string;
   /**
+   * @remarks
+   * The application type. This value is always airflow.
+   * 
    * @example
    * airflow
    */
   appType?: string;
+  /**
+   * @remarks
+   * Custom Airflow configurations.
+   */
   customAirflowCfg?: string[];
   /**
+   * @remarks
+   * The directory that Airflow scans for DAGs.
+   * 
    * @example
    * default/dags
    */
   dagsDir?: string;
+  /**
+   * @remarks
+   * A list of data mount configurations.
+   */
   dataMountInfoList?: DataMountInfo[];
   /**
+   * @remarks
+   * The deployment error message.
+   * 
    * @example
    * vpc not found
    */
   deployErrorMsg?: string;
   /**
+   * @remarks
+   * The description of the Airflow instance.
+   * 
    * @example
    * order scheduler
    */
   description?: string;
+  /**
+   * @remarks
+   * Indicates whether to enable serverless workers.
+   */
   enableServerless?: boolean;
   /**
+   * @remarks
+   * The time the instance was created.
+   * 
    * @example
    * 2025-08-12T05:46:01.000+0000
    */
   gmtCreated?: string;
   /**
+   * @remarks
+   * The timeout period for a graceful shutdown, in seconds.
+   * 
    * @example
    * 60
    */
   gracefulShutdownTimeout?: number;
   /**
+   * @remarks
+   * The name of the OSS bucket.
+   * 
    * @example
    * oss-test
    */
   ossBucketName?: string;
   /**
+   * @remarks
+   * The OSS path.
+   * 
    * @example
    * /airflow
    */
   ossPath?: string;
   /**
+   * @remarks
+   * The plugin directory that Airflow scans.
+   * 
    * @example
    * default/plugins
    */
   pluginsDir?: string;
   /**
+   * @remarks
+   * The path to the requirements file.
+   * 
    * @example
    * default/requirements.txt
    */
   requirementFile?: string;
   /**
+   * @remarks
+   * The security group ID.
+   * 
    * @example
    * sg-2ze1nak7h0alg1xxx
    */
   securityGroupId?: string;
   /**
+   * @remarks
+   * The file that is loaded when the Airflow instance starts. You can use this file to set environment variables.
+   * 
    * @example
    * default/startup.sh
    */
   startupFile?: string;
   /**
+   * @remarks
+   * The status of the Airflow instance.
+   * 
    * @example
    * DEPLOYING
    */
   status?: string;
   /**
+   * @remarks
+   * The VSwitch ID.
+   * 
    * @example
    * vsw-8vbaf073jawozfpbg****
    */
   vSwitchId?: string;
   /**
    * @remarks
-   * VPC ID。
+   * The VPC ID.
    * 
    * @example
    * vpc-uf63r6coyiw9o5gf****
    */
   vpcId?: string;
   /**
+   * @remarks
+   * The number of scaled-out worker nodes.
+   * 
    * @example
    * 0
    */
   workerServerlessReplicas?: number;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * 86302423828****
    */
   workspaceId?: string;
   /**
+   * @remarks
+   * The zone ID.
+   * 
    * @example
    * cn-hangzhou-h
    */
@@ -197,32 +272,58 @@ export class CreateAirflowResponseBodyRoot extends $dara.Model {
 
 export class CreateAirflowResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Details of the access denial.
+   * 
    * @example
    * NOT_FOUND
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * UnknownError
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * Successful
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The Airflow data dictionary.
+   */
   root?: CreateAirflowResponseBodyRoot;
   /**
+   * @remarks
+   * Indicates whether the request succeeded. Valid values:
+   * 
+   * - **true**: The request succeeded.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/CreateAirflowShrinkRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAirflowShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the Airflow instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class CreateAirflowShrinkRequest extends $dara.Model {
    */
   airflowName?: string;
   /**
+   * @remarks
+   * The Airflow version. Supported versions: 2.10 and 3.1.
+   * 
    * @example
    * 3.1
    */
   airflowVersion?: string;
   /**
    * @remarks
+   * The compute specifications for the Airflow instance. Valid values: **SMALL**, **MEDIUM**, **LARGE**, **XLARGE**, or **X2LARGE**.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -25,29 +32,51 @@ export class CreateAirflowShrinkRequest extends $dara.Model {
    */
   appSpec?: string;
   /**
+   * @remarks
+   * A client token to ensure request idempotence.
+   * 
    * @example
    * token-****
    */
   clientToken?: string;
   /**
+   * @remarks
+   * The path to the DAG directory for Airflow to scan.
+   * 
    * @example
    * default/dags
    */
   dagsDir?: string;
+  /**
+   * @remarks
+   * A list of data mount configurations.
+   */
   dataMountInfoListShrink?: string;
   /**
+   * @remarks
+   * The description of the Airflow instance.
+   * 
    * @example
    * order scheduler
    */
   description?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable worker elasticity.
+   */
   enableServerless?: boolean;
   /**
+   * @remarks
+   * The graceful shutdown timeout for workers, in seconds.
+   * 
    * @example
    * 60
    */
   gracefulShutdownTimeout?: number;
   /**
    * @remarks
+   * The name of the OSS bucket.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -56,6 +85,8 @@ export class CreateAirflowShrinkRequest extends $dara.Model {
   ossBucketName?: string;
   /**
    * @remarks
+   * The OSS path for log storage.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -63,17 +94,25 @@ export class CreateAirflowShrinkRequest extends $dara.Model {
    */
   ossPath?: string;
   /**
+   * @remarks
+   * The path to the plugin directory for the Airflow instance to scan.
+   * 
    * @example
    * default/plugins
    */
   pluginsDir?: string;
   /**
+   * @remarks
+   * The path to the Python requirements file.
+   * 
    * @example
    * default/requirements.txt
    */
   requirementFile?: string;
   /**
    * @remarks
+   * The security group ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -81,12 +120,17 @@ export class CreateAirflowShrinkRequest extends $dara.Model {
    */
   securityGroupId?: string;
   /**
+   * @remarks
+   * The path to the startup script in the Airflow container.
+   * 
    * @example
    * default/startup.sh
    */
   startupFile?: string;
   /**
    * @remarks
+   * The vSwitch ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -95,7 +139,7 @@ export class CreateAirflowShrinkRequest extends $dara.Model {
   vSwitchId?: string;
   /**
    * @remarks
-   * VPC ID。
+   * The VPC ID.
    * 
    * This parameter is required.
    * 
@@ -105,6 +149,8 @@ export class CreateAirflowShrinkRequest extends $dara.Model {
   vpcId?: string;
   /**
    * @remarks
+   * The number of elastic worker nodes.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -113,6 +159,8 @@ export class CreateAirflowShrinkRequest extends $dara.Model {
   workerServerlessReplicas?: number;
   /**
    * @remarks
+   * The ID of the DMS workspace.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -120,6 +168,9 @@ export class CreateAirflowShrinkRequest extends $dara.Model {
    */
   workspaceId?: string;
   /**
+   * @remarks
+   * The ID of the zone where the instance will be created.
+   * 
    * @example
    * cn-hangzhou-h
    */