Gunakan API ListDataSources untuk mengkueri sumber data - DataWorks

Mengambil daftar sumber data berdasarkan informasi bisnis sumber data.

Deskripsi operasi

Operasi API ini tersedia untuk semua edisi DataWorks.
Anda hanya dapat memanggil operasi ini jika memiliki salah satu peran berikut di DataWorks:

Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator, dan Data Governance Administrator

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

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID ruang kerja DataWorks. Anda dapat login ke Konsol DataWorks dan membuka halaman Workspace untuk menanyakan ID tersebut. Anda harus mengonfigurasi parameter ini untuk menentukan ruang kerja DataWorks tempat operasi API diterapkan.	17820
Name	string	No	Nama sumber data. Pencocokan fuzzy berdasarkan nama sumber data didukung.	test
Types	array	No	Jenis sumber data. Parameter ini menentukan kondisi filter. Anda dapat menentukan beberapa jenis sumber data.
	string	No	Jenis sumber data.	mysql
EnvType	string	No	Lingkungan tempat sumber data digunakan. Nilai yang valid: Dev: lingkungan pengembangan Prod: lingkungan produksi	Prod
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10. Nilai maksimum: 100.	10
SortBy	string	No	Bidang yang ingin Anda gunakan untuk mengurutkan sumber data. Nilai yang valid: CreateTime Id Name Nilai default: CreateTime	Id
Order	string	No	Urutan pengurutan sumber data. Nilai yang valid: Desc: urutan menurun Asc: urutan menaik Nilai default: Desc	Asc
Tags	string	No	Tag sumber data. Parameter ini menentukan kondisi filter. Anda dapat menentukan beberapa tag, yang memiliki relasi logika AND. Misalnya, Anda dapat menanyakan sumber data yang memiliki tag berikut: `["tag1", "tag2", "tag3"]`. Jika Anda tidak mengonfigurasi parameter ini, penyaringan berbasis tag tidak dilakukan. Anda dapat menentukan hingga 10 tag.	["tag1", "tag2", "tag3"]

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	7BE1433F-6D55-5D86-9344-CA6F7DD19B13
PagingInfo	object	Informasi paginasi.
TotalCount	integer	Total jumlah entri yang dikembalikan.	131
PageSize	integer	Jumlah entri per halaman.	10
PageNumber	integer	Nomor halaman.	1
DataSources	array<object>	Kelompok sumber data. Setiap elemen dalam array menunjukkan satu kelompok sumber data. Setiap kelompok sumber data berisi sumber data di lingkungan pengembangan (jika ada) dan lingkungan produksi.
	array<object>	Informasi tentang kelompok sumber data, termasuk sumber data di lingkungan pengembangan (jika ada) dan lingkungan produksi. Sumber data di lingkungan pengembangan dan lingkungan produksi memiliki nama dan jenis sumber data yang sama, tetapi ID sumber data yang berbeda.
Name	string	Nama sumber data.	test
Type	string	Jenis sumber data.	mysql
DataSource	array<object>	Sumber data. Setiap elemen adalah informasi satu sumber data dengan ID sumber data unik.
	object	Informasi tentang sumber data.
Id	integer	ID sumber data.	16035
ConnectionProperties	any	Konfigurasi koneksi sumber data, termasuk alamat koneksi, identitas akses, dan informasi lingkungan. Parameter envType menentukan lingkungan tempat sumber data digunakan. Nilai yang valid untuk parameter envType: Dev: lingkungan pengembangan Prod: lingkungan produksi Parameter yang perlu Anda konfigurasi untuk sumber data bervariasi tergantung pada mode penambahan sumber data. Untuk informasi selengkapnya, lihat Informasi koneksi sumber data (ConnectionProperties).	{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
ConnectionPropertiesMode	string	Mode penambahan sumber data. Mode ini bervariasi tergantung pada jenis sumber data. Nilai yang valid: InstanceMode: mode instans UrlMode: mode string koneksi	UrlMode
Description	string	Deskripsi sumber data.	test
CreateTime	integer	Waktu saat sumber data ditambahkan. Nilai ini merupakan Stempel waktu UNIX.	1648711113000
CreateUser	string	ID pengguna yang menambahkan sumber data.	1624387842781448
ModifyTime	integer	Waktu saat sumber data terakhir dimodifikasi. Nilai ini merupakan Stempel waktu UNIX.	1648711113000
ModifyUser	string	ID pengguna yang memodifikasi sumber data.	1624387842781448
QualifiedName	string	Kunci bisnis unik sumber data. Sebagai contoh, kunci bisnis unik sumber data Hologres menggunakan format `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`.	1648711121000:cn-beijing:odps:yongxunQA_beijing_standard

Contoh

Respons sukses

JSONformat

{
  "RequestId": "7BE1433F-6D55-5D86-9344-CA6F7DD19B13",
  "PagingInfo": {
    "TotalCount": 131,
    "PageSize": 10,
    "PageNumber": 1,
    "DataSources": [
      {
        "Name": "test",
        "Type": "mysql",
        "DataSource": [
          {
            "Id": 16035,
            "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": 1648711113000,
            "CreateUser": "1624387842781448",
            "ModifyTime": 1648711113000,
            "ModifyUser": "1624387842781448",
            "QualifiedName": "1648711121000:cn-beijing:odps:yongxunQA_beijing_standard"
          }
        ]
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.