Otomatiskan impor workflow ke DataStudio melalui API - DataWorks - Alibaba Cloud - DataWorks

Deskripsi operasi

Penting

Operasi ini tidak mendukung pengimporan beberapa alur kerja. Jika lebih dari satu alur kerja ditentukan dalam FlowSpec, semua alur kerja kecuali yang pertama akan diabaikan.
Ini adalah operasi asinkron. Tanggapan mengembalikan objek Tugas asinkron. Panggil GetJobStatus untuk mengkueri status eksekusi tugas.

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

update

*Semua sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID ruang kerja DataWorks. Anda dapat masuk ke Konsol DataWorks dan membuka halaman manajemen ruang kerja untuk mendapatkan ID tersebut. Parameter ini menentukan ruang kerja DataWorks untuk pemanggilan API ini.	123456
Spec	string	Yes	Informasi FlowSpec yang mendeskripsikan alur kerja. Untuk detail spesifikasi, lihat FlowSpec. Catatan Bagaimana cara mendapatkan Templat FlowSpec dengan cepat? Buka alur kerja di DataStudio, lalu klik Show Spec di sudut kanan atas untuk mendapatkan deskripsi FlowSpec alur kerja saat ini. Anda dapat menggunakan deskripsi FlowSpec ini untuk membuat Templat yang sesuai dengan kebutuhan Anda dengan cepat. Penting Operasi ini mendukung pembuatan alur kerja dan node internalnya secara bersamaan. Perhatikan ID yang ditentukan dalam FlowSpec. Jika ID sudah ada, operasi akan menjadi pembaruan. Operasi akan menjadi pembuatan hanya jika tidak ada ID yang ditentukan atau ID tidak ada.	{ "version": "1.1.0", "kind": "CycleWorkflow", "spec": { "name": "Asynchronous_Workflow_Creation_Test", "id": "632647691239009XXXX", "type": "CycleWorkflow", "workflows": [ { "script": { "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test", "runtime": { "command": "WORKFLOW" } }, "id": "632647691239009XXXX", "trigger": { "type": "Scheduler", "cron": "00 03 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "strategy": { "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "failureStrategy": "Break" }, "name": "Asynchronous_Workflow_Creation_Test", "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "632647691239009XXXX", "artifactType": "NodeOutput", "refTableName": "Asynchronous_Workflow_Creation_Test" } ] }, "nodes": [ { "recurrence": "Normal", "id": "742981001612325XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "script": { "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/111", "runtime": { "command": "ODPS_SQL" }, "content": "select now();\n" }, "trigger": { "type": "Scheduler", "cron": "00 24 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "name": "111", "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "742981001612325XXXX", "artifactType": "NodeOutput", "refTableName": "111" } ] } }, { "recurrence": "Normal", "id": "595182137303408XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "script": { "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/222", "runtime": { "command": "ODPS_SQL" }, "content": "select now();\n select 1;" }, "trigger": { "type": "Scheduler", "cron": "00 00 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "name": "222", "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "595182137303408XXXX", "artifactType": "NodeOutput", "refTableName": "222" } ] } } ], "dependencies": [ { "nodeId": "595182137303408XXXX", "depends": [ { "type": "Normal", "output": "742981001612325XXXX", "refTableName": "111" } ] } ] } ] } }

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
RequestId	string	ID permintaan. Anda dapat menggunakan ID ini untuk mengatasi masalah.	7C352CB7-CD88-50CF-9D0D-E81BDF020E7F
AsyncJob	object	Informasi status tugas asinkron.
Completed	boolean	Apakah tugas asinkron telah selesai.	false
CreateTime	integer	Stempel pengatur waktu saat Tugas asinkron dibuat.	1706581425000
Error	string	Paket error yang dikembalikan ketika Tugas asinkron gagal.	target folder already exists: XXXX
Id	string	ID tugas asinkron.	1234567691239009XXXX
Progress	integer	Progres tugas asinkron. Nilai valid: 0 hingga 100.	0
Response	string	Konten yang diharapkan dikembalikan oleh tugas asinkron. Catatan Bidang ini saat ini berisi ID alur kerja yang dibuat oleh tugas asinkron.	632647691239009XXXX
Status	string	Status tugas asinkron. Nilai valid: Running: Tugas sedang berjalan. Success: Tugas berhasil. Fail: Tugas gagal. Cancel: Tugas dibatalkan.	Running
Type	string	Tipe operasi Tugas asinkron. Nilai valid: Create: membuat Sumber daya. Cancel: membatalkan Pekerjaan pembuatan.	Create

Contoh

Respons sukses

JSONformat

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF020E7F",
  "AsyncJob": {
    "Completed": false,
    "CreateTime": 1706581425000,
    "Error": "target folder already exists: XXXX",
    "Id": "1234567691239009XXXX",
    "Progress": 0,
    "Response": "632647691239009XXXX",
    "Status": "Running",
    "Type": "Create"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.