All Products
Search
Document Center

DataWorks:GetWorkflowDefinition

Last Updated:Jun 11, 2026

Mengkueri informasi tentang alur kerja.

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 None

Parameter permintaan

Parameter

Type

Required

Description

Example

ProjectId

integer

No

ID ruang kerja DataWorks. Anda dapat masuk ke Konsol DataWorks dan membuka halaman Workspace untuk mengkueri ID tersebut.

Anda harus mengonfigurasi parameter ini untuk menentukan ruang kerja DataWorks tempat operasi API diterapkan.

10000

Id

integer

Yes

ID alur kerja.

860438872620****

IncludeScriptContent

boolean

No

Apakah hasil kueri akan menyertakan konten skrip dari node internal dalam definisi alur kerja. Untuk node dengan konten Tingkat Tinggi, hal ini dapat menyebabkan latensi transmisi jaringan yang tinggi.

false

Elemen respons

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

F2BDD628-8A21-5BD1-B930-1A2D5989XXXX

WorkflowDefinition

object

The information about the workflow.

ProjectId

integer

The ID of the workspace to which the workflow belongs.

307XXX

Name

string

The name of the workflow.

OpenAPI test workflow Demo

Owner

string

The owner of the workflow.

110755000425XXXX

CreateTime

integer

The time when the workflow was created. This value is a UNIX timestamp.

1708481905000

ModifyTime

integer

The time when the workflow was last modified. This value is a UNIX timestamp.

1708481905000

Spec

string

The FlowSpec field information about the workflow. For more information, see FlowSpec.

{ "metadata": { "tenantId": "52425742456XXXX", "projectId": "307XXXX", "uuid": "463497880880954XXXX" }, "kind": "CycleWorkflow", "version": "1.1.0", "spec": { "name": "OpenAPI_Test_Workflow_Demo", "id": "463497880880954XXXX", "type": "CycleWorkflow", "owner": "110755000425XXXX", "workflows": [ { "script": { "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo", "runtime": { "command": "WORKFLOW" }, "id": "698002781368644XXXX" }, "id": "463497880880954XXXX", "trigger": { "type": "Scheduler", "id": "652567824470354XXXX", "cron": "00 02 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": "OpenAPI_Test_Workflow_Demo", "owner": "110755000425XXXX", "metadata": { "owner": "110755000425XXXX", "ownerName": "XXXX@test.XXXX.com", "tenantId": "52425742456XXXX", "project": { "mode": "STANDARD", "projectId": "307303", "projectIdentifier": "lwttest_standard", "projectName": "XXXX", "projectOwnerId": "110755000425XXXX", "simple": false, "tenantId": "52425742456XXXX" }, "projectId": "307XXXX" }, "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "463497880880954XXXX", "artifactType": "NodeOutput", "refTableName": "OpenAPI_Test_Workflow_Demo", "isDefault": true } ] }, "nodes": [], "dependencies": [] } ] } }

WorkflowId

integer

The ID of the workflow on the scheduling side after publishing.

700006657495

Id

integer

The ID of the workflow.

463497880880954XXXX

Contoh

Respons sukses

JSONformat

{
  "RequestId": "F2BDD628-8A21-5BD1-B930-1A2D5989XXXX",
  "WorkflowDefinition": {
    "ProjectId": 0,
    "Name": "OpenAPI test workflow Demo",
    "Owner": "110755000425XXXX",
    "CreateTime": 1708481905000,
    "ModifyTime": 1708481905000,
    "Spec": "{\n    \"metadata\": {\n        \"tenantId\": \"52425742456XXXX\",\n        \"projectId\": \"307XXXX\",\n        \"uuid\": \"463497880880954XXXX\"\n    },\n    \"kind\": \"CycleWorkflow\",\n    \"version\": \"1.1.0\",\n    \"spec\": {\n        \"name\": \"OpenAPI_Test_Workflow_Demo\",\n        \"id\": \"463497880880954XXXX\",\n        \"type\": \"CycleWorkflow\",\n        \"owner\": \"110755000425XXXX\",\n        \"workflows\": [\n            {\n                \"script\": {\n                    \"path\": \"XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo\",\n                    \"runtime\": {\n                        \"command\": \"WORKFLOW\"\n                    },\n                    \"id\": \"698002781368644XXXX\"\n                },\n                \"id\": \"463497880880954XXXX\",\n                \"trigger\": {\n                    \"type\": \"Scheduler\",\n                    \"id\": \"652567824470354XXXX\",\n                    \"cron\": \"00 02 00 * * ?\",\n                    \"startTime\": \"1970-01-01 00:00:00\",\n                    \"endTime\": \"9999-01-01 00:00:00\",\n                    \"timezone\": \"Asia/Shanghai\",\n                    \"delaySeconds\": 0\n                },\n                \"strategy\": {\n                    \"timeout\": 0,\n                    \"instanceMode\": \"T+1\",\n                    \"rerunMode\": \"Allowed\",\n                    \"rerunTimes\": 3,\n                    \"rerunInterval\": 180000,\n                    \"failureStrategy\": \"Break\"\n                },\n                \"name\": \"OpenAPI_Test_Workflow_Demo\",\n                \"owner\": \"110755000425XXXX\",\n                \"metadata\": {\n                    \"owner\": \"110755000425XXXX\",\n                    \"ownerName\": \"XXXX@test.XXXX.com\",\n                    \"tenantId\": \"52425742456XXXX\",\n                    \"project\": {\n                        \"mode\": \"STANDARD\",\n                        \"projectId\": \"307303\",\n                        \"projectIdentifier\": \"lwttest_standard\",\n                        \"projectName\": \"XXXX\",\n                        \"projectOwnerId\": \"110755000425XXXX\",\n                        \"simple\": false,\n                        \"tenantId\": \"52425742456XXXX\"\n                    },\n                    \"projectId\": \"307XXXX\"\n                },\n                \"inputs\": {},\n                \"outputs\": {\n                    \"nodeOutputs\": [\n                        {\n                            \"data\": \"463497880880954XXXX\",\n                            \"artifactType\": \"NodeOutput\",\n                            \"refTableName\": \"OpenAPI_Test_Workflow_Demo\",\n                            \"isDefault\": true\n                        }\n                    ]\n                },\n                \"nodes\": [],\n                \"dependencies\": []\n            }\n        ]\n    }\n}",
    "WorkflowId": 700006657495,
    "Id": 0
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.