使用DsgDesensPlanAddOrUpdate API建立或編輯資料脫敏規則-巨量資料開發治理平台 DataWorks-阿里雲 - DataWorks

調用DsgDesensPlanAddOrUpdate介面建立或編輯資料脫敏規則。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
DesensRules	array<object>	是	需要新增或編輯的脫敏規則集合。
	array<object>	否	脫敏規則資訊。
Id	integer	否	脫敏規則 ID。您可調用 DsgDesensPlanQueryList 介面查詢。	123
DataType	string	否	敏感欄位類型。	phone
RuleName	string	是	脫敏規則名稱。	phone_hash
Status	integer	否	脫敏規則的生效狀態。取值如下： 0：失效。 1：生效。	1
SceneIds	array	是	二級脫敏情境。
	integer	否	二級脫敏情境 ID。此處輸入的二級脫敏情境需要未配置 DataType 參數指定的敏感欄位類型脫敏規則。您可調用 DsgSceneQuerySceneListByName 查詢脫敏情境 ID。	123
Owner	string	是	脫敏規則的負責人。	test_user
CheckWatermark	boolean	否	是否添加浮水印。取值如下： true：是 false：否	true
DesensPlan	object	是	脫敏規則。
DesensPlanType	string	是	脫敏規則中配置的脫敏方式。取值如下：雜湊：hash 假名：mapping 掩蓋：mask 字元替換：charreplacement 區間變換：intervalselect 取整：decimalpoint 置空：emptydesens	hash
ExtParam	object	否	脫敏規則參數。
	any	否	脫敏規則參數配置，根據您要配置的脫敏規則添加不同參數，具體內容請參見下文樣本。	{ "algo": "MD5", "salt":6 }
emptyNotDesens	boolean	否
columns	array<object>	否	脫敏關聯列列表
	object	否
dbType	string	是	資料來源類型	ODPS.ODPS
project	string	是	專案空間名稱	test_dev
table	string	是	表名	test_table_dev
column	string	是	列名	test_col_dev

ExtParam 為動態參數，對於不同脫敏規則配置不同，參考樣本如下：

雜湊：
{
    "algo": "MD5",
    "salt": 6
}
假名：
{
    "charset": "Aa",
    "salt": 6
}
掩蓋：
{
    "before": 3,
    "after": 4
}
自訂掩蓋：
{
    "separatorList": [
        {
            "desens": true,
            "left": 3
        },
        {
            "desens": false,
            "left": 6
        },
        {
            "desens": true,
            "left": -99
        }
    ]
}
樣本值字元替換：
{
    "library": "test_library",
    "position": 3
}
固定值字元替換：
{
    "replace": "repData",
    "position": 3
}
隨機字元替換：
{
    "replace": "repData"
}
自訂字元替換：
{
    "separatorList": [
        {
            "desensParam": {
                "replace": "repData"
            },
            "left": 3
        },
        {
            "desensParam": {
                "library": "test_library"
            },
            "left": 6
        },
        {
            "desensParam": {
            },
            "left": 99
        }
    ]
}
區間變換：
{
    "intervalselects": [
        {
            "desens": "1",
            "interval": [
                "1",
                "100"
            ]
        }
    ]
}
取整：
{
"point":3
}
置空：
{}

具體支援的脫敏方式及相關規則，可參考 DsgQueryDefaultTemplates 介面查詢。

返回參數

名稱	類型	描述	樣本值
	object	OpenApiResultModel
Success	boolean	調用是否成功。取值如下： true：調用成功。 false：調用失敗。	true
ErrorCode	string	錯誤碼。	1029030003
ErrorMessage	string	錯誤資訊。	param error
HttpStatusCode	integer	HTTP 狀態代碼。	400
Data	boolean	新增或編輯的執行結果。	true
RequestId	string	請求的 ID。用於定位日誌，排查問題。	102400001

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": true,
  "RequestId": "102400001"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	PARAMS.ERROR	param error.	參數錯誤。
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.	敏感類型已經配置脫敏規則。
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	敏感類型不存在。
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.	脫敏規則ID不存在。
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.	頁大小超限，最大為100。
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	脫敏規則參數錯誤。
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.	情境碼不存在。
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.	情境ID不存在。
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.	情境不是二級情境。
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	脫敏規則數量超限。
500	UNKNOWN.ERROR	unknown error.	未知錯誤。
403	PERMISSION.DENIED.ERROR	Permission denied	許可權不足。

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

變更歷史

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