DsgSceneAddOrUpdateScene-DataWorks(DataWorks)-阿里云帮助中心

Adds or modifies a level-2 data masking scenario.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:DsgSceneAddOrUpdateScene

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
scenes	array<object>	Yes	The information about the level-2 data masking scenario.
	array<object>	No	The information about the level-2 data masking scenario.
id	string	No	The ID of the level-2 data masking scenario. If this parameter is not specified, a level-2 data masking scenario is created. If this parameter is specified, the specified level-2 data masking scenario is modified. You can call the DsgSceneQuerySceneListByName operation to query the scenario ID.	123
sceneName	string	Yes	The name of the level-2 data masking scenario.	dev_scene
sceneCode	string	Yes	The code of the level-1 data masking scenario to which the level-2 data masking scenario belongs. Valid values: dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map maxcompute_desense_code: data masking at the MaxCompute compute engine layer maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new) dataworks_analysis_desense_code: masking of displayed data in DataAnalysis	dataworks_display_desense_code
projects	array<object>	No	The information about the compute engine for which the data masking scenario takes effect.
	object	No	The information about the compute engine for which the data masking scenario takes effect.
clusterId	string	No	The ID of an EMR cluster. This parameter is required only when the data masking scenario applies to an E-MapReduce (EMR) compute engine.	c-1234
projectName	string	No	The name of the compute engine instance for which the data masking scenario takes effect.	dev_project
dbType	string	No	The type of the compute engine for which the data masking scenario takes effect. Valid values: ODPS: ODPS.ODPS HOLO: HOLO.POSTGRES EMR: EMR	ODPS.ODPS
desc	string	No	The description.	Test scenarios
userGroupIds	array	No	The information about the user group for which the data masking scenario takes effect.
	integer	No	The ID of the user group for which the data masking scenario takes effect. You can call the DsgUserGroupQueryList operation to query the user group ID.	123

Response elements

Element	Type	Description	Example
	object	OpenApiResultModel
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	1029030003
ErrorMessage	string	The error message.	param error
HttpStatusCode	integer	The HTTP status code.	400
Data	boolean	The operation result.	true
RequestId	string	The request ID. You can use it to locate logs and troubleshoot issues.	102400001

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": true,
  "RequestId": "102400001"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DESENSSCENE.ID.ERROR	The desensitization scenario ID does not match or does not exist with the tenant.	The scenario ID does not exist or does not belong to the tenant.
400	DESENSSCENE.IDLEVEL.ERROR	The desensitization scenario is not a secondary scenario.
400	DESENSSCENE.PROJECT.ERROR	The project space does not exist.
400	DESENSSCENE.SIZE.ERROR	The number of desens scene exceeds the limit.	Number of desensitization scenarios chao xian
400	DESENSSCENE.UESRGROUP.ERROR	The user group ID does not match the tenant or does not exist.	The user group ID does not exist or does not belong to the tenant.
400	PARAMS.ERROR	param error.
500	UNKNOWN.ERROR	unknown error.	Unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.