DsgQueryDefaultTemplates API for Sensitive Data Desensitization - DataWorks

Retrieves available Sensitive Data Type Templates and the Desensitization Rules they support. Use the response from this API to configure your Desensitization 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:QueryDefaultTemplates

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SceneId	integer	Yes	The ID of the Level-2 Desensitization Scene. Call the DsgSceneQuerySceneListByName API to obtain this ID.	123

Response elements

Element	Type	Description	Example
	object	The response data.
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 returned if the request fails.	1029030003
ErrorMessage	string	The error message returned if the request fails.	param error
HttpStatusCode	integer	The HTTP status code returned.	400
Data	array<object>	The data returned.
	array<object>	An object representing a Sensitive Data Type Template.
DataType	string	The Sensitive Data Type.	phone
DesensPlanTemplate	object	A list of supported Desensitization Methods and their parameter descriptions.
	array<object>	The Desensitization Method and its parameters.
	object	The Desensitization Method and its parameters.
Name	string	The name of the Desensitization Method.	hash
SupportWaterMark	boolean	Indicates whether watermarking is supported. Valid values: true: Watermarking is supported. false: Watermarking is not supported.	true
ExtParamTemplate	array	A list of Desensitization Parameters and their descriptions.
	any	A JSON object that describes the supported Desensitization Rules and their parameter configurations. This object is for reference only and cannot be used as direct input to create or modify Desensitization Rules.	{ "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 this ID to troubleshoot issues.	102400001

Examples

Success response

JSON format

{
  "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.
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.