Referensi API GetDataLakeCatalog - Data Management - Alibaba Cloud - Data Management

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

dms:GetDataLakeCatalog

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DataRegion	string	Yes	Region tempat data lake berada.	cn-hangzhou
CatalogName	string	Yes	Nama katalog data.	hive
Tid	integer	No	ID penyewa. Anda dapat memperoleh nilai parameter ini dengan memanggil operasi GetUserActiveTenant atau ListUserTenants.	3
WorkspaceId	integer	No	ID ruang kerja.	12****

Elemen respons

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	ID permintaan, yang digunakan untuk melokalisasi log dan memecahkan masalah.	FE8EE2F1-4880-46BC-A704-5CF63EAF9A04
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true: Permintaan berhasil. false: Permintaan gagal.	true
ErrorCode	string	Kode kesalahan.	400
ErrorMessage	string	Pesan kesalahan yang dikembalikan jika panggilan gagal.	code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B7EB1
Catalog	DLCatalog	Informasi katalog data.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF9A04",
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B7EB1",
  "Catalog": {
    "Description": "init default catalog",
    "Name": "hive",
    "Location": "oss://xxxx"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.