All Products
Search
Document Center

DataWorks:CreateLineageRelationship

Last Updated:Jun 16, 2026

Mendaftarkan hubungan lineage data di DataWorks Data Map. Anda dapat menggunakan operasi ini untuk membuat hubungan lineage antara entitas metadata yang dikelola oleh DataWorks, termasuk skenario tabel-ke-tabel, kolom-ke-kolom, tabel-ke-kolom, dan dataset-ke-tabel. Anda juga dapat membuat hubungan lineage antara entitas terkelola dan objek entitas kustom yang didaftarkan oleh pengguna. Operasi ini kompatibel dengan objek kustom non-terkelola, tetapi pendekatan ini tidak lagi direkomendasikan. Sebelum memanggil operasi ini, pastikan entitas terkelola yang terlibat dalam pendaftaran lineage sudah ada di platform DataWorks.

Deskripsi operasi

  1. Diperlukan DataWorks Professional Edition atau edisi yang lebih tinggi.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter

Type

Required

Description

Example

SrcEntity LineageEntity

No

Entitas sumber.

DstEntity LineageEntity

No

Entitas tujuan.

Task LineageTask

No

Informasi tugas.

Objek entitas (SrcEntity / DstEntity)

Menjelaskan sumber dan tujuan dari hubungan lineage. Anda dapat mendaftarkan hubungan lineage antara jenis entitas berikut:

Jenis entitasPra-pendaftaran diperlukanCara mendapatkan IDDeskripsi
Tabel yang dikumpulkan DataWorksTidakPanggil ListTables atau GetTable dan gunakan Id dalam respons.Berlaku untuk tabel yang sudah dikumpulkan oleh platform DataWorks atau tabel ekstensi yang didaftarkan oleh pengguna.
Kolom yang dikumpulkan DataWorksTidakPanggil ListColumns atau GetColumn dan gunakan Id dalam respons.Kolom yang sesuai dengan tabel yang dikumpulkan.
DatasetTidak, jika dataset sudah ada. Untuk membuat dataset, panggil CreateDataset terlebih dahulu.Panggil CreateDataset, ListDatasets, atau GetDataset dan gunakan Id dalam respons.Berlaku untuk entitas dataset DataWorks.
Versi datasetTidak, jika versi sudah ada. Untuk membuat versi, panggil CreateDatasetVersion terlebih dahulu.Panggil CreateDatasetVersion, ListDatasetVersions, atau GetDatasetVersion dan gunakan Id dalam respons.Berlaku untuk versi tertentu dari dataset.
Objek entitas kustom yang didaftarkan penggunaYaPanggil CreateMetaEntityDef untuk membuat definisi entitas kustom, lalu panggil BatchCreateMetaEntities untuk membuat objek entitas, dan gunakan Id dalam respons.Berlaku untuk entitas kustom yang perlu dikelola dan dikueri di DataWorks.
Objek kustom non-terkelola (tidak direkomendasikan)TidakPemanggil menentukan Id dengan awalan custom- dalam format custom-{Type}:{Identifier}.Kompatibel dengan penggunaan lama tetapi tidak lagi direkomendasikan. Untuk laporan eksternal, objek sistem pihak ketiga, dan objek kustom lainnya, daftarkan terlebih dahulu sebagai objek entitas kustom DataWorks lalu daftarkan lineage-nya.

Catatan tambahan:

  • Untuk tabel, kolom, dataset, dan versi dataset yang sudah dikumpulkan oleh DataWorks, jangan membuat Id secara manual. Gunakan Id yang dikembalikan oleh API Get atau List yang sesuai.

  • Untuk objek kustom, gunakan pendekatan objek entitas kustom yang didaftarkan pengguna. Selesaikan definisi entitas dan pendaftaran objek entitas terlebih dahulu:
    1. Panggil CreateMetaEntityDef untuk membuat definisi entitas kustom.

    2. Panggil BatchCreateMetaEntities untuk membuat objek entitas tertentu.

    3. Gunakan Id entitas yang dikembalikan oleh BatchCreateMetaEntities sebagai SrcEntity.Id atau DstEntity.Id.

  • Untuk objek kustom non-terkelola, Anda tidak perlu memanggil CreateMetaEntityDef atau BatchCreateMetaEntities. Cukup masukkan Id entitas dengan awalan custom- dan tentukan Name. Pendekatan ini terutama untuk kompatibilitas mundur dengan skenario lama dan tidak lagi direkomendasikan. Untuk integrasi baru, gunakan pendekatan objek entitas kustom yang terdaftar untuk kemudahan kueri, pengelolaan, dan ekstensi atribut kustom.

  • SrcEntity.Attributes dan DstEntity.Attributes mewakili atribut ekstensi dari endpoint entitas. Tempatkan atribut dari hubungan lineage itu sendiri di Task.Attributes.

Informasi tugas (Task)

Menjelaskan pekerjaan atau tugas yang menghasilkan hubungan lineage.

ParameterTipeWajibDeskripsi
IdStringTidakPengidentifikasi unik dari tugas. Kami merekomendasikan Anda untuk memasukkan nilai yang stabil untuk pendaftaran, kueri, dan penghapusan yang idempoten. Hanya huruf, angka, dan garis bawah yang didukung. Panjang maksimum: 64 karakter.
TypeStringYaTipe tugas. Harus dimulai dengan custom-. Hanya huruf, angka, garis bawah, dan tanda hubung yang didukung. Panjang maksimum: 64 karakter.
AttributesMap<String,String>TidakAtribut tugas. Maksimum 20 atribut didukung. Nilai kompleks harus diserialisasi sebagai string JSON.
• Key: nama atribut (huruf, angka, dan garis bawah, ≤ 64 karakter).
• Value: nilai atribut (≤ 128 karakter).

Contoh permintaan.

Tabel yang dikumpulkan DataWorks dan objek entitas kustom

{
  "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-task",
    "Attributes": {
      "scene": "api_to_table",
      "owner": "zhangsan"
    }
  }
}
```.

### Objek kustom non-terkelola dan tabel yang dikumpulkan DataWorks

> Pendekatan ini terutama untuk kompatibilitas mundur dengan penggunaan lama dan tidak lagi direkomendasikan. Untuk integrasi baru, daftarkan objek entitas kustom dengan menggunakan `CreateMetaEntityDef` dan `BatchCreateMetaEntities` terlebih dahulu, lalu gunakan `Id` entitas yang dikembalikan untuk mendaftarkan lineage.

```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-task",
    "Attributes": {
      "scene": "report_to_table"
    }
  }
}
```.

Elemen respons

Element

Type

Description

Example

object

Respons.

RequestId

string

ID permintaan. Pengidentifikasi unik untuk permintaan.

C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490

Success

boolean

Menunjukkan apakah permintaan berhasil.

true

Id

string

ID hubungan lineage.

4as3dasf654a

Contoh

Respons sukses

JSONformat

{
  "RequestId": "C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490",
  "Success": true,
  "Id": "4as3dasf654a"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.