すべてのプロダクト
Search
ドキュメントセンター

DataWorks:DsgDesensPlanAddOrUpdate

最終更新日:May 12, 2026

データマスキング (data desensitization) ルールを作成または編集するには、DsgDesensPlanAddOrUpdate API を呼び出します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

DesensRules

array<object>

必須

追加または更新するデータマスキングルールのコレクション。

array<object>

任意

データマスキングルールの設定。

Id

integer

任意

データマスキングルール ID。DsgDesensPlanQueryList API を呼び出して取得できます。

123

DataType

string

任意

機密データのタイプ。

phone

RuleName

string

必須

データマスキングルールの名前。

phone_hash

Status

integer

任意

データマスキングルールのステータス。有効な値:

  • 0:無効

  • 1:有効

1

SceneIds

array

必須

セカンダリデータマスキングシーン。

integer

任意

セカンダリデータマスキングシーンの ID。このシーンには、DataType パラメーターで指定された機密データタイプに対する既存のデータマスキングルールを含めることはできません。シーン ID を確認するには、DsgSceneQuerySceneListByName API を呼び出します。

123

Owner

string

必須

データマスキングルールの所有者。

test_user

CheckWatermark

boolean

任意

ウォーターマークを追加するかどうかを指定します。有効な値:

  • true:ウォーターマークを追加します。

  • false:ウォーターマークを追加しません。

true

DesensPlan

object

必須

データマスキングメソッドの設定。

DesensPlanType

string

必須

データマスキングメソッド。有効な値:

  • hash:ハッシュ化

  • mapping:仮名化

  • mask:マスキング

  • charreplacement:文字置換

  • intervalselect:区間変換

  • decimalpoint:丸め

  • emptydesens:Null 化

hash

ExtParam

object

任意

データマスキングメソッドのパラメーター。

any

任意

選択したデータマスキングメソッドのパラメーター。必要なパラメーターは、DesensPlanType パラメーターの値によって異なります。詳細については、「リクエスト例」をご参照ください。

{ "algo": "MD5", "salt":6 }

emptyNotDesens

boolean

任意

空の値をマスキングの対象外とするかどうかを指定します。有効な値:

  • true:空の値はマスキングされません。

  • false:空の値もマスキングされます。

columns

array<object>

任意

マスキング対象の列。

object

任意

dbType

string

必須

データソースのタイプ。

ODPS.ODPS

project

string

必須

DataWorks ワークスペースの名前。

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 // point パラメータは、丸める桁数を指定します。
}
ヌル化:
{}

サポートされている非識別化方式とルールの詳細については、DsgQueryDefaultTemplates API をご参照ください。

レスポンスフィールド

フィールド

型

説明

例

object

OpenApiResultModel

Success

boolean

リクエストが成功したかどうかを示します。 true はリクエストの成功を、false はリクエストの失敗を示します。

true

ErrorCode

string

エラーコード。

1029030003

ErrorMessage

string

エラーメッセージ。

param error

HttpStatusCode

integer

HTTP ステータスコード。

400

Data

boolean

追加または更新操作が成功したかどうかを示します。

true

RequestId

string

リクエスト ID。この ID を使用してログをトレースし、問題をトラブルシューティングできます。

102400001

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

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.
400 DESENSPLAN.PAGESIZE.ERROR Page size is too large, maximum of 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.
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

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。