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

Mengkueri daftar alur kerja di DataStudio. Anda juga dapat menentukan kondisi filter untuk mengkueri alur kerja tertentu.

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

*全部资源

*

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 mengkueri ID. Anda harus mengonfigurasi parameter ini untuk menentukan workspace DataWorks tempat operasi API ini diterapkan.	10000
Type	string	No	Kondisi filter: Tipe alur kerja. Nilai default-nya adalah CycleWorkflow. Nilai yang valid: CycleWorkflow ManualWorkflow	CycleWorkflow
Owner	string	No	Kondisi filter: Tipe alur kerja. Nilai default-nya adalah CycleWorkflow. Nilai yang valid: CycleWorkflow ManualWorkflow	110755000425XXXX
Name	string	No	Nama alur kerja. Pencarian fuzzy didukung.	test
PageNumber	integer	No	Nomor halaman data yang akan diambil, digunakan untuk paginasi.	1
PageSize	integer	No	Nomor halaman data yang akan diambil, digunakan untuk paginasi.	10

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID permintaan.	8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX
PagingInfo	object	Informasi paginasi.
TotalCount	integer	Jumlah total entri yang dikembalikan.	227
PageSize	integer	Jumlah entri per halaman.	10
PageNumber	integer	Nomor halaman.	1
WorkflowDefinitions	array<object>	Alur kerja.
	array<object>
ProjectId	integer	The ID of the DataWorks workspace to which the workflow belongs.	4710
Owner	string	Owner	110755000425XXXX
CreateTime	integer	The timestamp when the workflow was created.	1698057323000
ModifyTime	integer	The timestamp when the workflow was last modified.	1698057323000
Description	string	Description	Workflow description
Type	string	The type of the workflow. Valid values: CycleWorkflow ManualWorkflow	CycleWorkflow
Script	object	The script information.
Path	string	The script path.	XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo
Runtime	object	Runtime
Command	string	Command	WORKFLOW
Id	string	The ID of the script. Catatan This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.	698002781368644XXXX
Name	string	The name of the workflow.	OpenAPI test workflow Demo
Id	string	The unique identifier of the workflow. Catatan Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.	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.