All Products
Search
Document Center

:DsgSceneAddOrUpdateScene

更新時間:Jun 11, 2024

Adds or modifies a level-2 data masking scenario. Adds or modifies a level-2 data masking scenario.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

DsgSceneAddOrUpdateScene

The operation that you want to perform. Set the value to DsgSceneAddOrUpdateScene.

scenes

Array

Yes

The information about the level-2 data masking scenario.

id

String

No

123

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.

sceneName

String

Yes

dev_scene

The name of the level-2 data masking scenario.

sceneCode

String

Yes

dataworks_display_desense_code

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

projects

Array

No

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

clusterId

String

No

c-1234

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.

projectName

String

No

dev_project

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

dbType

String

No

ODPS.ODPS

The type of the compute engine for which the data masking scenario takes effect. Valid values:

  • ODPS: ODPS.ODPS

  • HOLO: HOLO.POSTGRES

  • EMR: EMR

desc

String

No

Test scenario

The description.

userGroupIds

Array of Long

No

123

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.

Response parameters

Parameter

Type

Example

Description

Success

Boolean

true

Indicates whether the request was successful. Valid values:

  • true

  • false

ErrorCode

String

1029030003

The error code.

ErrorMessage

String

param error

The error message.

HttpStatusCode

Integer

400

The HTTP status code.

Data

Boolean

true

The operation result.

RequestId

String

102400001

The request ID. You can use the ID to locate logs and troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DsgSceneAddOrUpdateScene
&scenes=[{"id":"123","sceneName":"dev_scene","sceneCode":"dataworks_display_desense_code","projects":[{"clusterId":"c-1234","projectName":"dev_project","dbType":"ODPS.ODPS"}],"desc":"Test scenario","userGroupIds":[123]}]
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DsgSceneAddOrUpdateSceneResponse>
    <Success>true</Success>
    <ErrorCode>1029030003</ErrorCode>
    <ErrorMessage>param error</ErrorMessage>
    <HttpStatusCode>400</HttpStatusCode>
    <Data>true</Data>
    <RequestId>102400001</RequestId>
</DsgSceneAddOrUpdateSceneResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode

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.

The data masking scenario is not a level-2 data masking scenario.

400

DESENSSCENE.PROJECT.ERROR

The project space does not exist.

The workspace does not exist.

400

DESENSSCENE.SIZE.ERROR

The number of desens scene exceeds the limit.

The number of data masking scenarios exceeds the upper limit.

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.

The values specified for one or more parameters are invalid.

403

PERMISSION.DENIED.ERROR

Permission denied

You are not authorized to perform this operation.

500

UNKNOWN.ERROR

unknown error.

An unknown error has occurred.

For a list of error codes, see Service error codes.