Ringkasan API ListLineages untuk Jejak Data - DataWorks - Alibaba Cloud - DataWorks

Mengkueri entitas hulu dan hilir untuk entitas tertentu di Data Map. Anda dapat secara opsional menyertakan informasi hubungan silsilah (lineage) yang terperinci.

Deskripsi operasi

Untuk menggunakan API ini, Anda harus membeli DataWorks Edisi Standar atau edisi yang lebih baru.
Gunakan API ini untuk mengkueri entitas hulu dan hilir dari entitas tertentu beserta hubungan silsilah (lineage) mereka.

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListLineages

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SrcEntityId	string	No	ID dari entitas sumber. Ini dapat berupa ID tabel atau kolom yang dikembalikan oleh API `ListTables` atau `ListColumns`, atau ID dari entitas kustom.	maxcompute-table:::project_name:[schema_name]:table_name
DstEntityId	string	No	ID dari entitas tujuan. Ini dapat berupa ID tabel atau kolom yang dikembalikan oleh API `ListTables` atau `ListColumns`, atau ID dari entitas kustom.	dlf-table::catalog_id:database_name::table_name
SrcEntityName	string	No	Nama dari entitas sumber. Parameter ini mendukung pencocokan fuzzy.	srcName1
DstEntityName	string	No	Nama dari entitas tujuan. Parameter ini mendukung pencocokan fuzzy.	dstName1
NeedAttachRelationship	boolean	No	Menentukan apakah akan menyertakan hubungan silsilah (lineage). Default: false.	false
SortBy	string	No	Bidang yang digunakan untuk mengurutkan hasil. Default-nya adalah `Name`, yang mengurutkan berdasarkan nama entitas.	Name
Order	string	No	Urutan pengurutan. Default: `Asc`. Nilai yang valid: `Asc`: menaik (ascending) `Desc`: menurun (descending)	Asc
PageNumber	integer	No	Nomor halaman yang akan diambil. Default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Default: 10. Maksimum: 100.	10

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
RequestId	string	ID permintaan.	0000-ABCD-EFG****
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
PagingInfo	object	Detail pagination.
TotalCount	integer	Jumlah total entri.	12
PageNumber	integer	Nomor halaman dari data yang dikembalikan.	1
PageSize	integer	Jumlah entri yang dikembalikan pada halaman saat ini.	10
Lineages	array<object>	Daftar informasi silsilah (lineage).
	object	Sebuah entri silsilah (lineage).
SrcEntity	LineageEntity	Source entity.
DstEntity	LineageEntity	Target entity.
Relationships	array	Lineage relationship information.
	LineageRelationship	Lineage relationship information.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0000-ABCD-EFG****",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 12,
    "PageNumber": 1,
    "PageSize": 10,
    "Lineages": [
      {
        "SrcEntity": {
          "Id": "maxcompute-table:123456::test_project::test_tbl",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "DstEntity": {
          "Id": "maxcompute-table:123456::test_project::test_tbl",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "Relationships": [
          {
            "SrcEntity": {
              "Id": "maxcompute-table:123456::test_project::test_tbl",
              "Name": "test_tbl",
              "Attributes": {
                "key": "key1:value1"
              }
            },
            "Task": {
              "Id": "12345",
              "Type": "custom-sql",
              "Attributes": {
                "key": "key1:value21"
              }
            },
            "Id": "maxcompute-table.p.table:custom-table.xxx:custom-sql.123",
            "CreateTime": 1743040581000
          }
        ]
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.