DataWorks へ、ユーザーが独自に管理するエンティティ間の系統(ライネージ)を登録します。
操作説明
本 API は現在ベータ版です。ご利用を希望される場合は、事前申請を行い、管理者によるベータ利用者リストへの登録が完了した後に呼び出しが可能になります。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| LineageRelationRegisterVO | LineageRelationRegisterVO |
必須 |
DataWorks へ系統登録を行う対象の構造です。 |
エンティティの固有識別子形式:EntityType.EntityGuid
1:EntityType — エンティティの種類を示す識別子
1.1 DataWorks で既に定義済みのエンティティ種類
(1) MaxCompute テーブル:maxcompute-table
(2) MySQL テーブル:mysql-table
(3) EMR テーブル:emr-table
(4) Hologres テーブル:holodb-table
1.2 ユーザーが独自に定義するエンティティ種類:custom-xxx
業務要件に応じて、以下の種類の使用を推奨します。
(1) テーブル:custom-table
(2) API:custom-api
(3) アプリケーション:custom-app
(4) レポート:custom-report
(5) データセット:custom-dataset
(6) データソース:custom-datasource
2:EntityGuid — 同一エンティティ種類内で、当該エンティティを一意に識別する識別子
ユーザーが独自に定義するエンティティについては、任意のユニーク ID を設定できます。
3:エンティティの例:
3.1:DataWorks で事前に定義済みのシステムエンティティ(データマップの血縁図から確認可能)
(1) maxcompute-table.project.tableName — MaxCompute テーブルの固有 ID
(2) emr-table.kadfdfaccdd4ted — EMR テーブルの固有 ID
3.2:ユーザーが独自に定義したエンティティ:業務要件に応じて任意の固有 ID を定義(最大 50 バイト)
(1) custom-api.listUser — カスタム API エンティティ(固有識別子:listUser)
(2) custom-table.db1.table2 — カスタムテーブルエンティティ(固有識別子:db1.table2)
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
OpenApiMetaResultModel |
||
| HttpStatusCode |
integer |
HTTP ステータスコードです。 |
200 |
| ErrorMessage |
string |
エラーメッセージです。 |
The entity of lineage not exist, xxx |
| RequestId |
string |
リクエスト ID です。この ID を使用してログを特定し、問題のトラブルシューティングを行えます。 |
EE50E05E-028C-182B-**** |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値は次のとおりです。
|
true |
| ErrorCode |
string |
エラーコードです。 |
1010210001 |
| LineageRelation |
object |
系統情報です。 |
|
| SrcEntityQualifiedName |
string |
送信元エンティティの固有識別子です。 |
maxcompute-table.project.table |
| DestEntityQualifiedName |
string |
送信先エンティティの固有識別子です。 |
custom-report.month_stat_user |
| RelationshipGuid |
string |
エンティティ間の系統を識別する ID です。 |
dfsldfdlsfdsaaaabbbb |
例
成功レスポンス
JSONJSON
{
"HttpStatusCode": 200,
"ErrorMessage": "The entity of lineage not exist, xxx",
"RequestId": "EE50E05E-028C-182B-****",
"Success": true,
"ErrorCode": "1010210001",
"LineageRelation": {
"SrcEntityQualifiedName": "maxcompute-table.project.table",
"DestEntityQualifiedName": "custom-report.month_stat_user",
"RelationshipGuid": "dfsldfdlsfdsaaaabbbb"
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。