@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/ListAirflowsResponseBody.ts

@@ -4,105 +4,166 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAirflowsResponseBodyRootList extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the Airflow instance.
+   * 
    * @example
    * af-7a6ygsh80d****
    */
   airflowId?: string;
   /**
+   * @remarks
+   * The name of the Airflow instance.
+   * 
    * @example
    * test-airflow
    */
   airflowName?: string;
   /**
+   * @remarks
+   * The specifications of the Airflow instance.
+   * 
    * @example
    * SMALL
    */
   appSpec?: string;
   /**
+   * @remarks
+   * The type.
+   * 
    * @example
    * AIRFLOW
    */
   appType?: string;
+  /**
+   * @remarks
+   * The custom configuration.
+   */
   customAirflowCfg?: string[];
   /**
+   * @remarks
+   * The DAGs folder that Airflow scans.
+   * 
    * @example
    * default/dags
    */
   dagsDir?: string;
   /**
+   * @remarks
+   * The error message returned when the deployment fails.
+   * 
    * @example
    * quota exists
    */
   deployErrorMsg?: string;
   /**
+   * @remarks
+   * The description of the Airflow instance.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
+   * @remarks
+   * The time when the Airflow instance was created.
+   * 
    * @example
    * 2025-08-12T05:46:01.000+0000
    */
   gmtCreated?: string;
   /**
+   * @remarks
+   * The name of the OSS bucket.
+   * 
    * @example
    * osstest
    */
   ossBucketName?: string;
   /**
+   * @remarks
+   * The path in OSS.
+   * 
    * @example
    * /airflow
    */
   ossPath?: string;
   /**
+   * @remarks
+   * The plugins folder that Airflow scans.
+   * 
    * @example
    * default/plugins
    */
   pluginsDir?: string;
   /**
+   * @remarks
+   * The path to the file that contains the dependencies.
+   * 
    * @example
    * default/requirements.txt
    */
   requirementFile?: string;
   /**
+   * @remarks
+   * The security group ID.
+   * 
    * @example
    * sg-2ze1nak7h0alg1w****
    */
   securityGroupId?: string;
   /**
+   * @remarks
+   * The path to the script that is loaded when Airflow starts.
+   * 
    * @example
    * default/startup.sh
    */
   startupFile?: string;
   /**
+   * @remarks
+   * The status of the Airflow instance.
+   * 
    * @example
    * DEPLOYED
    */
   status?: string;
   /**
+   * @remarks
+   * The vSwitch ID.
+   * 
    * @example
    * vsw-uf6sxdc22x7sbdb****
    */
   vSwitchId?: string;
   /**
    * @remarks
-   * VPC ID。
+   * The VPC ID.
    * 
    * @example
    * vpc-8vbbfm33dy0y1pek****
    */
   vpcId?: string;
   /**
+   * @remarks
+   * The number of worker nodes.
+   * 
    * @example
    * 0
    */
   workerServerlessReplicas?: number;
   /**
+   * @remarks
+   * The ID of the DMS workspace.
+   * 
    * @example
    * 8630242382****
    */
   workspaceId?: string;
   /**
+   * @remarks
+   * The ID of the zone in the region.
+   * 
    * @example
    * cn-hangzhou-h
    */
@@ -172,8 +233,15 @@ export class ListAirflowsResponseBodyRootList extends $dara.Model {
 }
 
 export class ListAirflowsResponseBodyRoot extends $dara.Model {
+  /**
+   * @remarks
+   * The list of data.
+   */
   list?: ListAirflowsResponseBodyRootList[];
   /**
+   * @remarks
+   * The total number of matching Airflow instances.
+   * 
    * @example
    * 100
    */
@@ -206,45 +274,74 @@ export class ListAirflowsResponseBodyRoot extends $dara.Model {
 
 export class ListAirflowsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The details about the access denial.
+   * 
    * @example
    * NOT_FOUND
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * The error code. This parameter is returned when an error occurs.
+   * 
    * @example
    * UnknownError
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * Successful
    */
   message?: string;
   /**
+   * @remarks
+   * The token that is used to retrieve the next page of results.
+   * 
    * @example
    * NesLoKLEdIZrKhDT7I2gS****
    */
   nextToken?: string;
   /**
    * @remarks
-   * Reuqest ID。
+   * The request ID.
    * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The details of the data.
+   */
   root?: ListAirflowsResponseBodyRoot;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/ListCustomAgentRequest.ts

@@ -4,27 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCustomAgentRequest extends $dara.Model {
   /**
+   * @remarks
+   * The page number. Pages start from 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The page size. The default value is 20.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Specifies whether to query all published custom agents. The default value is false.
+   * 
    * @example
    * true
    */
   queryAllReleased?: boolean;
+  /**
+   * @remarks
+   * A keyword for a fuzzy search on the names and descriptions of custom agents.
+   * 
+   * @example
+   * 测试Agent
+   */
   searchKey?: string;
   /**
+   * @remarks
+   * The status of the custom agent.
+   * 
    * @example
    * RELEASED
    */
   status?: string;
   /**
+   * @remarks
+   * The ID of the workspace.
+   * 
    * @example
    * 56kv1pvl9uvt9**********bb
    */

package/src/models/ListCustomAgentResponseBody.ts

@@ -38,13 +38,37 @@ export class ListCustomAgentResponseBodyDataContentCallbackConfig extends $dara.
 }
 
 export class ListCustomAgentResponseBodyDataContentExecutionConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether to prevent user inquiries during the process.
+   * 
+   * @example
+   * false
+   */
   skipAskHuman?: boolean;
   /**
+   * @remarks
+   * Indicates whether to skip the plan confirmation step.
+   * 
    * @example
    * true
    */
   skipPlan?: boolean;
+  /**
+   * @remarks
+   * Indicates whether to skip all SQL confirmations.
+   * 
+   * @example
+   * true
+   */
   skipSqlConfirm?: boolean;
+  /**
+   * @remarks
+   * Indicates whether to skip the confirmation for generating a web report.
+   * 
+   * @example
+   * false
+   */
   skipWebReportConfirm?: boolean;
   static names(): { [key: string]: string } {
     return {
@@ -103,8 +127,29 @@ export class ListCustomAgentResponseBodyDataContentKnowledgeConfigList extends $
 }
 
 export class ListCustomAgentResponseBodyDataContentScheduleTaskConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The cron expression for the recurring task.
+   * 
+   * @example
+   * 0 0 0 ? * 1-7
+   */
   cronExpression?: string;
+  /**
+   * @remarks
+   * The query for the recurring task.
+   * 
+   * @example
+   * 分析一下这份数据，给出简报
+   */
   query?: string;
+  /**
+   * @remarks
+   * The ID of the referenced historical session.
+   * 
+   * @example
+   * 4m24*****mg7j2v
+   */
   relatedSessionId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -133,91 +178,225 @@ export class ListCustomAgentResponseBodyDataContentScheduleTaskConfig extends $d
 
 export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
   /**
+   * @remarks
+   * The parent Alibaba Cloud account ID.
+   * 
    * @example
    * 16738266********
    */
   aliyunParentId?: string;
   /**
+   * @remarks
+   * The Alibaba Cloud account ID.
+   * 
    * @example
    * 20372822********
    */
   aliyunUid?: string;
   callbackConfig?: ListCustomAgentResponseBodyDataContentCallbackConfig;
   /**
+   * @remarks
+   * The name of the creator.
+   * 
    * @example
    * HaoY*****
    */
   creatorUserName?: string;
   /**
+   * @remarks
+   * The custom agent ID.
+   * 
    * @example
    * ca-4y3ca4khkcu**********ysf
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
+  /**
+   * @remarks
+   * The data scope, specified as a JSON string.
+   * 
+   * @example
+   * {
+   *   "tableFlag" : true,
+   *   "scope" : "personal",
+   *   "personal" : {
+   *     "DataSourceType" : "remote_data_center",
+   *     "FileId" : "f-5qlrwaw10********s3gpw1z",
+   *     "Database" : "测试表格******.xlsx",
+   *     "Tables" : [ "Sheet1" ],
+   *     "TableIds" : [ "******" ],
+   *     "RegionId" : "cn-hangzhou"
+   *   }
+   * }
+   */
   dataJson?: string;
   defaultAgent?: number;
+  /**
+   * @remarks
+   * The description of the custom agent.
+   * 
+   * @example
+   * Agent测试描述
+   */
   description?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   dmsUnit?: string;
+  /**
+   * @remarks
+   * The execution configuration.
+   */
   executionConfig?: ListCustomAgentResponseBodyDataContentExecutionConfig;
   /**
+   * @remarks
+   * The time when the agent was created.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   gmtCreated?: string;
   /**
+   * @remarks
+   * The time when the agent was last modified.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   gmtModified?: string;
+  /**
+   * @remarks
+   * The instructions.
+   * 
+   * @example
+   * 分析框架：
+   * 1、需按日、周、月维度监控核心指标（GMV、订单量、UV、转化率），分析趋势变化及同比/环比波动；
+   * 2、划分新老客、渠道、地域进行拆解，识别增长来源与短板；
+   * 3、结合用户行为路径（浏览→加购→支付）开展漏斗分析，定位流失环节；
+   */
   instruction?: string;
+  /**
+   * @remarks
+   * Indicates whether the agent is configured with a recurring task.
+   * 
+   * @example
+   * true
+   */
   isScheduleTask?: boolean;
+  /**
+   * @remarks
+   * The provided knowledge.
+   * 
+   * @example
+   * 核心指标定义：
+   * 1、GMV（成交总额）指订单金额总和，含已支付及未支付成功订单；
+   * 2、订单量为每日有效下单笔数；
+   * 3、UV（独立访客）指访问网站或APP的去重用户数；
+   * 4、转化率=支付订单数 / UV，反映流量转化效率；
+   */
   knowledge?: string;
   knowledgeConfigList?: ListCustomAgentResponseBodyDataContentKnowledgeConfigList[];
   /**
+   * @remarks
+   * The user who last modified the agent.
+   * 
    * @example
    * 20372822********
    */
   modifier?: string;
   /**
+   * @remarks
+   * The name of the user who last modified the agent.
+   * 
    * @example
    * HaoY*****
    */
   modifierUserName?: string;
+  /**
+   * @remarks
+   * The name of the custom agent.
+   * 
+   * @example
+   * Agent测试名称
+   */
   name?: string;
+  /**
+   * @remarks
+   * If a recurring task is configured, this indicates its next scheduled runtime.
+   * 
+   * @example
+   * 1767715200
+   */
   nextRuntime?: number;
   /**
+   * @remarks
+   * The time when the agent was taken offline.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   offlineTime?: string;
   /**
+   * @remarks
+   * The region.
+   * 
    * @example
    * cn-hangzhou
    */
   region?: string;
   relatedSessionId?: string;
   /**
+   * @remarks
+   * The time when the agent was published.
+   * 
    * @example
    * 2025-12-11T14:04:32.000+00:00
    */
   releaseTime?: string;
+  /**
+   * @remarks
+   * The recurring task configuration.
+   */
   scheduleTaskConfig?: ListCustomAgentResponseBodyDataContentScheduleTaskConfig;
   /**
+   * @remarks
+   * The status of the custom agent.
+   * 
    * @example
    * RELEASED
    */
   status?: string;
+  /**
+   * @remarks
+   * The formatting instructions for the text report.
+   * 
+   * @example
+   * 文字报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   textReportConfig?: string;
+  /**
+   * @remarks
+   * The formatting instructions for the web report.
+   * 
+   * @example
+   * 网页报告要求所有数字不使用阿拉伯数字，全部转为中文数字
+   */
   webReportConfig?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * 56kv1pvl9uvt9**********bb
    */
@@ -314,23 +493,39 @@ export class ListCustomAgentResponseBodyDataContent extends $dara.Model {
 }
 
 export class ListCustomAgentResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * A list of custom agent objects.
+   */
   content?: ListCustomAgentResponseBodyDataContent[];
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 5
    */
   totalElements?: number;
   /**
+   * @remarks
+   * The total number of pages.
+   * 
    * @example
    * 1
    */
@@ -368,26 +563,43 @@ export class ListCustomAgentResponseBodyData extends $dara.Model {
 }
 
 export class ListCustomAgentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: ListCustomAgentResponseBodyData;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned if the request fails.
+   * 
    * @example
    * Specified parameter Tid is not valid.
    */
   errorMessage?: string;
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */