Filter dan daftar workflow DataWorks melalui API ListWorkflowDefinitions - DataWorks - Alibaba Cloud - DataWorks

Mengkueri daftar alur kerja pengembangan data yang dipaginasi. Anda juga dapat memfilter alur kerja berdasarkan kondisi yang ditentukan.

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID ruang kerja DataWorks. Anda dapat masuk ke Konsol DataWorks dan membuka halaman Konfigurasi Ruang Kerja untuk mendapatkan ID ruang kerja. Parameter ini menentukan ruang kerja DataWorks untuk pemanggilan API saat ini.	10000
Type	string	No	Tipe alur kerja. Parameter ini digunakan sebagai kondisi filter. Jika Anda tidak menentukan parameter ini, nilai defaultnya adalah CycleWorkflow. Nilai valid: CycleWorkflow ManualWorkflow	CycleWorkflow
Owner	string	No	ID pemilik, yaitu UID akun administrator ruang kerja. Anda dapat masuk ke Konsol Manajemen Alibaba Cloud dan melihat UID akun pada halaman Pengaturan Keamanan di Manajemen Akun.	110755000425XXXX
Name	string	No	Nama alur kerja. Pencarian fuzzy didukung.	test
PageNumber	integer	No	Nomor halaman yang akan dikembalikan.	1
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai default: 10. Nilai maksimum: 100.	10

Elemen respons

Element	Type	Description	Example
	object	Skema respons.
RequestId	string	ID permintaan. Anda dapat menggunakan ID ini untuk mencari log dan memecahkan masalah.	8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX
PagingInfo	object	Informasi paginasi.
TotalCount	integer	Jumlah total entri yang memenuhi kondisi yang ditentukan.	227
PageSize	integer	Jumlah entri yang dikembalikan pada setiap halaman.	10
PageNumber	integer	Nomor halaman yang akan dikembalikan.	1
WorkflowDefinitions	array<object>	Daftar alur kerja yang dikueri.
	array<object>
ProjectId	integer	ID ruang kerja DataWorks tempat alur kerja berada.	4710
Owner	string	Pemilik alur kerja.	110755000425XXXX
CreateTime	integer	Stempel waktu saat alur kerja dibuat.	1698057323000
ModifyTime	integer	Stempel waktu saat alur kerja terakhir kali dimodifikasi.	1698057323000
Description	string	Deskripsi alur kerja.	Workflow description
Type	string	Tipe alur kerja. Nilai valid: CycleWorkflow ManualWorkflow	CycleWorkflow
Script	object	Informasi skrip.
Path	string	Jalur skrip.	XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo
Runtime	object	Waktu proses.
Command	string	Perintah.	WORKFLOW
Id	string	ID skrip. Penting Sebelum versi SDK 8.0.0, bidang ini bertipe Long. Pada versi SDK 8.0.0 dan yang lebih baru, bidang ini bertipe String. Perubahan ini tidak memengaruhi penggunaan normal SDK. Parameter tetap dikembalikan berdasarkan tipe yang ditentukan dalam SDK. Namun, jika Anda meningkatkan SDK melewati versi 8.0.0, perubahan tipe dapat menyebabkan kegagalan kompilasi proyek. Dalam hal ini, Anda harus memperbaiki tipe data secara manual.	698002781368644XXXX
Name	string	Nama alur kerja.	OpenAPI test workflow Demo
Id	string	Pengenal unik alur kerja. Penting Sebelum versi SDK 8.0.0, bidang ini bertipe Long. Pada versi SDK 8.0.0 dan yang lebih baru, bidang ini bertipe String. Perubahan ini tidak memengaruhi penggunaan normal SDK. Parameter tetap dikembalikan berdasarkan tipe yang ditentukan dalam SDK. Namun, jika Anda meningkatkan SDK melewati versi 8.0.0, perubahan tipe dapat menyebabkan kegagalan kompilasi proyek. Dalam hal ini, Anda harus memperbaiki tipe data secara manual.	463497880880954XXXX

Contoh

Respons sukses

JSONformat

{
  "RequestId": "8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX",
  "PagingInfo": {
    "TotalCount": 227,
    "PageSize": 10,
    "PageNumber": 1,
    "WorkflowDefinitions": [
      {
        "ProjectId": 4710,
        "Owner": "110755000425XXXX",
        "CreateTime": 1698057323000,
        "ModifyTime": 1698057323000,
        "Description": "Workflow description",
        "Type": "CycleWorkflow",
        "Script": {
          "Path": "XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo",
          "Runtime": {
            "Command": "WORKFLOW"
          },
          "Id": "698002781368644XXXX"
        },
        "Name": "OpenAPI test workflow Demo",
        "Id": "463497880880954XXXX"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.