Gunakan API ListCatalogs untuk Mengambil Katalog Data Map-DataWorks-Alibaba Cloud - DataWorks

Mengkueri daftar katalog di Peta Data. Hanya katalog dengan tipe perayap metadata Data Lake Formation (DLF) dan StarRocks yang didukung. Untuk tipe perayap metadata DLF, semua katalog data yang didukung akan dikembalikan. Untuk tipe perayap metadata StarRocks, katalog data dalam instans tertentu akan dikembalikan.

Deskripsi operasi

DataWorks Basic Edition or a higher edition is required.

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:ListCatalogs

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ParentMetaEntityId	string	Yes	ID entitas induk. Untuk informasi selengkapnya, lihat Konsep terkait entitas metadata. Saat ini, hanya tipe DLF dan StarRocks yang didukung. Untuk tipe DLF, Anda dapat mengkueri semua daftar katalog. Format `ParentMetaEntityId` adalah `DLF`. Untuk tipe StarRocks, Anda dapat mengkueri katalog dari instans tertentu. Format `ParentMetaEntityId` adalah `StarRocks:(instance_id\|encoded_jdbc_url)`. Catatan `instance_id`: ID instans. Diperlukan jika sumber data didaftarkan dalam mode instans. `encoded_jdbc_url`: String koneksi JDBC yang dienkode dengan pengkodean URL. Diperlukan jika sumber data didaftarkan dalam mode string koneksi.	dlf
Name	string	No	Nama. Mendukung pencocokan fuzzy.	abc
Comment	string	No	Komentar. Mendukung pencocokan berbasis token.	this is a comment
Types	array	No	Tipe. Mendukung pencocokan eksak. Jika dikosongkan, semua tipe akan dikueri.
	string	No	The catalog type.	HIVE
SortBy	string	No	Bidang pengurutan. Nilai default: CreateTime. Nilai valid: CreateTime ModifyTime Name Type.	CreateTime
Order	string	No	Pesanan pengurutan tabel. Nilai default: Asc. Nilai valid: Asc: urutan menaik. Desc: urutan menurun.	Asc
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah rekaman per halaman. Nilai default: 10. Nilai maksimum: 100.	10

Elemen respons

Element	Type	Description	Example
	object	Responses.
RequestId	string	The request ID.	317CD7D0-AB36-XXXXXX
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination result.
TotalCount	integer	The total number of records.	1
PageNumber	integer	The page number.	1
PageSize	integer	The number of records per page.	10
Catalogs	array	The catalog.
	Catalog	The catalog details.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "317CD7D0-AB36-XXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Catalogs": [
      {
        "Id": "dlf-catalog:123456XXX:test_catalog\nstarrocks-catalog:c-abc123xxx:default_catalog",
        "Name": "default_catalog",
        "Comment": "this is a comment\n",
        "Type": "Internal",
        "CreateTime": 1722073854000,
        "ModifyTime": 1722073854000,
        "ParentMetaEntityId": "dlf\nstarrocks:c-abc123xxx"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.