Gunakan API ListDataSources untuk mengkueri sumber data - DataWorks - Alibaba Cloud - DataWorks

Mengambil daftar sumber data yang cocok dengan kondisi filter yang ditentukan.

Deskripsi operasi

Operasi ini tersedia untuk semua edisi DataWorks.
Untuk memanggil operasi ini, Anda harus 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 workspace DataWorks. Anda dapat masuk ke konsol DataWorks dan membuka halaman Workspace untuk menanyakan ID. Anda harus mengonfigurasi parameter ini untuk menentukan workspace DataWorks tempat operasi API diterapkan.	17820
Name	string	No	Nama sumber data. Pencocokan fuzzy berdasarkan nama sumber data didukung.	test
Types	array	No	Tipe sumber data. Parameter ini menentukan kondisi filter. Anda dapat menentukan beberapa tipe sumber data.
	string	No	Tipe 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	Field yang ingin Anda gunakan untuk mengurutkan sumber data. Nilai yang valid: CreateTime Id Name Nilai default: CreateTime	Id
Order	string	No	Urutan yang ingin Anda gunakan untuk mengurutkan 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 berada dalam relasi logis AND. Misalnya, Anda dapat menanyakan sumber data yang berisi tag berikut: `["tag1", "tag2", "tag3"]`. Jika Anda tidak mengonfigurasi parameter ini, pemfilteran 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	Jumlah total entri yang dikembalikan.	131
PageSize	integer	Jumlah entri per halaman.	10
PageNumber	integer	Nomor halaman.	1
DataSources	array<object>	Grup sumber data. Setiap elemen dalam array menunjukkan satu grup sumber data. Setiap grup sumber data berisi sumber data di lingkungan pengembangan (jika ada) dan lingkungan produksi.
	array<object>	Informasi tentang grup sumber data, termasuk sumber data di lingkungan pengembangan (jika ada) dan lingkungan produksi. Sumber data di lingkungan pengembangan dan lingkungan produksi memiliki nama sumber data dan tipe sumber data yang sama, tetapi ID sumber data yang berbeda.
Name	string	The name of the data source.	test
Type	string	The type of the data source.	mysql
DataSource	array<object>	The data sources. Each element is the information of a single data source with a unique data source ID.
	object	The information about the data source.
Id	integer	The ID of the data source.	16035
ConnectionProperties	any	The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter: Dev: development environment Prod: production environment The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see Data source connection information (ConnectionProperties).	{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
ConnectionPropertiesMode	string	The mode in which the data source is added. The mode varies based on the data source type. Valid values: InstanceMode: instance mode UrlMode: connection string mode	UrlMode
Description	string	The description of the data source.	test
CreateTime	integer	The time when the data source was added. This value is a UNIX timestamp.	1648711113000
CreateUser	string	The ID of the user who adds the data source.	1624387842781448
ModifyTime	integer	The time when the data source was last modified. This value is a UNIX timestamp.	1648711113000
ModifyUser	string	The ID of the user who modifies the data source.	1624387842781448
QualifiedName	string	The unique business key of the data source. For example, the unique business key of a Hologres data source is in the `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}` format.	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.