DsgSceneAddOrUpdateScene - DataWorks - Alibaba Cloud Documentation Center

Adds or modifies a level-2 data masking scenario.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
scenes	array<object>	Yes	The information about the level-2 data masking scenario.
	object	Yes	The information about the level-2 data masking scenario.
id	string	No	The ID of the level-2 data masking scenario. If you do not configure this parameter, the current operation is to add a level-2 data masking scenario. If you configure this parameter, the current operation is to modify a level-2 data masking scenario. You can call the DsgSceneQuerySceneListByName operation to query the ID of the level-2 data masking scenario.	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	If the data masking scenario takes effect for an E-MapReduce (EMR) compute engine, enter the ID of an EMR cluster. This parameter is required only when you use an 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.
	long	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 parameters

Parameter	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 the ID to locate logs and troubleshoot issues.	102400001

Examples

Sample success responses

JSONformat

{
  "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.	-
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.
500	UNKNOWN.ERROR	unknown error.	Unknown error.

For a list of error codes, visit the Service error codes.