DsgQueryDefaultTemplates - 查询可选择的敏感类型模版列表及详情 - 大数据开发治理平台 DataWorks

调用DsgQueryDefaultTemplates接口，查询可选择的敏感类型模版列表及该模版支持的脱敏规则。您可参考该接口的返回参数配置脱敏规则。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:QueryDefaultTemplates	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
SceneId	integer	是	二级脱敏场景 ID。您可调用 DsgSceneQuerySceneListByName 接口获取。	123

返回参数

名称	类型	描述	示例值
	object	OpenApiResultModel<List>
Success	boolean	调用是否成功。取值如下： true：调用成功。 false：调用失败。	true
ErrorCode	string	错误码。	1029030003
ErrorMessage	string	错误信息。	param error
HttpStatusCode	integer	HTTP 状态码。	400
Data	array<object>	返回数据。
Data	object	返回数据。
DataType	string	敏感字段类型。	phone
DesensPlanTemplate	object	支持的脱敏方式及参数说明列表。
	array<object>	脱敏方式及参数信息。
Item	object	脱敏方式及参数信息。
Name	string	脱敏方式名称。	hash
SupportWaterMark	boolean	是否允许添加水印。取值如下： true：允许。 false：不允许。	true
ExtParamTemplate	array	脱敏参数及其说明列表。
ExtParamTemplate	any	支持的脱敏规则及相关参数配置参考，Json 格式。该返回结果仅作为脱敏规则相关参数的解释说明，不能够直接作为用于创建或编辑脱敏规则的输入参数使用。	{ "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	请求的 ID。用于定位日志，排查问题。	102400001

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	DESENSTEMPLATE.SCENE.ERROR	Scene ID does not exist.	场景ID不存在。
400	DESENSTEMPLATE.SCENELEVEL.ERROR	The scene is not a secondary scene.	场景不是二级场景。
400	PARAMS.ERROR	param error.	参数错误。
403	PERMISSION.DENIED.ERROR	Permission denied	权限不足。
500	UNKNOWN.ERROR	unknown error.	未知错误。

访问错误中心查看更多错误码。