Referensi API GetDataSource & Parameter - DataWorks - Alibaba Cloud - DataWorks

Mengkueri sumber data tertentu berdasarkan ID sumber data.

Deskripsi operasi

Anda harus membeli DataWorks Edisi Dasar atau edisi yang lebih tinggi untuk menggunakan fitur ini.
Anda harus memiliki setidaknya salah satu peran berikut di ruang kerja DataWorks:

Pemilik Penyewa, Administrator Ruang Kerja, Penerapan, Pengembang, Pemilik Proyek, atau Insinyur O&M

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

get

*Semua Sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Id	integer	Yes	ID sumber data, yang merupakan pengidentifikasi unik sumber data.	16035

Elemen respons

Element	Type	Description	Example
	object	Tanggapan.
RequestId	string	ID permintaan. Digunakan untuk melacak log dan memecahkan masalah.	9252F32F-D855-549E-8898-61CF5A733050
DataSource	object	Detail sumber data.
Id	integer	ID sumber data.	16738
ProjectId	integer	ID ruang kerja tempat sumber data berada.	52660
Name	string	Nama sumber data.	test
Type	string	Tipe sumber data.	hologres
ConnectionProperties	any	Konfigurasi koneksi sumber data, termasuk titik akhir, identitas akses, dan konteks lingkungan. Tipe lingkungan sumber data (envType) adalah properti anggota dari objek ini. Nilai valid: Dev: lingkungan pengembangan. Prod: lingkungan produksi. Tipe sumber data yang berbeda memiliki spesifikasi properti yang berbeda di bawah mode konfigurasi yang berbeda (ConnectionPropertiesMode). Untuk informasi lebih lanjut, lihat Properti koneksi sumber data (ConnectionProperties).	{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
ConnectionPropertiesMode	string	Kategori penambahan sumber data. Tipe yang berbeda memiliki subtipe yang berbeda dengan batasan parameter yang berbeda. Contoh: InstanceMode: mode instans. UrlMode: mode string koneksi. CdhMode: mode CDH.	UrlMode
Description	string	Deskripsi sumber data.	test
CreateTime	integer	Waktu pembuatan sumber data (timestamp).	1698286929333
CreateUser	string	ID pengguna yang membuat sumber data.	1107550004253538
ModifyTime	integer	Waktu terakhir modifikasi sumber data (timestamp).	1698286929333
ModifyUser	string	ID pengguna yang terakhir memodifikasi sumber data.	1107550004253538
QualifiedName	string	Kunci unik bisnis sumber data. Misalnya, format untuk sumber data Gudang Data Real-time adalah `${penyewaOwnerId}:${regionId}:${type}:${instanceId}:${database}`.	1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb

Contoh

Respons sukses

JSONformat

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "DataSource": {
    "Id": 16738,
    "ProjectId": 52660,
    "Name": "test",
    "Type": "hologres",
    "ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n    \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n    \"database\": \"testdb\",\n    \"securityProtocol\": \"authTypeNone\",\n    \"authType\": \"Executor\",\n    \"authIdentity\": \"1107550004253538\"\n}",
    "ConnectionPropertiesMode": "UrlMode",
    "Description": "test",
    "CreateTime": 1698286929333,
    "CreateUser": "1107550004253538",
    "ModifyTime": 1698286929333,
    "ModifyUser": "1107550004253538",
    "QualifiedName": "1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.