DsgDesensPlanQueryList - DataWorks - Alibaba Cloud Documentation Center

Queries a list of data masking rules.

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
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page. Maximum value: 100.	10
SceneId	integer	Yes	The ID of the level-2 data masking scenario. You can call the DsgSceneQuerySceneListByName operation to query the list of IDs.	123
RuleName	string	No	The name of the sensitive field.	phone
Owner	string	No	The owner of the data masking rule.	user1
Status	integer	No	The status of the data masking rule. Valid values: 0: expired 1: effective	1

Response parameters

Parameter	Type	Description	Example
	object	OpenApiResultModel<PagingResultModel>
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
PageData	object	The pagination information.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Maximum value: 100.	10
TotalCount	integer	The number of data masking rules.	100
Data	array<object>	The information about the data masking rule.
Datas	object
Id	long	The ID of the data masking rule.	123
DataType	string	The sensitive field type.	phone
RuleName	string	The name of the data masking rule.	phone_hash
DesensPlan	object	The details of the data masking rule.
DesensPlanType	string	The type of the data masking rule.	hash
ExtParam	object	The parameters for the data masking rule. For more information about the parameters, see the DsgDesensPlanAddOrUpdate API reference.
	any	The details of the data masking rule parameters.	"extParam": { "algo":"MD5", "salt":"5" }
Owner	string	The owner of the data masking rule.	user1
GmtCreate	string	The time when the data masking rule was created.	2024-05-09 15:46:20
GmtModified	string	The time when the data masking rule was modified.	2024-05-09 15:46:20
Status	integer	The status of the data masking rule. Valid values: 0: expired 1: effective	1
DesensWay	string	The data masking method.	HASH
DesenMode	string	The type of the data masking method.	HASH
DesensRule	string	The data masking rule.	HASH
SceneCode	string	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
CheckWatermark	boolean	Indicates whether a watermark is added. Valid values: true false	true
SceneName	string	The name of the level-2 data masking scenario to which the data masking rule belongs.	test_scene
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,
  "PageData": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Data": [
      {
        "Id": 123,
        "DataType": "phone",
        "RuleName": "phone_hash",
        "DesensPlan": {
          "DesensPlanType": "hash",
          "ExtParam": {
            "key": "\"extParam\": {             \"algo\":\"MD5\",             \"salt\":\"5\"           }"
          }
        },
        "Owner": "user1",
        "GmtCreate": "2024-05-09 15:46:20",
        "GmtModified": "2024-05-09 15:46:20",
        "Status": 1,
        "DesensWay": "HASH",
        "DesenMode": "HASH",
        "DesensRule": "HASH",
        "SceneCode": "dataworks_display_desense_code",
        "CheckWatermark": true,
        "SceneName": "test_scene"
      }
    ]
  },
  "RequestId": "102400001"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.	Desensitization rules have been configured for sensitive types.
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	The sensitive type does not exist.
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.	The desensitization rule ID does not exist.
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.	Page size limit, up to 100
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	The desensitization rule parameter is incorrect.
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.	Scene code does not exist
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.	Scene ID does not exist.
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.	The scene is not a secondary scene.
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	The number of desensitization rules exceeded the limit.
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.