All Products
Search
Document Center

DataWorks:DsgDesensPlanDelete

Last Updated:Oct 17, 2024

Deletes a data masking rule created in Data Security Guard.

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
IdsarrayYes

A collection of data masking rules.

integerYes

The ID of the data masking rule. You can call the DsgDesensPlanQueryList operation to query the ID of the data masking rule.

123
SceneCodestringYes

The code of the level-1 data masking scenario to which the rule 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)
  • hologres_display_desense_code: data masking at the Hologres compute engine layer
  • dataworks_data_integration_desense_code: static data masking in Data Integration
  • dataworks_analysis_desense_code: masking of displayed data in DataAnalysis
dataworks_display_desense_code

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. Valid values:

  • true: The operation is successful.
  • false: The operation fails.
true
RequestIdstring

The request ID. You can locate logs and troubleshoot issues based on the ID.

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
400PARAMS.ERRORparam error.-
400DESENSPLAN.DATATYPE.ERRORSensitive type already has a desensitization rule.Desensitization rules have been configured for sensitive types.
400DESENSPLAN.DATATYPENOTEXIST.ERRORSensitive type not exist.The sensitive type does not exist.
400DESENSPLAN.ID.ERRORDesensitization rule ID does not exist.The desensitization rule ID does not exist.
400DESENSPLAN.PAGESIZE.ERRORPage size is too large, maximum of 100.Page size limit, up to 100
400DESENSPLAN.PARAM.ERRORDesensitization rule parameter error.The desensitization rule parameter is incorrect.
400DESENSPLAN.SCENECODE.ERRORScene code does not exist.Scene code does not exist
400DESENSPLAN.SCENEID.ERRORScene ID does not exist.Scene ID does not exist.
400DESENSPLAN.SCENEIDLEVEL.ERRORThe scene is not a secondary scene.The scene is not a secondary scene.
400DESENSPLAN.SIZE.ERRORThe number of desens plan exceeds the limit.The number of desensitization rules exceeded the limit.
403PERMISSION.DENIED.ERRORPermission deniedInsufficient permissions.
500UNKNOWN.ERRORunknown error.Unknown error.

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