DsgQueryDefaultTemplates - DataWorks - Alibaba Cloud Documentation Center

Queries a list of available sensitive field type templates and the data masking rules supported by the templates. You can refer to the response parameters of this operation to configure a data masking rule.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:QueryDefaultTemplates	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
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

Response parameters

Parameter	Type	Description	Example
	object	OpenApiResultModel<List>
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
Data	array<object>	The data returned.
Data	object
DataType	string	The sensitive field type.	phone
DesensPlanTemplate	object	The supported data masking methods and parameter descriptions.
	array<object>	The information about the data masking method and parameters.
Item	object
Name	string	The name of the data masking method.	hash
SupportWaterMark	boolean	Indicates whether a watermark is added. Valid values: true: allow false: disallow	true
ExtParamTemplate	array	The data masking parameters and their descriptions.
ExtParamTemplate	any	The supported data masking rules and related parameter configurations, which are in the JSON format. The returned results are used to describe the parameters of a data masking rule. You cannot use the results as input parameters to create or modify a data masking rule.	{ "key": "algo", "valueEnum": [ "MD5", "SHA256", "SHA512", "SM3" ], "valueType": "string" }, { "key": "salt", "valueEnum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "valueType": "int" }
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,
  "Data": [
    {
      "DataType": "phone",
      "DesensPlanTemplate": {
        "key": [
          {
            "Name": "hash",
            "SupportWaterMark": true,
            "ExtParamTemplate": [
              "{                     \"key\": \"algo\",                     \"valueEnum\": [                         \"MD5\",                         \"SHA256\",                         \"SHA512\",                         \"SM3\"                     ],                     \"valueType\": \"string\"                 },                 {                     \"key\": \"salt\",                     \"valueEnum\": [                         1,                         2,                         3,                         4,                         5,                         6,                         7,                         8,                         9                     ],                     \"valueType\": \"int\"                 }"
            ]
          }
        ]
      }
    }
  ],
  "RequestId": "102400001"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DESENSTEMPLATE.SCENE.ERROR	Scene ID does not exist.	Scene ID does not exist.
400	DESENSTEMPLATE.SCENELEVEL.ERROR	The scene is not a secondary scene.	The scene is not a secondary scene.
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.