@alicloud/dataworks-public20200518 10.1.0 → 10.1.2

package/src/models/DsgSceneQuerySceneListByNameResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DsgSceneQuerySceneListByNameResponseBodyDataProjects extends $dara.Model {
   /**
    * @remarks
-   * The ID of the E-MapReduce (EMR) cluster. This parameter is returned only if the `DbType` is `EMR`.
+   * The ID of the EMR cluster. This parameter is returned only when the data scope where the masking scenario takes effect is an EMR engine.
    * 
    * @example
    * c-123456
@@ -14,12 +14,9 @@ export class DsgSceneQuerySceneListByNameResponseBodyDataProjects extends $dara.
   /**
    * @remarks
    * The engine type. Valid values:
-   * 
-   * - MaxCompute: `ODPS.ODPS`
-   * 
-   * - Hologres: `HOLO.POSTGRES`
-   * 
-   * - E-MapReduce (EMR): `EMR`
+   * - ODPS: ODPS.ODPS
+   * - HOLO: HOLO.POSTGRES
+   * - EMR: EMR
    * 
    * @example
    * ODPS.ODPS
@@ -61,12 +58,12 @@ export class DsgSceneQuerySceneListByNameResponseBodyDataProjects extends $dara.
 export class DsgSceneQuerySceneListByNameResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The nested data masking scenarios.
+   * The parameter information of multi-level masking scenarios.
    */
   children?: any[];
   /**
    * @remarks
-   * The description of the data masking scenario.
+   * The description of the masking scenario.
    * 
    * @example
    * Test scenarios
@@ -74,7 +71,7 @@ export class DsgSceneQuerySceneListByNameResponseBodyData extends $dara.Model {
   desc?: string;
   /**
    * @remarks
-   * The ID of the data masking scenario.
+   * The ID of the masking scenario.
    * 
    * @example
    * 123
@@ -82,24 +79,18 @@ export class DsgSceneQuerySceneListByNameResponseBodyData extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The engine instances to which the data masking scenario applies.
+   * The engine information where the masking scenario takes effect.
    */
   projects?: DsgSceneQuerySceneListByNameResponseBodyDataProjects[];
   /**
    * @remarks
-   * The code for the level-1 scenario. Valid values:
-   * 
-   * - Data masking in Data Map and DataStudio: `dataworks_display_desense_code`
-   * 
-   * - Data masking at the MaxCompute engine layer: `maxcompute_desense_code`
-   * 
-   * - Data masking at the MaxCompute engine layer (new): `maxcompute_new_desense_code`
-   * 
-   * - Data masking at the Hologres engine layer: `hologres_display_desense_code`
-   * 
-   * - Static data masking in Data Integration: `dataworks_data_integration_desense_code`
-   * 
-   * - Data masking in Data Analysis: `dataworks_analysis_desense_code`
+   * The code of the level-1 masking scenario. Valid values:
+   * - dataworks_display_desense_code: masking for Data Studio and Data Map display
+   * - maxcompute_desense_code: masking at the MaxCompute engine layer
+   * - maxcompute_new_desense_code: masking at the MaxCompute engine layer (new)
+   * - hologres_display_desense_code: masking at the Hologres engine layer
+   * - dataworks_data_integration_desense_code: static data masking for Data Integration
+   * - dataworks_analysis_desense_code: masking for Data Analysis display
    * 
    * @example
    * dataworks_display_desense_code
@@ -107,11 +98,9 @@ export class DsgSceneQuerySceneListByNameResponseBodyData extends $dara.Model {
   sceneCode?: string;
   /**
    * @remarks
-   * The level of the data masking scenario. Valid values:
-   * 
-   * - `0`: level-1 scenario
-   * 
-   * - `1`: level-2 scenario
+   * The level of the masking scenario. Valid values:
+   * - 0: level-1 scenario
+   * - 1: level-2 scenario
    * 
    * @example
    * 1
@@ -119,7 +108,7 @@ export class DsgSceneQuerySceneListByNameResponseBodyData extends $dara.Model {
   sceneLevel?: number;
   /**
    * @remarks
-   * The name of the data masking scenario.
+   * The name of the masking scenario.
    * 
    * @example
    * test_scene
@@ -127,12 +116,19 @@ export class DsgSceneQuerySceneListByNameResponseBodyData extends $dara.Model {
   sceneName?: string;
   /**
    * @remarks
-   * The user groups to which the data masking scenario applies. Multiple user group names are separated by a comma (,).
+   * The list of user group names for the masking scenario. Multiple names are separated by commas (,).
    * 
    * @example
    * user1,user2
    */
   userGroups?: string;
+  /**
+   * @remarks
+   * The data source type of the masking scenario.
+   * 
+   * @example
+   * EMR
+   */
   scenceDbType?: string;
   static names(): { [key: string]: string } {
     return {
@@ -180,7 +176,7 @@ export class DsgSceneQuerySceneListByNameResponseBodyData extends $dara.Model {
 export class DsgSceneQuerySceneListByNameResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of data masking scenarios.
+   * The returned data.
    */
   data?: DsgSceneQuerySceneListByNameResponseBodyData[];
   /**
@@ -209,7 +205,7 @@ export class DsgSceneQuerySceneListByNameResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The ID of the request. You can use this ID to troubleshoot issues.
+   * The ID of the request. You can use the ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 102400001
@@ -217,11 +213,9 @@ export class DsgSceneQuerySceneListByNameResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * - `true`: The request was successful.
-   * 
-   * - `false`: The request failed.
+   * Indicates whether the call is successful. Valid values:
+   * - true: The call is successful.
+   * - false: The call fails.
    * 
    * @example
    * true

package/src/models/DsgScenedDeleteSceneRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DsgScenedDeleteSceneRequest extends $dara.Model {
   /**
    * @remarks
-   * The IDs of level-2 data masking scenarios.
+   * The list of IDs of the secondary data masking scenarios.
    * 
    * This parameter is required.
    */

package/src/models/DsgScenedDeleteSceneResponseBody.ts

@@ -5,10 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DsgScenedDeleteSceneResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The operation result. Valid values:
-   * 
-   * *   true: The operation is successful.
-   * *   false: The operation failed.
+   * Indicates whether the operation was successful. Valid values:
+   * - true: The operation was successful.
+   * - false: The operation failed.
    * 
    * @example
    * true
@@ -40,7 +39,7 @@ export class DsgScenedDeleteSceneResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request. You can use the ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 102400001
@@ -48,10 +47,9 @@ export class DsgScenedDeleteSceneResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * *   true
-   * *   false
+   * Indicates whether the call was successful. Valid values:
+   * - true: The call was successful.
+   * - false: The call failed.
    * 
    * @example
    * true

package/src/models/DsgScenedDeleteSceneShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DsgScenedDeleteSceneShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The IDs of level-2 data masking scenarios.
+   * The list of IDs of the secondary data masking scenarios.
    * 
    * This parameter is required.
    */

package/src/models/DsgStopSensIdentifyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DsgStopSensIdentifyRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the sensitive data identification task. You can call the [DsgRunSensIdentify](https://help.aliyun.com/document_detail/2744039.html) operation to obtain the task ID.
+   * The ID of the identification task in Data Security Guard. You can obtain the ID by calling the [DsgRunSensIdentify](https://help.aliyun.com/document_detail/2744039.html) operation.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DsgStopSensIdentifyRequest extends $dara.Model {
   jobId?: number;
   /**
    * @remarks
-   * The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.
+   * The tenant ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console), go to the Data Studio page, click the username in the upper-right corner, and choose Menu > User Information to obtain the tenant ID.
    * 
    * This parameter is required.
    * 

package/src/models/DsgStopSensIdentifyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DsgStopSensIdentifyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned data, which is of the Boolean type.
+   * The returned data, which is a Boolean value.
    * 
    * @example
    * true
@@ -37,18 +37,17 @@ export class DsgStopSensIdentifyResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID.
+   * The request ID, which uniquely identifies the request.
    * 
    * @example
-   * 10000001
+   * 10000111
    */
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * *   true
-   * *   false
+   * Indicates whether the call was successful. Valid values:
+   * - true: successful.
+   * - false: failed.
    * 
    * @example
    * true

package/src/models/DsgUpdateDesensStatusListRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DsgUpdateDesensStatusListRequest extends $dara.Model {
   /**
    * @remarks
-   * The switch status. Valid values:
-   * 1: enabled
-   * 0: disabled
+   * The status of the switch. Valid values:
+   * - 1: Enabled.
+   * - 0: Disabled.
    * 
    * This parameter is required.
    * 
@@ -20,6 +20,9 @@ export class DsgUpdateDesensStatusListRequest extends $dara.Model {
    * The list of switch IDs.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * DsgUpdateDesensStatusList
    */
   ids?: number[];
   static names(): { [key: string]: string } {

package/src/models/DsgUpdateDesensStatusListResponseBody.ts

@@ -13,10 +13,9 @@ export class DsgUpdateDesensStatusListResponseBody extends $dara.Model {
   data?: boolean;
   /**
    * @remarks
-   * The error code. Valid values:
-   * 
-   * - If the request is successful, the **ErrorCode** field is not returned.
-   * - If the request fails, the **ErrorCode** field is returned. For more information, see the **Error codes** section of this topic.
+   * The error code.
+   * - If the request succeeds, the **ErrorCode** field is omitted.
+   * - If the request fails, the **ErrorCode** field is returned. For more information, see the **Error codes** section in this topic.
    * 
    * @example
    * 1010040007

package/src/models/DsgUpdateDesensStatusListShrinkRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DsgUpdateDesensStatusListShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The switch status. Valid values:
-   * 1: enabled
-   * 0: disabled
+   * The status of the switch. Valid values:
+   * - 1: Enabled.
+   * - 0: Disabled.
    * 
    * This parameter is required.
    * 
@@ -20,6 +20,9 @@ export class DsgUpdateDesensStatusListShrinkRequest extends $dara.Model {
    * The list of switch IDs.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * DsgUpdateDesensStatusList
    */
   idsShrink?: string;
   static names(): { [key: string]: string } {

package/src/models/DsgUserGroupAddOrUpdateRequest.ts

@@ -5,20 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class DsgUserGroupAddOrUpdateRequestUserGroups extends $dara.Model {
   /**
    * @remarks
-   * The users in the user group.
-   * 
-   * - For user groups created based on Alibaba Cloud accounts and Resource Access Management (RAM) roles, call the [DsgUserGroupQueryUserList](https://help.aliyun.com/document_detail/2786445.html) API to query the user list.
-   * 
-   * - For user groups created based on MaxCompute roles, call the [DsgUserGroupGetOdpsRoleGroups](https://help.aliyun.com/document_detail/2785695.html) API to query the user list.
+   * The list of users in the user group.
+   * - For user groups created based on Alibaba Cloud accounts and RAM roles, you can call the [DsgUserGroupQueryUserList](https://help.aliyun.com/document_detail/2786445.html) operation to query the user list.
+   * - For user groups created based on MaxCompute roles, you can call the [DsgUserGroupGetOdpsRoleGroups](https://help.aliyun.com/document_detail/2785695.html) operation to query the user list.
    */
   accounts?: string[];
   /**
    * @remarks
    * The ID of the user group.
-   * 
-   * - If you do not specify this parameter, a new user group is created.
-   * 
-   * - If you specify this parameter, the specified user group is modified. You can call the [DsgUserGroupQueryList](https://help.aliyun.com/document_detail/2786441.html) operation to query the ID of the user group.
+   * - If you do not specify this parameter, a user group is created.
+   * - If you specify this parameter, the specified user group is modified. You can call the [DsgUserGroupQueryList](https://help.aliyun.com/document_detail/2786441.html) operation to query the user group ID.
    * 
    * @example
    * 123
@@ -46,7 +42,7 @@ export class DsgUserGroupAddOrUpdateRequestUserGroups extends $dara.Model {
   owner?: string;
   /**
    * @remarks
-   * The name of the MaxCompute project. Set this parameter when you create a MaxCompute user group.
+   * The name of the MaxCompute project. This parameter is required when you create a MaxCompute user group.
    * 
    * @example
    * dev_project
@@ -54,13 +50,10 @@ export class DsgUserGroupAddOrUpdateRequestUserGroups extends $dara.Model {
   projectName?: string;
   /**
    * @remarks
-   * The type of the user group. The following values are valid:
-   * 
-   * - 1: Alibaba Cloud user
-   * 
-   * - 2: RAM Role
-   * 
-   * - 3: MaxCompute Role
+   * The type of the user group. Valid values:
+   * - 1: Alibaba Cloud user.
+   * - 2: RAM role.
+   * - 3: MaxCompute role.
    * 
    * This parameter is required.
    * 
@@ -68,6 +61,16 @@ export class DsgUserGroupAddOrUpdateRequestUserGroups extends $dara.Model {
    * 1
    */
   userGroupType?: number;
+  /**
+   * @remarks
+   * The list of projects associated with the user group.
+   * 
+   * @example
+   * [
+   *   { "projectName": "demo_project_a", "accounts": "role_read,role_write" },
+   *   { "projectName": "demo_project_b", "accounts": "role_analyst" }
+   * ]
+   */
   projects?: string;
   static names(): { [key: string]: string } {
     return {
@@ -108,7 +111,7 @@ export class DsgUserGroupAddOrUpdateRequestUserGroups extends $dara.Model {
 export class DsgUserGroupAddOrUpdateRequest extends $dara.Model {
   /**
    * @remarks
-   * The user groups.
+   * The user group information.
    * 
    * This parameter is required.
    */

package/src/models/DsgUserGroupAddOrUpdateResponseBody.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DsgUserGroupAddOrUpdateResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The result of the operation. Valid values:
-   * 
-   * - `true`: The operation succeeded.
-   * 
-   * - `false`: The operation failed.
+   * The operation result. Valid values:
+   * - true: The operation was successful.
+   * - false: The operation failed.
    * 
    * @example
    * true
@@ -17,7 +15,7 @@ export class DsgUserGroupAddOrUpdateResponseBody extends $dara.Model {
   data?: boolean;
   /**
    * @remarks
-   * The error code that is returned if the request fails.
+   * The error code.
    * 
    * @example
    * 1029030003
@@ -25,7 +23,7 @@ export class DsgUserGroupAddOrUpdateResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message that is returned if the request fails.
+   * The error message.
    * 
    * @example
    * param error
@@ -41,7 +39,7 @@ export class DsgUserGroupAddOrUpdateResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The ID of the request. This is a common parameter. We recommend that you save this ID. If an issue occurs, you can use the ID to locate logs for troubleshooting.
+   * The ID of the request. You can use the ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 102400001
@@ -49,11 +47,9 @@ export class DsgUserGroupAddOrUpdateResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request succeeded. Valid values:
-   * 
-   * - `true`: The request succeeded.
-   * 
-   * - `false`: The request failed.
+   * Indicates whether the call was successful. Valid values:
+   * - true: The call was successful.
+   * - false: The call failed.
    * 
    * @example
    * true

package/src/models/DsgUserGroupAddOrUpdateShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DsgUserGroupAddOrUpdateShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The user groups.
+   * The user group information.
    * 
    * This parameter is required.
    */

package/src/models/DsgUserGroupDeleteResponseBody.ts

@@ -50,8 +50,11 @@ export class DsgUserGroupDeleteResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * 
+   * 
+   * 
+   * - true: successful
+   * - false: failed
    * 
    * @example
    * true

package/src/models/DsgUserGroupQueryListRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DsgUserGroupQueryListRequest extends $dara.Model {
   /**
    * @remarks
-   * A keyword for the user group name. The service performs a fuzzy search to find matching user groups.
+   * The keyword for the user group name. The platform performs a fuzzy match based on the keyword to query relevant user group information.
    * 
    * @example
    * yun_group
@@ -21,7 +21,7 @@ export class DsgUserGroupQueryListRequest extends $dara.Model {
   owner?: string;
   /**
    * @remarks
-   * The number of the page to return.
+   * The page number.
    * 
    * This parameter is required.
    * 
@@ -41,12 +41,22 @@ export class DsgUserGroupQueryListRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The name of the MaxCompute project to query for user groups.
+   * The name of the engine. Configure this parameter to query MaxCompute user group information.
    * 
    * @example
    * dev_project
    */
   projectName?: string;
+  /**
+   * @remarks
+   * The user group type. Valid values:
+   * - 1: Alibaba Cloud user
+   * - 2: RAM role
+   * - 3: MaxCompute role
+   * 
+   * @example
+   * 1
+   */
   userGroupType?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/DsgUserGroupQueryListResponseBody.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class DsgUserGroupQueryListResponseBodyPageDataData extends $dara.Model {
   /**
    * @remarks
-   * A list of usernames in the user group.
+   * The collection of usernames in the user group.
    */
   accounts?: string[];
   /**
    * @remarks
-   * The time when the user group was created.
+   * The creation time of the user group.
    * 
    * @example
    * 2024-05-10 17:14:44
@@ -18,7 +18,7 @@ export class DsgUserGroupQueryListResponseBodyPageDataData extends $dara.Model {
   gmtCreate?: string;
   /**
    * @remarks
-   * The time when the user group was last modified.
+   * The modification time of the user group.
    * 
    * @example
    * 2024-05-10 17:14:44
@@ -26,7 +26,7 @@ export class DsgUserGroupQueryListResponseBodyPageDataData extends $dara.Model {
   gmtModified?: string;
   /**
    * @remarks
-   * The ID of the user group.
+   * The user group ID.
    * 
    * @example
    * 123
@@ -48,6 +48,13 @@ export class DsgUserGroupQueryListResponseBodyPageDataData extends $dara.Model {
    * user1
    */
   owner?: string;
+  /**
+   * @remarks
+   * The MaxCompute aggregation information.
+   * 
+   * @example
+   * [{"projectName":"alpha_xy","accounts":"alice,bob_exampleaccount"}]
+   */
   mcAggregationInfo?: string;
   static names(): { [key: string]: string } {
     return {
@@ -88,10 +95,10 @@ export class DsgUserGroupQueryListResponseBodyPageDataData extends $dara.Model {
 export class DsgUserGroupQueryListResponseBodyPageData extends $dara.Model {
   /**
    * @remarks
-   * A list of user groups.
+   * The list of user groups.
    * 
    * @example
-   * {     "accounts": [         "role_project_scheduler"     ],     "gmtCreate": "2024-05-10 15:22:18",     "gmtModified": "2024-05-10 15:22:18",     "id": 1955,     "name": "dsg_fin_test-copy",     "owner": "UAT" }
+   * {     "accounts": [         "role_project_scheduler"     ],     "gmtCreate": "2024-05-10 15:22:18",     "gmtModified": "2024-05-10 15:22:18",     "id": 1955,     "name": "dsg_fin_test-Copy",     "owner": "UAT" }
    */
   data?: DsgUserGroupQueryListResponseBodyPageDataData[];
   /**
@@ -112,7 +119,7 @@ export class DsgUserGroupQueryListResponseBodyPageData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of user groups.
+   * The total number of returned user groups.
    * 
    * @example
    * 100
@@ -175,12 +182,12 @@ export class DsgUserGroupQueryListResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The paginated query results.
+   * The paginated query result.
    */
   pageData?: DsgUserGroupQueryListResponseBodyPageData;
   /**
    * @remarks
-   * The request ID.
+   * The request ID. You can use the ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 102400001
@@ -188,11 +195,9 @@ export class DsgUserGroupQueryListResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * - `true`: The request was successful.
-   * 
-   * - `false`: The request failed.
+   * Indicates whether the call is successful. Valid values:
+   * - true: The call is successful.
+   * - false: The call fails.
    * 
    * @example
    * true

package/src/models/DsgUserGroupQueryUserListResponseBody.ts

@@ -32,7 +32,7 @@ export class DsgUserGroupQueryUserListResponseBodyData extends $dara.Model {
   baseId?: string;
   /**
    * @remarks
-   * The parent user ID. This parameter is required if a RAM user is used.
+   * The parent user ID. This parameter applies to RAM users.
    * 
    * @example
    * 123
@@ -117,8 +117,11 @@ export class DsgUserGroupQueryUserListResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * 
+   * 
+   * 
+   * - true: successful
+   * - false: failed
    * 
    * @example
    * true