Referensi parameter, filter & pagination ListFiles API - DataWorks - Alibaba Cloud - DataWorks

Menampilkan daftar file dengan memanggil operasi ListFiles.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
FileFolderPath	string	No	Jalur folder tempat file disimpan.	Business_process/my_first_business_process/MaxCompute/ods_layer
ProjectId	integer	No	ID ruang kerja DataWorks. Anda dapat login ke Konsol DataWorks dan membuka halaman konfigurasi ruang kerja untuk mendapatkan ID ruang kerja tersebut. Anda harus menentukan salah satu parameter ini atau parameter ProjectIdentifier untuk menentukan ruang kerja DataWorks yang digunakan dalam pemanggilan API ini.	10000
Keyword	string	No	Kata kunci nama file. Pencocokan fuzzy didukung. Anda dapat memasukkan kata kunci untuk mencari semua file yang namanya mengandung kata kunci tersebut.	ods
ProjectIdentifier	string	No	Nama ruang kerja DataWorks. Anda dapat login ke Konsol DataWorks dan membuka halaman konfigurasi ruang kerja untuk mendapatkan nama ruang kerja tersebut. Anda harus menentukan salah satu parameter ini atau parameter ProjectId untuk menentukan ruang kerja DataWorks yang digunakan dalam pemanggilan API ini.	dw_project
PageNumber	integer	No	Nomor halaman untuk paginasi.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10. Nilai maksimum: 100.	10
UseType	string	No	Modul fungsional tempat file tersebut berada. Nilai yang valid: NORMAL: DataStudio. MANUAL: node manual. MANUAL_BIZ: alur kerja manual. SKIP: penjadwalan dry-run di DataStudio. ADHOCQUERY: kueri ad hoc. COMPONENT: manajemen komponen.	NORMAL
FileTypes	string	No	Jenis kode file. Kode umum dan jenis file yang sesuai meliputi 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (node gabungan), 99 (node virtual), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (pemeriksaan objek OSS), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (sinkronisasi real-time), 1002 (node internal PAI), 1089 (node lintas penyewa), 1091 (pengembangan Hologres), 1093 (SQL Hologres), 1100 (node assignment), 1106 (node foreach), 1221 (PyODPS 3).	10,23
Owner	string	No	Pemilik file.	3726346****
NodeId	integer	No	ID node penjadwalan. Anda dapat memanggil operasi ListNodes untuk mendapatkan ID node tersebut.	123541234
NeedContent	boolean	No	Menentukan apakah hasil kueri menyertakan konten file. Untuk file dengan konten besar, latensi transmisi jaringan mungkin signifikan.	false
NeedAbsoluteFolderPath	boolean	No	Menentukan apakah hasil kueri menyertakan jalur folder tempat file disimpan.	false
ExactFileName	string	No	Nama file untuk pencocokan eksak. Nama file dalam hasil kueri akan persis sesuai dengan nilai parameter ini.	ods_create.sql
FileIdIn	string	No	Daftar ID file. ID file dalam hasil kueri hanya boleh merupakan subset dari daftar ini. Maksimal 50 ID file dapat ditentukan sekaligus.	78237,816123
LastEditUser	string	No	ID akun Alibaba Cloud pengguna yang terakhir memperbarui file.	11233***
CommitStatus	integer	No	Status commit terkini file. Nilai yang valid: 0 (kode terbaru belum dikomit) dan 1 (kode terbaru telah dikomit).	1

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
HttpStatusCode	integer	Kode status HTTP.	200
ErrorMessage	string	Pesan kesalahan.	The connection does not exist.
RequestId	string	ID permintaan. Anda dapat menggunakan ID ini untuk pemecahan masalah.	0000-ABCD-****
ErrorCode	string	Kode kesalahan.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Menunjukkan apakah pemanggilan berhasil. Nilai yang valid: true: Pemanggilan berhasil. false: Pemanggilan gagal.	true
Data	object	Detail data yang dikembalikan.
PageNumber	integer	Nomor halaman data yang dikembalikan.	1
PageSize	integer	Jumlah entri per halaman.	10
TotalCount	integer	Total jumlah entri yang memenuhi kondisi.	13
Files	array<object>	Detail file.
	object	Informasi file.
CommitStatus	integer	Status commit terkini file. Nilai yang valid: 0 (kode terbaru belum dikomit) dan 1 (kode terbaru telah dikomit).	1
AutoParsing	boolean	Menentukan apakah penguraian otomatis diaktifkan untuk file. Nilai yang valid: true: File secara otomatis mengurai kode. false: File tidak secara otomatis mengurai kode. Parameter ini sesuai dengan Analyze Code ketika Anda mengatur Dependencies ke Same Cycle dalam konfigurasi penjadwalan task Data Studio di Konsol DataWorks.	true
Owner	string	ID akun Alibaba Cloud pemilik file.	3872572****
CreateTime	integer	Timestamp (dalam milidetik) saat file dibuat.	1593950832000
FileType	integer	Jenis file. Jenis file yang berbeda memiliki kode yang berbeda. Untuk informasi selengkapnya, lihat Jenis node DataWorks.	10
CurrentVersion	integer	Versi terbaru file.	2
BizId	integer	ID alur kerja tempat file tersebut berada. Parameter ini sudah tidak digunakan lagi. Gunakan parameter BusinessId sebagai gantinya.	300000
LastEditUser	string	ID akun Alibaba Cloud pengguna yang terakhir memperbarui file.	382762****
FileName	string	Nama file.	ods_user_info_d
ConnectionName	string	Nama sumber data yang digunakan oleh task.	odps_source
UseType	string	Modul fungsional tempat file tersebut berada. Nilai yang valid: NORMAL: Data Studio MANUAL: Node yang dipicu secara manual MANUAL_BIZ: Alur kerja yang dipicu secara manual SKIP: Penjadwalan dry-run di Data Studio ADHOCQUERY: Kueri ad hoc COMPONENT: Manajemen komponen	NORMAL
FileFolderId	string	ID folder tempat file berada.	2735c2****
FileId	integer	ID file.	10000001
ParentId	integer	Jika file saat ini adalah file internal dari node gabungan, parameter ini menentukan ID file node gabungan yang sesuai.	-1
CreateUser	string	ID akun Alibaba Cloud pembuat file.	382762****
IsMaxCompute	boolean	Jika file saat ini adalah file resource MaxCompute, parameter ini menentukan apakah file resource tersebut perlu diunggah ke MaxCompute. Anda hanya perlu mengonfigurasi parameter ini ketika file tersebut merupakan file resource MaxCompute.	false
BusinessId	integer	ID alur kerja tempat file tersebut berada.	300000
FileDescription	string	Deskripsi file.	my test datastudio file
LastEditTime	integer	Timestamp (dalam milidetik) saat file terakhir dimodifikasi.	1593950832000
Content	string	Parameter ini sudah tidak digunakan lagi. Anda dapat memanggil operasi GetFile untuk menanyakan informasi ini.	SHOW TABLES;
NodeId	integer	ID task penjadwalan yang dihasilkan dalam sistem penjadwalan setelah file dikomit.	300001
AbsoluteFolderPath	string	Jalur menuju folder tempat file berada.	Business_process/my_first_business_process/MaxCompute/ods_layer

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Files": [
      {
        "CommitStatus": 1,
        "AutoParsing": true,
        "Owner": "3872572****",
        "CreateTime": 1593950832000,
        "FileType": 10,
        "CurrentVersion": 2,
        "BizId": 300000,
        "LastEditUser": "382762****",
        "FileName": "ods_user_info_d",
        "ConnectionName": "odps_source",
        "UseType": "NORMAL",
        "FileFolderId": "2735c2****",
        "FileId": 10000001,
        "ParentId": -1,
        "CreateUser": "382762****",
        "IsMaxCompute": false,
        "BusinessId": 300000,
        "FileDescription": "my test datastudio file",
        "LastEditTime": 1593950832000,
        "Content": "SHOW TABLES;",
        "NodeId": 300001,
        "AbsoluteFolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.