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

DataWorks:AddRecognizeRule

最終更新日:Mar 21, 2026

データセキュリティガードにおけるデータのカテゴリおよび感度レベルに基づき、カスタムの機密フィールドを追加します。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:AddRecognizeRule

create

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

TenantId

string

必須

テナント ID。テナント ID を取得するには、以下の手順を実行します:まず、DataWorks コンソール にログインします。次に、ご利用のワークスペースを見つけ、DataStudio ページに移動します。DataStudio ページの右上隅にあるログインユーザー名をクリックし、「メニュー」セクションから「ユーザー情報」を選択します。

10241024

AccountName

string

必須

機密データ識別ルールを作成する Alibaba Cloud アカウント。Alibaba Cloud アカウントのユーザー名を入力します。

dsg-uat

SensitiveName

string

必須

カスタム機密フィールドの名称。128 文字未満の文字列を入力します。

name

TemplateId

string

必須

テンプレート ID。テンプレート ID を取得するには、QueryDefaultTemplate 操作を呼び出します。

e1970541-6cf5-4d23-b101-d5b66f6e1024

NodeId

string

必須

データカテゴリの ID。すべてのデータカテゴリ ID を照会するには、QuerySensClassification 操作を呼び出します。その後、目的のデータカテゴリを選択して機密フィールドを作成できます。選択したデータカテゴリの ID を入力します。

0ce67949-0810-400f-a24a-cc5ffafe1024

NodeParent

string

必須

現在のデータカテゴリの親データカテゴリに関する情報。データカテゴリの ID を取得するには、QuerySensClassification 操作を呼び出します。

Customer/personal/personal_Natural _Information/personal basic_profile_information

Level

string

必須

機密フィールドの感度レベル。テンプレートで定義されたすべての感度レベル(例:レベル 1 ~ レベル 10)から、機密フィールドの感度レベルとして 1 つを選択します。

1

LevelName

string

任意

感度レベルの名称。関連するテンプレートにおける感度レベルの名称を取得するには、QueryDefaultTemplate 操作を呼び出します。

Confidential

SensitiveDescription

string

任意

機密フィールドの説明。128 文字未満の文字列を入力します。

This is a sensitive field that identifies the name.

OperationType

integer

必須

算術演算の種類。有効な値は以下のとおりです:

  • 0:OR

  • 1:AND

0

RecognizeRulesType

string

任意

機密データ識別ルールの種類。有効な値は以下のとおりです:

  • 1:正規表現

  • 2:組み込みルール

  • 3:サンプルライブラリ

  • 4:独自生成のデータ識別モデル

1

RecognizeRules

string

任意

機密データ識別ルールの内容。組み込み機密フィールドの現在のパラメーター値を照会するには、QuerySensNodeInfo 操作を呼び出します。

{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}

ContentScan

string

任意

コンテンツを識別します。組み込み機密フィールドの現在のパラメーター値を照会するには、QuerySensNodeInfo 操作を呼び出します。

{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}

HitThreshold

integer

任意

ヒット率のしきい値。サンプルデータレコードのうち、60 %(サンプルヒット率のしきい値)以上が名前エンティティ認識(NER)モデルにヒットした場合、当該機密フィールドはヒットしたものと見なされます。値は 0 ~ 100 の整数です。

50

ColScan

string

任意

フィールドをスキャンします。システムでは、値が割り当てられたフィールドのみを識別します。

  • 値は、`${プロジェクト名}.${テーブル名}.${フィールド名}` または `${プロジェクト名}.${スキーマ名}.${テーブル名}.${フィールド名}` の形式である必要があります。

  • ワイルドカードが使用可能です。たとえば、`default.table.column1*` のアスタリスク(*)は、`default.table.column10` のように `default.table.column1` に続く任意の文字列とマッチします。

default.qujian.*

ColExclude

string

任意

フィールドを除外します。システムでは、値が割り当てられたフィールドは識別されません。

  • 値は、`${プロジェクト名}.${テーブル名}.${フィールド名}` または `${プロジェクト名}.${スキーマ名}.${テーブル名}.${フィールド名}` の形式である必要があります。

  • ワイルドカードが使用可能です。たとえば、`default.table.column1*` のアスタリスク(*)は、`default.table.column10` のように `default.table.column1` に続く任意の文字列とマッチします。

default.qujian.*6

CommentScan

string

任意

コンテンツをスキャンします。値は、データ資産内の各フィールドコメントのテキストです。あいまい検索がサポートされています。

test

Status

integer

任意

機密フィールドのステータス。有効な値は以下のとおりです:

  • 0:下書き

  • 1:有効

0

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスパラメーター。

Success

boolean

リクエストが成功したかどうかを示します。

  • true

  • false

true

ErrorCode

string

エラーコード。

9990030003

ErrorMessage

string

エラーメッセージ。

Missing parameter

HttpStatusCode

integer

HTTP ステータスコード。

200

Data

any

JSON 形式で返される結果。

{ "HttpStatusCode": 200, "Success": true }

RequestId

string

リクエスト ID。

10000001

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "ErrorCode": "9990030003",
  "ErrorMessage": "Missing parameter",
  "HttpStatusCode": 200,
  "Data": "{   \"HttpStatusCode\": 200,   \"Success\": true }",
  "RequestId": "10000001"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 BADPARAMETERS Parameters are missing or in the wrong format.

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

変更履歴

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