Ringkasan GetWorkflow API dan referensi metadata workflow - DataWorks

Mengambil informasi tentang suatu alur kerja.

Deskripsi operasi

Operasi API ini tersedia untuk semua edisi DataWorks.

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

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Id	integer	Yes	ID alur kerja.	1234
EnvType	string	No	Lingkungan ruang kerja. Nilai yang valid: Prod: lingkungan produksi Dev: lingkungan pengembangan	Prod

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	22C97E95-F023-56B5-8852-B1A77A17XXXX
Workflow	object	Informasi mengenai alur kerja.
Id	integer	ID alur kerja.	1234
ProjectId	integer	ID ruang kerja.	100
EnvType	string	Lingkungan ruang kerja. Nilai yang valid: Prod: lingkungan produksi Dev: lingkungan pengembangan	Prod
Owner	string	ID akun pemilik alur kerja.	1000
Name	string	Nama alur kerja.	Workflow
Description	string	Deskripsi alur kerja.	Test workflow
Trigger	object	Metode pemicu.
Type	string	Jenis pemicu. Nilai yang valid: Scheduler: pemicu berbasis siklus penjadwalan Manual: pemicu manual	Scheduler
Recurrence	string	Mode eksekusi alur kerja setelah dipicu. Parameter ini hanya berlaku jika parameter Type diatur ke Scheduler. Nilai yang valid: Pause Skip Normal	Normal
Cron	string	Ekspresi CRON. Parameter ini hanya berlaku jika parameter Type diatur ke Scheduler.	00 00 00 * * ?
StartTime	string	Waktu mulai dari rentang waktu selama alur kerja dijadwalkan secara berkala. Parameter ini hanya berlaku jika parameter Type diatur ke Scheduler.	1970-01-01 00:00:00
EndTime	string	Waktu akhir dari rentang waktu selama alur kerja dijadwalkan secara berkala. Parameter ini hanya berlaku jika parameter Type diatur ke Scheduler.	1970-01-01 00:00:00
Dependencies	array<object>	Informasi dependensi.
	object
Type	string	Jenis dependensi penjadwalan. Nilai yang valid: CrossCycleDependsOnChildren: dependensi lintas siklus pada node turunan tingkat-1 dari suatu node CrossCycleDependsOnSelf: dependensi lintas siklus pada node saat ini CrossCycleDependsOnOtherNode: dependensi lintas siklus pada node lain Normal: dependensi penjadwalan siklus yang sama	Normal
UpstreamOutput	string	Identifikasi output dari tugas leluhur. Parameter ini hanya dikembalikan jika `dependensi penjadwalan siklus yang sama` dan input node dikonfigurasi.	pre.odps_sql_demo_0
UpstreamTaskId	integer	ID tugas leluhur. Parameter ini hanya dikembalikan jika `dependensi penjadwalan lintas siklus` atau `dependensi penjadwalan siklus yang sama` dan input node tidak dikonfigurasi.	1234
Parameters	string	Parameter.	para1=$bizdate para2=$[yyyymmdd]
Tasks	array<object>	Tugas.
	array<object>
Id	integer	ID tugas.	1234
ProjectId	integer	ID ruang kerja.	100
EnvType	string	Lingkungan ruang kerja. Nilai yang valid: Prod Dev	Prod
Owner	string	ID akun pemilik tugas.	1000
Name	string	Nama tugas.	SQL node
Description	string	Deskripsi tugas.	Test
WorkflowId	integer	ID alur kerja tempat tugas tersebut berada.	1234
Type	string	Jenis tugas.	ODPS_SQL
BaselineId	integer	ID garis dasar.	1234
Priority	integer	Prioritas tugas. Nilai yang valid: 1 hingga 8. Nilai yang lebih besar menunjukkan prioritas yang lebih tinggi. Nilai default: 1.	1
Timeout	integer	Periode timeout eksekusi tugas. Satuan: detik.	3600
RerunMode	string	Mode menjalankan ulang. Nilai yang valid: AllDenied: Tugas tidak dapat dijalankan ulang, baik ketika berhasil maupun gagal. FailureAllowed: Tugas hanya dapat dijalankan ulang setelah gagal. AllAllowed: Tugas dapat dijalankan ulang, baik ketika berhasil maupun gagal.	AllAllowed
RerunTimes	integer	Jumlah kali tugas dijalankan ulang. Parameter ini hanya berlaku jika parameter RerunMode diatur ke AllAllowed atau FailureAllowed.	3
RerunInterval	integer	Interval menjalankan ulang. Satuan: detik.	60
RuntimeResource	object	Konfigurasi lingkungan runtime, seperti informasi kelompok sumber daya.
ResourceGroupId	string	ID kelompok sumber daya untuk penjadwalan yang dikonfigurasi untuk eksekusi tugas.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	ID image yang dikonfigurasi untuk eksekusi tugas.	i-xxxxxx
Cu	string	Jumlah unit komputasi (CUs) default yang dikonfigurasi untuk eksekusi tugas.	0.25
DataSource	object	Informasi mengenai sumber data terkait.
Name	string	Nama sumber data.	mysql_test
CreateTime	integer	Waktu pembuatan.	1710239005403
ModifyTime	integer	Waktu modifikasi.	1710239005403
CreateUser	string	ID akun pembuat.	1000
ModifyUser	string	ID akun pengubah.	1000
TriggerRecurrence	string	Mode eksekusi tugas setelah dipicu. Nilai yang valid: Pause Skip Normal	Normal
ClientUniqueCode	string	Kode unik klien. Parameter ini digunakan untuk membuat tugas secara asinkron dan menerapkan idempotensi tugas. Jika Anda tidak menentukan parameter ini saat membuat tugas, sistem akan secara otomatis menghasilkan kode unik. Kode unik ini secara unik dikaitkan dengan ID tugas. Jika Anda menentukan parameter ini saat memperbarui atau menghapus tugas, nilai parameter ini harus merupakan kode unik yang digunakan untuk membuat tugas tersebut.	Task_0bc5213917368545132902xxxxxxxx
Outputs	object	Informasi output.
TaskOutputs	array<object>	Output tugas.
	object
Output	string	Identifikasi output.	pre.odps_sql_demo_0
Tags	array<object>	Tag.
	object
Key	string	Kunci tag.	key1
Value	string	Nilai tag.	value1
CreateTime	integer	Waktu pembuatan.	1710239005403
ModifyTime	integer	Waktu modifikasi.	1710239005403
CreateUser	string	ID akun pembuat.	1000
ModifyUser	string	ID akun pengubah.	1000
ClientUniqueCode	string	Kode unik klien. Parameter ini digunakan untuk membuat alur kerja secara asinkron dan menerapkan idempotensi alur kerja. Jika Anda tidak menentukan parameter ini saat membuat alur kerja, sistem akan secara otomatis menghasilkan kode unik. Kode unik ini secara unik dikaitkan dengan ID alur kerja. Jika Anda menentukan parameter ini saat memperbarui atau menghapus alur kerja, nilai parameter ini harus merupakan kode unik yang digunakan untuk membuat alur kerja tersebut.	Workflow_0bc5213917368545132902xxxxxxxx

Contoh

Respons sukses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Workflow": {
    "Id": 1234,
    "ProjectId": 100,
    "EnvType": "Prod",
    "Owner": "1000",
    "Name": "Workflow",
    "Description": "Test workflow",
    "Trigger": {
      "Type": "Scheduler",
      "Recurrence": "Normal",
      "Cron": "00 00 00 * * ?",
      "StartTime": "1970-01-01 00:00:00",
      "EndTime": "1970-01-01 00:00:00"
    },
    "Dependencies": [
      {
        "Type": "Normal",
        "UpstreamOutput": "pre.odps_sql_demo_0",
        "UpstreamTaskId": 1234
      }
    ],
    "Parameters": "para1=$bizdate para2=$[yyyymmdd] ",
    "Tasks": [
      {
        "Id": 1234,
        "ProjectId": 100,
        "EnvType": "Prod",
        "Owner": "1000",
        "Name": "SQL node",
        "Description": "Test",
        "WorkflowId": 1234,
        "Type": "ODPS_SQL",
        "BaselineId": 1234,
        "Priority": 1,
        "Timeout": 3600,
        "RerunMode": "AllAllowed",
        "RerunTimes": 3,
        "RerunInterval": 60,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx",
          "Cu": "0.25"
        },
        "DataSource": {
          "Name": "mysql_test"
        },
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "TriggerRecurrence": "Normal",
        "ClientUniqueCode": "Task_0bc5213917368545132902xxxxxxxx"
      }
    ],
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "ClientUniqueCode": "Workflow_0bc5213917368545132902xxxxxxxx"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.