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

Mengkueri entitas alur data hulu dan hilir untuk entitas tertentu di DataWorks Peta Data, dengan opsi untuk menyertakan informasi detail hubungan alur data.

Deskripsi operasi

Anda harus membeli DataWorks Edisi Standar atau edisi yang lebih tinggi untuk menggunakan operasi ini.
Operasi ini mengkueri entitas hulu dan hilir dari entitas saat ini, serta hubungan alur data antar entitas.

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

*Semua Sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SrcEntityId	string	No	ID entitas sumber. Anda dapat menggunakan ID tabel atau kolom yang dikembalikan oleh operasi ListTables atau ListColumns, atau ID entitas kustom.	maxcompute-table:::project_name:[schema_name]:table_name
DstEntityId	string	No	ID entitas tujuan. Anda dapat menggunakan ID tabel atau kolom yang dikembalikan oleh operasi ListTables atau ListColumns, atau ID entitas kustom.	dlf-table::catalog_id:database_name::table_name
SrcEntityName	string	No	Nama entitas sumber. Pencocokan kabur didukung.	srcName1
DstEntityName	string	No	Nama entitas tujuan. Pencocokan kabur didukung.	dstName1
NeedAttachRelationship	boolean	No	Apakah akan mengembalikan informasi hubungan alur data. Nilai default: false.	false
SortBy	string	No	Bidang pengurutan. Nilai default: Name, yang mengurutkan berdasarkan nama entitas alur data.	Name
Order	string	No	Arah pengurutan. Nilai default: Asc. Nilai valid: Asc: urutan menaik. Desc: urutan menurun. Valid values: Asc : Urutan menaik. Desc : Urutan menurun.	Asc
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Ukuran halaman. Nilai default: 10. Nilai maksimum: 100.	10
RecentDays	integer	No

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
RequestId	string	ID permintaan.	0000-ABCD-EFG****
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
PagingInfo	object	Hasil paginasi.
TotalCount	integer	Jumlah total entri.	12
PageNumber	integer	Nomor halaman data yang dikembalikan, digunakan untuk paginasi.	1
PageSize	integer	Ukuran halaman. Nilai default: 10.	10
Lineages	array<object>	Daftar informasi alur data.
	object	Informasi alur data.
SrcEntity	LineageEntity	Entitas sumber.
DstEntity	LineageEntity	Entitas tujuan.
Relationships	array	Daftar hubungan silsilah (lineage).
	LineageRelationship	Sebuah hubungan silsilah (lineage).

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0000-ABCD-EFG****",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 12,
    "PageNumber": 1,
    "PageSize": 10,
    "Lineages": [
      {
        "SrcEntity": {
          "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "DstEntity": {
          "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "Relationships": [
          {
            "SrcEntity": {
              "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
              "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.