全部产品
Search
文档中心

:DsgQueryDefaultTemplates

更新时间:May 17, 2024

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DsgQueryDefaultTemplates

系统规定参数。取值:DsgQueryDefaultTemplates

SceneId Integer 123

二级脱敏场景ID。您可调用DsgSceneQuerySceneListByName接口获取。

返回数据

名称

类型

示例值

描述

Success Boolean true

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。
ErrorCode String 1029030003

错误码。

ErrorMessage String param error

错误信息。

HttpStatusCode Integer 400

HTTP状态码。

Data Array of Data

返回数据。

DataType String phone

敏感字段类型。

DesensPlanTemplate Map

支持的脱敏方式及参数说明列表。

Array of Item

脱敏方式及参数信息。

Name String hash

脱敏方式名称。

SupportWaterMark Boolean true

是否允许添加水印。取值如下:

  • true:允许。
  • false:不允许。
ExtParamTemplate Array of Any { "key": "algo", "valueEnum": [ "MD5", "SHA256", "SHA512", "SM3" ], "valueType": "string" }, { "key": "salt", "valueEnum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "valueType": "int" }

支持的脱敏规则及相关参数配置参考,Json格式。

该返回结果仅作为脱敏规则相关参数的解释说明,不能够直接作为用于创建或编辑脱敏规则的输入参数使用。

RequestId String 102400001

请求的ID。用于定位日志,排查问题。

示例

请求示例

http(s)://[Endpoint]/?Action=DsgQueryDefaultTemplates
&SceneId=123
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DsgQueryDefaultTemplatesResponse>
    <Success>true</Success>
    <ErrorCode>1029030003</ErrorCode>
    <ErrorMessage>param error</ErrorMessage>
    <HttpStatusCode>400</HttpStatusCode>
    <Data>
        <DataType>phone</DataType>
        <DesensPlanTemplate>
            <Name>hash</Name>
            <SupportWaterMark>true</SupportWaterMark>
            <ExtParamTemplate>{                     "key": "algo",                     "valueEnum": [                         "MD5",                         "SHA256",                         "SHA512",                         "SM3"                     ],                     "valueType": "string"                 },                 {                     "key": "salt",                     "valueEnum": [                         1,                         2,                         3,                         4,                         5,                         6,                         7,                         8,                         9                     ],                     "valueType": "int"                 }</ExtParamTemplate>
        </DesensPlanTemplate>
    </Data>
    <RequestId>102400001</RequestId>
</DsgQueryDefaultTemplatesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "ErrorCode" : "1029030003",
  "ErrorMessage" : "param error",
  "HttpStatusCode" : 400,
  "Data" : [ {
    "DataType" : "phone",
    "DesensPlanTemplate" : [ {
      "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"
}

错误码

HttpCode

错误码

错误信息

描述

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. 未知错误。

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