@alicloud/dms-enterprise20181101 1.43.0 → 1.43.1

package/dist/client.d.ts

@@ -532,15 +532,25 @@ export declare class CreateDataArchiveOrderRequestParam extends $dara.Model {
 export declare class CreateDataCorrectOrderRequestParamDbItemList extends $dara.Model {
     /**
      * @remarks
-     * The ID of the database. The database can be a physical database or a logical database.
+     * The database ID. The database can be a physical database or a logical database.
      *
-     * *   To obtain the ID of a physical database, call the [ListDatabases](https://help.aliyun.com/document_detail/141873.html) or [SearchDatabase](https://help.aliyun.com/document_detail/141876.html) operation.
-     * *   To obtain the ID of a logical database, call the [ListLogicDatabases](https://help.aliyun.com/document_detail/141874.html) or [SearchDatabase](https://help.aliyun.com/document_detail/141876.html) operation.
+     * *   To query the ID of a physical database, call the [ListDatabases](https://help.aliyun.com/document_detail/141873.html) or [SearchDatabase](https://help.aliyun.com/document_detail/141876.html) operation.
+     * *   To query the ID of a logical database, call the [ListLogicDatabases](https://help.aliyun.com/document_detail/141874.html) or [SearchDatabase](https://help.aliyun.com/document_detail/141876.html) operation.
      *
      * @example
      * 1860****
      */
     dbId?: number;
+    /**
+     * @remarks
+     * The instance ID. You can call the ListInstances or GetInstance operation to query the instance ID.
+     *
+     * >
+     * > The instance change feature is supported only by ApsaraDB RDS for MySQL instances, PolarDB for MySQL clusters, and AnalyticDB for MySQL clusters.
+     *
+     * @example
+     * 1860****
+     */
     instanceId?: number;
     /**
      * @remarks
@@ -567,9 +577,9 @@ export declare class CreateDataCorrectOrderRequestParamDbItemList extends $dara.
 export declare class CreateDataCorrectOrderRequestParam extends $dara.Model {
     /**
      * @remarks
-     * The key of the attachment that contains the SQL statements used to change data. You can call the [GetUserUploadFileJob](https://help.aliyun.com/document_detail/206069.html) operation to obtain the attachment key from the value of the AttachmentKey parameter.
+     * The key of the attachment that contains the SQL statements used to change data. You can call the [GetUserUploadFileJob](https://help.aliyun.com/document_detail/206069.html) operation to obtain the attachment key from the value of AttachmentKey.
      *
-     * >  This parameter is required if you set the **SqlType** parameter to **ATTACHMENT**.
+     * >  This parameter is required if you set **SqlType** to **ATTACHMENT**.
      *
      * @example
      * test.sql
@@ -585,14 +595,14 @@ export declare class CreateDataCorrectOrderRequestParam extends $dara.Model {
     classify?: string;
     /**
      * @remarks
-     * The databases in which you want to change data.
+     * The databases whose data you want to change.
      *
      * This parameter is required.
      */
     dbItemList?: CreateDataCorrectOrderRequestParamDbItemList[];
     /**
      * @remarks
-     * The estimated number of data rows to be affected by the data change.
+     * The estimated number of data rows that may be affected by the data change.
      *
      * This parameter is required.
      *
@@ -602,11 +612,11 @@ export declare class CreateDataCorrectOrderRequestParam extends $dara.Model {
     estimateAffectRows?: number;
     /**
      * @remarks
-     * The execution mode of the ticket after the ticket is approved. Valid values:
+     * The mode in which the data change ticket is executed after the ticket is approved. Valid values:
      *
-     * *   **COMMITOR**: The data change is performed by the user who submits the ticket.
-     * *   **AUTO**: The data change is automatically performed after the ticket is approved.
-     * *   **LAST_AUDITOR**: The data change is performed by the last approver of the ticket.
+     * *   **COMMITOR**: The ticket is executed by the user who submits the ticket.
+     * *   **AUTO**: The ticket is automatically executed after the ticket is approved.
+     * *   **LAST_AUDITOR**: The ticket is executed by the last approver of the ticket.
      *
      * @example
      * COMMITOR
@@ -614,9 +624,13 @@ export declare class CreateDataCorrectOrderRequestParam extends $dara.Model {
     execMode?: string;
     /**
      * @remarks
-     * The SQL statements that you want to execute to change data.
+     * The SQL statements for data change.
+     *
+     * >
      *
-     * >  This parameter is required if you set the **SqlType** parameter to **TEXT**.
+     * *   This parameter is required if you set **SqlType** to **TEXT**.
+     *
+     * *   The size of the SQL statement cannot exceed 15 MB.
      *
      * @example
      * update base_user set id = 1 where id  = 1;
@@ -624,9 +638,9 @@ export declare class CreateDataCorrectOrderRequestParam extends $dara.Model {
     execSQL?: string;
     /**
      * @remarks
-     * The key of the attachment that contains the SQL statements used to roll back the data change. You can call the [GetUserUploadFileJob](https://help.aliyun.com/document_detail/206069.html) operation to the attachment key from the value of the AttachmentKey parameter.
+     * The key of the attachment that contains the SQL statements used to roll back the data change. You can call the [GetUserUploadFileJob](https://help.aliyun.com/document_detail/206069.html) operation to obtain the attachment key from the value of AttachmentKey.
      *
-     * >  This parameter is required if you set the **RollbackSqlType** parameter to **ATTACHMENT**.
+     * >  This parameter is required if you set **RollbackSqlType** to **ATTACHMENT**.
      *
      * @example
      * test_rollback.sql
@@ -634,9 +648,9 @@ export declare class CreateDataCorrectOrderRequestParam extends $dara.Model {
     rollbackAttachmentName?: string;
     /**
      * @remarks
-     * The SQL statements used to roll back the data change.
+     * The SQL statements for rolling back the data change.
      *
-     * > This parameter is required if you set the **RollbackSqlType** parameter to **TEXT**.
+     * >  This parameter is required if you set **RollbackSqlType** to **TEXT**.
      *
      * @example
      * update base_user set id = 1 where id  = 1;
@@ -646,8 +660,8 @@ export declare class CreateDataCorrectOrderRequestParam extends $dara.Model {
      * @remarks
      * The format of the SQL statements used to roll back the data change. Valid values:
      *
-     * *   **TEXT**: text
-     * *   **ATTACHMENT**: attachment
+     * *   **TEXT**
+     * *   **ATTACHMENT**
      *
      * @example
      * TEXT
@@ -657,8 +671,8 @@ export declare class CreateDataCorrectOrderRequestParam extends $dara.Model {
      * @remarks
      * The format of the SQL statements used to change data. Valid values:
      *
-     * *   **TEXT**: text
-     * *   **ATTACHMENT**: attachment
+     * *   **TEXT**
+     * *   **ATTACHMENT**
      *
      * This parameter is required.
      *
@@ -4698,8 +4712,8 @@ export declare class GetDataExportDownloadURLResponseBodyDownloadURLResult exten
      * @remarks
      * Indicates whether export results are available for download. Valid values:
      *
-     * *   **true**: Export results are available for download.
-     * *   **false**: No export results are available for download.
+     * *   **true**
+     * *   **false**
      *
      * @example
      * true
@@ -4733,6 +4747,13 @@ export declare class GetDataExportDownloadURLResponseBodyDownloadURLResult exten
     });
 }
 export declare class GetDataExportOrderDetailResponseBodyDataExportOrderDetailKeyInfo extends $dara.Model {
+    /**
+     * @remarks
+     * Export task ID.
+     *
+     * @example
+     * 1385****
+     */
     jobId?: number;
     /**
      * @remarks
@@ -4859,7 +4880,7 @@ export declare class GetDataExportOrderDetailResponseBodyDataExportOrderDetailOr
 export declare class GetDataExportOrderDetailResponseBodyDataExportOrderDetail extends $dara.Model {
     /**
      * @remarks
-     * The information about the ticket.
+     * The status information.
      */
     keyInfo?: GetDataExportOrderDetailResponseBodyDataExportOrderDetailKeyInfo;
     /**
@@ -21030,6 +21051,13 @@ export declare class CreateDataCorrectOrderRequest extends $dara.Model {
      * This parameter is required.
      */
     param?: CreateDataCorrectOrderRequestParam;
+    /**
+     * @remarks
+     * The ID of the Alibaba Cloud account that is used to call the API operation.
+     *
+     * @example
+     * 21400447956867****
+     */
     realLoginUserUid?: string;
     /**
      * @remarks
@@ -21081,6 +21109,13 @@ export declare class CreateDataCorrectOrderShrinkRequest extends $dara.Model {
      * This parameter is required.
      */
     paramShrink?: string;
+    /**
+     * @remarks
+     * The ID of the Alibaba Cloud account that is used to call the API operation.
+     *
+     * @example
+     * 21400447956867****
+     */
     realLoginUserUid?: string;
     /**
      * @remarks
@@ -27874,6 +27909,13 @@ export declare class ExecuteDataCorrectRequest extends $dara.Model {
      * 406****
      */
     orderId?: number;
+    /**
+     * @remarks
+     * The ID of the Alibaba Cloud account that is used to call the API operation.
+     *
+     * @example
+     * 21400447956867****
+     */
     realLoginUserUid?: string;
     /**
      * @remarks
@@ -27924,6 +27966,13 @@ export declare class ExecuteDataCorrectShrinkRequest extends $dara.Model {
      * 406****
      */
     orderId?: number;
+    /**
+     * @remarks
+     * The ID of the Alibaba Cloud account that is used to call the API operation.
+     *
+     * @example
+     * 21400447956867****
+     */
     realLoginUserUid?: string;
     /**
      * @remarks
@@ -28011,15 +28060,21 @@ export declare class ExecuteDataCorrectResponse extends $dara.Model {
 export declare class ExecuteDataExportRequest extends $dara.Model {
     /**
      * @remarks
-     * The parameters that are required to perform the operation:
+     * The parameters that are required to perform the operation. Sample code:
      *
      * ```json
      * {
-     *    "fileType": "CSV", // The format of the exported file.
-     *    "encoding": "" // The encoding format.
-     *  }
+     *   "mode" : "FAST",   // The mode in which data is exported. Default value: FAST. A value of NORMAL specifies that the export task can be terminated during the export.  "encoding" : "UTF8",  // The encoding format.  "startTime" : "2022-12-22 00:00:00",  // The point in time at which data export starts.  "transaction" : false,    // Specifies whether to enable transactions.  "fileType" : "SQL"    // The format of the exported file.}
      * ```
      *
+     * >  You can also set mode, encoding, and fileType to the following values:
+     *
+     * *   mode: NORMAL
+     *
+     * *   encoding: UTF8MB4, GB2312, ISO_8859_1, GBK, LATAIN1, or CP1252
+     *
+     * *   fileType: XLSX, CSV, JSON, or TXT
+     *
      * @example
      * {    "fileType": "CSV",    "encoding": ""  }
      */
@@ -28036,6 +28091,13 @@ export declare class ExecuteDataExportRequest extends $dara.Model {
      * 1234
      */
     orderId?: number;
+    /**
+     * @remarks
+     * The ID of the Alibaba Cloud account that is used to call the API operation.
+     *
+     * @example
+     * 21400447956867****
+     */
     realLoginUserUid?: string;
     /**
      * @remarks
@@ -28061,15 +28123,21 @@ export declare class ExecuteDataExportRequest extends $dara.Model {
 export declare class ExecuteDataExportShrinkRequest extends $dara.Model {
     /**
      * @remarks
-     * The parameters that are required to perform the operation:
+     * The parameters that are required to perform the operation. Sample code:
      *
      * ```json
      * {
-     *    "fileType": "CSV", // The format of the exported file.
-     *    "encoding": "" // The encoding format.
-     *  }
+     *   "mode" : "FAST",   // The mode in which data is exported. Default value: FAST. A value of NORMAL specifies that the export task can be terminated during the export.  "encoding" : "UTF8",  // The encoding format.  "startTime" : "2022-12-22 00:00:00",  // The point in time at which data export starts.  "transaction" : false,    // Specifies whether to enable transactions.  "fileType" : "SQL"    // The format of the exported file.}
      * ```
      *
+     * >  You can also set mode, encoding, and fileType to the following values:
+     *
+     * *   mode: NORMAL
+     *
+     * *   encoding: UTF8MB4, GB2312, ISO_8859_1, GBK, LATAIN1, or CP1252
+     *
+     * *   fileType: XLSX, CSV, JSON, or TXT
+     *
      * @example
      * {    "fileType": "CSV",    "encoding": ""  }
      */
@@ -28084,6 +28152,13 @@ export declare class ExecuteDataExportShrinkRequest extends $dara.Model {
      * 1234
      */
     orderId?: number;
+    /**
+     * @remarks
+     * The ID of the Alibaba Cloud account that is used to call the API operation.
+     *
+     * @example
+     * 21400447956867****
+     */
     realLoginUserUid?: string;
     /**
      * @remarks
@@ -30028,7 +30103,7 @@ export declare class GetDataCronClearTaskDetailListResponse extends $dara.Model
 export declare class GetDataExportDownloadURLRequest extends $dara.Model {
     /**
      * @remarks
-     * The ID of the ticket. You can call the [ListOrders](https://help.aliyun.com/document_detail/144643.html) operation to obtain the ticket ID.
+     * The ticket ID. You can call the [ListOrders](https://help.aliyun.com/document_detail/144643.html) operation to query the ticket ID.
      *
      * This parameter is required.
      *
@@ -30036,10 +30111,17 @@ export declare class GetDataExportDownloadURLRequest extends $dara.Model {
      * 546****
      */
     orderId?: number;
+    /**
+     * @remarks
+     * The ID of the Alibaba Cloud account that is used to call the API operation.
+     *
+     * @example
+     * 21400447956867****
+     */
     realLoginUserUid?: string;
     /**
      * @remarks
-     * The ID of the tenant. You can call the [GetUserActiveTenant](https://help.aliyun.com/document_detail/198073.html) or [ListUserTenants](https://help.aliyun.com/document_detail/198074.html) operation to obtain the tenant ID.
+     * The tenant ID. You can call the [GetUserActiveTenant](https://help.aliyun.com/document_detail/198073.html) or [ListUserTenants](https://help.aliyun.com/document_detail/198074.html) operation to query the tenant ID.
      *
      * @example
      * 3***
@@ -30059,12 +30141,12 @@ export declare class GetDataExportDownloadURLRequest extends $dara.Model {
 export declare class GetDataExportDownloadURLResponseBody extends $dara.Model {
     /**
      * @remarks
-     * The details about the download URL of the file that records the export results for the ticket.
+     * The details of the download URL of the file that records the export results for the ticket.
      */
     downloadURLResult?: GetDataExportDownloadURLResponseBodyDownloadURLResult;
     /**
      * @remarks
-     * The error code.
+     * The error code returned if the request failed.
      *
      * @example
      * UnknownError
@@ -30072,7 +30154,7 @@ export declare class GetDataExportDownloadURLResponseBody extends $dara.Model {
     errorCode?: string;
     /**
      * @remarks
-     * The error message.
+     * The error message returned if the request failed.
      *
      * @example
      * UnknownError
@@ -30080,7 +30162,7 @@ export declare class GetDataExportDownloadURLResponseBody extends $dara.Model {
     errorMessage?: string;
     /**
      * @remarks
-     * The ID of the request.
+     * The request ID.
      *
      * @example
      * 4BF24EA5-9013-4C85-AE68-6C23AF5E0097
@@ -30090,8 +30172,8 @@ export declare class GetDataExportDownloadURLResponseBody extends $dara.Model {
      * @remarks
      * Indicates whether the request was successful. Valid values:
      *
-     * *   **true**: The request was successful.
-     * *   **false**: The request failed.
+     * *   **true**
+     * *   **false**
      *
      * @example
      * true
@@ -47928,6 +48010,13 @@ export declare class SubmitOrderApprovalRequest extends $dara.Model {
      * 12345
      */
     orderId?: number;
+    /**
+     * @remarks
+     * The ID of the Alibaba Cloud account that is used to call the API operation.
+     *
+     * @example
+     * 21400447956867****
+     */
     realLoginUserUid?: string;
     /**
      * @remarks
@@ -50314,9 +50403,6 @@ export declare class UpdateTaskContentV2Request extends $dara.Model {
      */
     nodeContent?: string;
     /**
-     * @remarks
-     * This parameter is required.
-     *
      * @example
      * 449***
      */
@@ -51935,6 +52021,13 @@ export declare class UpdateUserRequest extends $dara.Model {
      * 123456789
      */
     uid?: number;
+    /**
+     * @remarks
+     * The UID of the String type. If you specify this parameter, the UID of the Long type is replaced.
+     *
+     * @example
+     * 322824****:dmstest.wu@A201***
+     */
     uidString?: string;
     /**
      * @remarks
@@ -53689,7 +53782,7 @@ export default class Client extends OpenApi {
      */
     getDataCronClearTaskDetailList(request: GetDataCronClearTaskDetailListRequest): Promise<GetDataCronClearTaskDetailListResponse>;
     /**
-     * Queries the download URL of the file that records the export results for a data export ticket in Data Management (DMS).
+     * Queries the download URL of export results for a data export ticket.
      *
      * @param request - GetDataExportDownloadURLRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -53697,7 +53790,7 @@ export default class Client extends OpenApi {
      */
     getDataExportDownloadURLWithOptions(request: GetDataExportDownloadURLRequest, runtime: $dara.RuntimeOptions): Promise<GetDataExportDownloadURLResponse>;
     /**
-     * Queries the download URL of the file that records the export results for a data export ticket in Data Management (DMS).
+     * Queries the download URL of export results for a data export ticket.
      *
      * @param request - GetDataExportDownloadURLRequest
      * @returns GetDataExportDownloadURLResponse
@@ -56412,7 +56505,7 @@ export default class Client extends OpenApi {
      */
     updateTaskContent(request: UpdateTaskContentRequest): Promise<UpdateTaskContentResponse>;
     /**
-     * 接受大容量sql文件的更新节点内容API
+     * 大sql更新节点专用
      *
      * @param request - UpdateTaskContentV2Request
      * @param runtime - runtime options for this request RuntimeOptions
@@ -56420,7 +56513,7 @@ export default class Client extends OpenApi {
      */
     updateTaskContentV2WithOptions(request: UpdateTaskContentV2Request, runtime: $dara.RuntimeOptions): Promise<UpdateTaskContentV2Response>;
     /**
-     * 接受大容量sql文件的更新节点内容API
+     * 大sql更新节点专用
      *
      * @param request - UpdateTaskContentV2Request
      * @returns UpdateTaskContentV2Response

package/dist/client.js

@@ -41197,7 +41197,7 @@ class Client extends openapi_core_1.default {
         return await this.getDataCronClearTaskDetailListWithOptions(request, runtime);
     }
     /**
-     * Queries the download URL of the file that records the export results for a data export ticket in Data Management (DMS).
+     * Queries the download URL of export results for a data export ticket.
      *
      * @param request - GetDataExportDownloadURLRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -41237,7 +41237,7 @@ class Client extends openapi_core_1.default {
         }
     }
     /**
-     * Queries the download URL of the file that records the export results for a data export ticket in Data Management (DMS).
+     * Queries the download URL of export results for a data export ticket.
      *
      * @param request - GetDataExportDownloadURLRequest
      * @returns GetDataExportDownloadURLResponse
@@ -50640,7 +50640,7 @@ class Client extends openapi_core_1.default {
         return await this.updateTaskContentWithOptions(request, runtime);
     }
     /**
-     * 接受大容量sql文件的更新节点内容API
+     * 大sql更新节点专用
      *
      * @param request - UpdateTaskContentV2Request
      * @param runtime - runtime options for this request RuntimeOptions
@@ -50679,7 +50679,7 @@ class Client extends openapi_core_1.default {
         }
     }
     /**
-     * 接受大容量sql文件的更新节点内容API
+     * 大sql更新节点专用
      *
      * @param request - UpdateTaskContentV2Request
      * @returns UpdateTaskContentV2Response