All Products
Search
Document Center

:DsgDesensPlanDelete

最終更新日:Jun 05, 2024

Deletes a data masking rule created in Data Security Guard.

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

DsgDesensPlanDelete

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

Ids

Array of Integer

Yes

123

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

SceneCode

String

Yes

dataworks_display_desense_code

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

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

  • true: The operation is successful.

  • false: The operation failed.

RequestId

String

102400001

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=DsgDesensPlanDelete
&Ids=[123]
&SceneCode=dataworks_display_desense_code
&<Common request parameters>

Sample success responses

XML format

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

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

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

PARAMS.ERROR

param error.

The values specified for one or more parameters are invalid.

400

DESENSPLAN.DATATYPE.ERROR

Sensitive type already has a desensitization rule.

The sensitive field type has been specified in the data masking rule.

400

DESENSPLAN.DATATYPENOTEXIST.ERROR

Sensitive type not exist.

The sensitive field type does not exist.

400

DESENSPLAN.ID.ERROR

Desensitization rule ID does not exist.

The ID of the data masking rule does not exist.

400

DESENSPLAN.PAGESIZE.ERROR

Page size is too large, maximum of 100.

The number of entries per page exceeds the upper limit. The maximum number of entries per page is 100.

400

DESENSPLAN.PARAM.ERROR

Desensitization rule parameter error.

The values specified for one or more data masking rule parameters are invalid.

400

DESENSPLAN.SCENECODE.ERROR

Scene code does not exist.

The scenario code does not exist.

400

DESENSPLAN.SCENEID.ERROR

Scene ID does not exist.

The scenario ID does not exist.

400

DESENSPLAN.SCENEIDLEVEL.ERROR

The scene is not a secondary scene.

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

400

DESENSPLAN.SIZE.ERROR

The number of desens plan exceeds the limit.

The number of data masking rules exceeds the upper limit.

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.