All Products
Search
Document Center

DataWorks:DsgSceneAddOrUpdateScene

Last Updated:Oct 17, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
scenesarray<object>Yes

The information about the level-2 data masking scenario.

objectYes
idstringNo

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
sceneNamestringYes

The name of the level-2 data masking scenario.

dev_scene
sceneCodestringYes

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
projectsarray<object>No

The information about the compute engine for which the data masking scenario takes effect.

objectNo
clusterIdstringNo

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
projectNamestringNo

The name of the compute engine instance for which the data masking scenario takes effect.

dev_project
dbTypestringNo

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
descstringNo

The description.

userGroupIdsarrayNo

The information about the user group for which the data masking scenario takes effect.

longNo

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

ParameterTypeDescriptionExample
object

OpenApiResultModel

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code.

1029030003
ErrorMessagestring

The error message.

param error
HttpStatusCodeinteger

The HTTP status code.

400
Databoolean

The operation result.

true
RequestIdstring

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 codeError codeError messageDescription
400DESENSSCENE.ID.ERRORThe 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.
400DESENSSCENE.IDLEVEL.ERRORThe desensitization scenario is not a secondary scenario.-
400DESENSSCENE.PROJECT.ERRORThe project space does not exist.-
400DESENSSCENE.SIZE.ERRORThe number of desens scene exceeds the limit.Number of desensitization scenarios chao xian
400DESENSSCENE.UESRGROUP.ERRORThe 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.
400PARAMS.ERRORparam error.-
403PERMISSION.DENIED.ERRORPermission deniedInsufficient permissions.
500UNKNOWN.ERRORunknown error.Unknown error.

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