Automate DSG Data Masking Rule Queries with DsgDesensPlanQueryList - DataWorks

Call the DsgDesensPlanQueryList API to query Data Security Guard's (DSG) data masking rules.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:DsgDesensPlanQueryList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries to return on each page. The maximum value is 100.	10
SceneId	integer	Yes	The ID of the Level-2 data desensitization scene. You can call the DsgSceneQuerySceneListByName operation to obtain this ID.	123
RuleName	string	No	The name of the desensitization rule.	phone
Owner	string	No	The owner of the desensitization rule.	user1
Status	integer	No	The status of the desensitization rule. Valid values: 0: Inactive 1: Active	1

Response elements

Element	Type	Description	Example
	object	OpenApiResultModel<PagingResultModel>
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code.	1029030003
ErrorMessage	string	The error message.	param error
HttpStatusCode	integer	The HTTP status code.	400
PageData	object	The paginated data.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Maximum value: 100.	10
TotalCount	integer	The total number of matching desensitization rules.	100
Data	array<object>	The details of the desensitization rules.
	array<object>	A single desensitization rule object.
Id	integer	The ID of the desensitization rule.	123
DataType	string	The sensitive data type.	phone
RuleName	string	The name of the desensitization rule.	phone_hash
DesensPlan	object	The details of the desensitization plan.
DesensPlanType	string	The type of the desensitization plan.	hash
ExtParam	object	The parameters for the desensitization rule. For details, see the DsgDesensPlanAddOrUpdate operation.
	any	The details of the desensitization rule parameters.	"extParam": { "algo":"MD5", "salt":"5" }
Owner	string	The owner of the desensitization rule.	user1
GmtCreate	string	The time when the rule was created.	2024-05-09 15:46:20
GmtModified	string	The time when the rule was last modified.	2024-05-09 15:46:20
Status	integer	The status of the rule. Valid values: 0: Inactive. 1: Active.	1
DesensWay	string	The desensitization method.	HASH
DesenMode	string	The desensitization method.	HASH
DesensRule	string	The desensitization rule.	HASH
SceneCode	string	The level-1 desensitization scene code. Valid values: Desensitization for display in Data Development and Data Map: dataworks_display_desense_code Desensitization at the MaxCompute engine layer: maxcompute_desense_code Desensitization at the MaxCompute engine layer (New): maxcompute_new_desense_code Desensitization at the Hologres engine layer: hologres_display_desense_code Static desensitization in Data Integration: dataworks_data_integration_desense_code Desensitization for display in Data Analysis: dataworks_analysis_desense_code	dataworks_display_desense_code
CheckWatermark	boolean	Indicates whether to add a watermark. Valid values: true: A watermark is added. false: No watermark is added.	true
SceneName	string	The name of the level-2 desensitization scene.	test_scene
emptyNotDesesn	boolean
columns	array<object>
	object
dbType	string
project	string
table	string
column	string
RequestId	string	The request ID. You can use this ID to locate logs and troubleshoot issues.	102400001

Examples

Success response

JSON format

{
  "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",
        "emptyNotDesesn": false,
        "columns": [
          {
            "dbType": "",
            "project": "",
            "table": "",
            "column": ""
          }
        ]
      }
    ]
  },
  "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.
500	UNKNOWN.ERROR	unknown error.	Unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.