調用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>	返回資料。
	array<object>	返回資料。
DataType	string	敏感欄位類型。	phone
DesensPlanTemplate	object	支援的脫敏方式及參數說明列表。
	array<object>	脫敏方式及參數資訊。
	object	脫敏方式及參數資訊。
Name	string	脫敏方式名稱。	hash
SupportWaterMark	boolean	是否允許添加浮水印。取值如下： true：允許。 false：不允許。	true
ExtParamTemplate	array	脫敏參數及其說明列表。
	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.	參數錯誤。
500	UNKNOWN.ERROR	unknown error.	未知錯誤。
403	PERMISSION.DENIED.ERROR	Permission denied	許可權不足。

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

變更歷史

更多資訊，參考變更詳情。