Gunakan ListWorkflowInstances untuk filter dan pagination instans workflow - DataWorks - Alibaba Cloud - DataWorks

Mengembalikan daftar instans alur kerja berhalaman yang dapat difilter berdasarkan kriteria tertentu.

Deskripsi operasi

Available with DataWorks Basic Edition or higher.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID proyek.	100
BizDate	integer	Yes	Tanggal bisnis. Umumnya adalah 00:00:00 pada hari sebelum pengatur waktu pemicu instans terjadwal, dalam format timestamp tingkat milidetik, seperti 1743350400000.	1710239005403
Type	string	No	Tipe instans alur kerja. Normal: Penjadwalan periodik Manual: Tugas manual SmokeTest: Pengujian SupplementData: Pengisian data mundur ManualWorkflow: Alur kerja manual TriggerWorkflow: Alur kerja berbasis pemicu.	Normal
WorkflowId	integer	No	ID alur kerja tempat instans berada.	1234
UnifiedWorkflowInstanceId	integer	No	ID instans alur kerja terpadu. Semua instans alur kerja dalam tanggal bisnis yang sama dari satu pemicu berbagi nilai yang sama untuk bidang ini.	1234
Name	string	No	Nama. Pencocokan kabur didukung.	WorkflowInstance1
Ids	array	No	Daftar ID instans alur kerja. Anda dapat menggunakan parameter ini untuk mengkueri beberapa instans alur kerja dalam satu pengatur waktu.
	integer	No	The workflow instance ID.	1234
Owner	string	No	ID akun pemilik.	1000
SortBy	string	No	Daftar bidang pengurutan. Pengurutan berdasarkan pengatur waktu pemicu, pengatur waktu mulai, dan bidang lainnya didukung. Formatnya adalah "bidang pengurutan + urutan Pesanan (Desc/Asc)" (Asc dapat dihilangkan). Nilai valid bidang pengurutan: TriggerTime (Desc/Asc) StartedTime (Desc/Asc) FinishedTime (Desc/Asc) CreateTime (Desc/Asc) Id (Desc/Asc) Nilai default: Id Desc.	Id Desc
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10.	10
PageNumber	integer	No	Nomor halaman, dimulai dari 1. Nilai default: 1.	1
Tags	array	No	Daftar tag. Hasil dikembalikan jika salah satu tag yang ditentukan cocok.
	string	No	The tag. Format: `key:value`. If the value is empty, the format is: `key:`	key:value
Filter	string	No	Filter. Dalam format JSON, beberapa kondisi filter memiliki hubungan AND. Bidang yang saat ini didukung adalah: status, executionDate.	{ "status": "Success", "executionDate": "1763481600000" }
EnvType	string	No		Prod

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID. Used for locating logs and troubleshooting issues.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	The pagination information.
WorkflowInstances	array<object>	The list of workflow instances.
	array<object>
Id	integer	The workflow instance ID.	1234
WorkflowTaskInstanceId	integer	The task instance ID corresponding to the workflow instance.	1234
UnifiedWorkflowInstanceId	integer	The unified workflow instance ID. For all workflow instances triggered under the same trigger and within the same data timestamp, the value of this field is identical.	1234
Name	string	The name of the workflow instance.	WorkflowInstance1
Type	string	The type of the workflow instance. Valid values: Normal: Scheduled execution Manual: Manually triggered node SmokeTest: Smoke test SupplementData: Data backfill ManualWorkflow: Manually triggered workflow TriggerWorkflow: Triggered Workflow	Normal
Status	string	The status of the workflow instance. Valid values: NotRun: The instance is not run. Running: The instance is running. WaitTime: The instance is waiting for the scheduling time to arrive. CheckingCondition: Branch conditions are being checked for the instance. WaitResource: The instance is waiting for resources. Failure: The instance fails to be run. Success: The instance is successfully run. Checking: Data quality is being checked for the instance.	Success
BizDate	integer	Data timestamp.	1710239005403
StartedTime	integer	The time when the instance started to run.	1710239005403
FinishedTime	integer	The time when the instance finished running.	1710239005403
ProjectId	integer	The workspace ID.	100
EnvType	string	The environment of the workspace. Valid values: Prod Dev	Prod
Owner	string	The account ID of the workflow owner.	1000
CreateTime	integer	The creation time.	1710239005403
ModifyTime	integer	The modification time.	1710239005403
CreateUser	string	The account ID of the creator.	100
ModifyUser	string	The account ID of the modifier.	100
WorkflowParameters	string	The workflow parameters.	周期工作流： key1=value1 key2=value2 手动业务流程： {"key1":"value1", "key2": "value2"}
WorkflowId	integer	The ID of the workflow to which the instance belongs.	1234
Tags	array<object>	The task tag.
	object
Key	string	The key of a tag.	key1
Value	string	The value of a tag.	value1
TotalCount	integer	The total number of entries.	100
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1

Contoh

Respons sukses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "WorkflowInstances": [
      {
        "Id": 1234,
        "WorkflowTaskInstanceId": 1234,
        "UnifiedWorkflowInstanceId": 1234,
        "Name": "WorkflowInstance1",
        "Type": "Normal",
        "Status": "Success",
        "BizDate": 1710239005403,
        "StartedTime": 1710239005403,
        "FinishedTime": 1710239005403,
        "ProjectId": 100,
        "EnvType": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "100",
        "ModifyUser": "100",
        "WorkflowParameters": "周期工作流：\nkey1=value1 key2=value2\n手动业务流程：\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
        "WorkflowId": 1234,
        "Tags": [
          {
            "Key": "key1",
            "Value": "value1"
          }
        ]
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.