DataWorks データマップにデータリネージ関係を登録します。この操作を使用して、DataWorks が管理するメタデータエンティティ間のリネージ関係を確立できます。テーブル間、カラム間、テーブルとカラム間、データセットとテーブル間のシナリオに対応しています。また、管理対象エンティティとユーザーが登録したカスタムエンティティオブジェクト間のリネージ関係も確立できます。この操作は非管理カスタムオブジェクトと互換性がありますが、このアプローチは推奨されなくなりました。この操作を呼び出す前に、リネージ登録に関連する管理対象エンティティが DataWorks プラットフォーム上に既に存在していることを確認してください。
操作説明
DataWorks Professional Edition 以上のエディションが必須です。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| SrcEntity | LineageEntity |
任意 |
ソースエンティティ。 |
|
| DstEntity | LineageEntity |
任意 |
送信先エンティティ。 |
|
| Task | LineageTask |
任意 |
タスク情報。 |
エンティティオブジェクト (SrcEntity / DstEntity)
リネージ関係のソースと送信先を記述します。以下のタイプのエンティティ間でリネージ関係を登録できます:
| エンティティタイプ | 事前登録の必須/任意 | ID の取得方法 | 説明 |
| DataWorks 収集済みテーブル | 不要 | ListTables または GetTable を呼び出し、応答の Id を使用します。 | DataWorks プラットフォームで既に収集されたテーブル、またはユーザーが登録した拡張テーブルに適用されます。 |
| DataWorks 収集済みカラム | 不要 | ListColumns または GetColumn を呼び出し、応答の Id を使用します。 | 収集済みテーブルに対応するカラムです。 |
| データセット | データセットが既に存在する場合は不要。データセットを作成するには、先に CreateDataset を呼び出します。 | CreateDataset、ListDatasets、または GetDataset を呼び出し、応答の Id を使用します。 | DataWorks データセットエンティティに適用されます。 |
| データセットバージョン | バージョンが既に存在する場合は不要。バージョンを作成するには、先に CreateDatasetVersion を呼び出します。 | CreateDatasetVersion、ListDatasetVersions、または GetDatasetVersion を呼び出し、応答の Id を使用します。 | データセットの特定のバージョンに適用されます。 |
| ユーザー登録カスタムエンティティオブジェクト | 必須 | CreateMetaEntityDef を呼び出してカスタムエンティティ定義を作成し、次に BatchCreateMetaEntities を呼び出してエンティティオブジェクトを作成し、応答の Id を使用します。 | DataWorks で管理および照会する必要があるカスタムエンティティに適用されます。 |
| 非管理カスタムオブジェクト (非推奨) | 不要 | 呼び出し元が custom- プレフィックス付きの Id を custom-{Type}:{Identifier} の形式で指定します。 | レガシー使用との互換性のために維持されていますが、推奨されなくなりました。外部レポート、サードパーティシステムオブジェクト、その他のカスタムオブジェクトについては、先に DataWorks カスタムエンティティオブジェクトとして登録してからリネージを登録してください。 |
補足事項:
DataWorks で既に収集されたテーブル、カラム、データセット、データセットバージョンについては、
Idを手動で構築しないでください。対応するGetまたはListAPI から返されるIdを使用してください。- カスタムオブジェクトについては、ユーザー登録カスタムエンティティオブジェクトのアプローチを使用してください。先にエンティティ定義とエンティティオブジェクトの登録を完了してください:
CreateMetaEntityDefを呼び出してカスタムエンティティ定義を作成します。BatchCreateMetaEntitiesを呼び出して特定のエンティティオブジェクトを作成します。BatchCreateMetaEntitiesから返されるエンティティIdをSrcEntity.IdまたはDstEntity.Idとして使用します。
非管理カスタムオブジェクトの場合、
CreateMetaEntityDefやBatchCreateMetaEntitiesを呼び出す必要はありません。custom-プレフィックス付きのエンティティIdを渡し、Nameを指定するだけです。このアプローチは主にレガシーシナリオとの後方互換性のためであり、推奨されなくなりました。新しい統合には、照会、管理、カスタム属性拡張が容易な登録済みカスタムエンティティオブジェクトのアプローチを使用してください。SrcEntity.AttributesとDstEntity.Attributesはエンティティエンドポイントの拡張属性を表します。リネージ関係自体の属性はTask.Attributesに配置してください。
タスク情報 (Task)
リネージ関係を生成するジョブまたはタスクを記述します。
| パラメーター | タイプ | 必須 | 説明 |
| Id | String | いいえ | タスクの一意の識別子。冪等な登録、照会、削除のために安定した値を渡すことを推奨します。英字、数字、アンダースコアのみがサポートされます。最大長: 64 文字。 |
| Type | String | はい | タスクタイプ。custom- で始まる必要があります。英字、数字、アンダースコア、ハイフンのみがサポートされます。最大長: 64 文字。 |
| Attributes | Map<String,String> | いいえ | タスク属性。最大 20 個の属性がサポートされます。複雑な値は JSON 文字列としてシリアライズする必要があります。 • Key: 属性名 (英字、数字、アンダースコア、64 文字以下)。 • Value: 属性値 (128 文字以下)。 |
リクエスト例。
DataWorks 収集済みテーブルとカスタムエンティティオブジェクト
{
"SrcEntity": {
"Id": "custom_entity-customer_api:api_001",
"Name": "api_001"
},
"DstEntity": {
"Id": "mysql-table:rm-xxx::demo_db::demo_table",
"Name": "demo_table"
},
"Task": {
"Id": "api_to_table_001",
"Type": "custom-lineage-タスク",
"Attributes": {
"scene": "api_to_table",
"owner": "zhangsan"
}
}
}
```。
### 非管理カスタムオブジェクトと DataWorks 収集済みテーブル
> このアプローチは主にレガシー使用との後方互換性のためであり、推奨されなくなりました。新しい統合には、先に `CreateMetaEntityDef` と `BatchCreateMetaEntities` を使用してカスタムエンティティオブジェクトを登録し、返されたエンティティ `Id` を使用してリネージを登録してください。
```json
{
"SrcEntity": {
"Id": "custom-report:report_001",
"Name": "report_001"
},
"DstEntity": {
"Id": "maxcompute-table:::demo_project:default:demo_table",
"Name": "demo_table"
},
"Task": {
"Id": "report_to_table_001",
"Type": "custom-lineage-タスク",
"Attributes": {
"scene": "report_to_table"
}
}
}
```。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答。 |
||
| RequestId |
string |
リクエスト ID。リクエストの一意の識別子です。 |
C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490 |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| Id |
string |
リネージ関係 ID。 |
4as3dasf654a |
例
成功レスポンス
JSONJSON
{
"RequestId": "C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490",
"Success": true,
"Id": "4as3dasf654a"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。