DsgQueryDefaultTemplates -

調用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.	未知錯誤。

訪問錯誤中心查看更多錯誤碼。