All Products
Search
Document Center

DataWorks:GetWorkflowInstance

Last Updated:Jun 11, 2026

Mengkueri informasi instans alur kerja.

Deskripsi operasi

You must purchase DataWorks Basic Edition or a higher edition to use this feature.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter

Type

Required

Description

Example

Id

integer

Yes

ID instans alur kerja.

1234

Elemen respons

Element

Type

Description

Example

object

RequestId

string

The request ID.

22C97E95-F023-56B5-8852-B1A77A17XXXX

WorkflowInstance

object

The information about the workflow instance.

Id

integer

The ID of the workflow instance.

1234

WorkflowId

integer

The ID of the workflow to which the instance belongs.

1234

WorkflowTaskInstanceId

integer

The task instance ID corresponding to the workflow instance.

1234

UnifiedWorkflowInstanceId

integer

The unified pipeline instance ID. For all pipeline instances triggered under the same data timestamp in a single trigger, this field value is identical.

1234

Name

string

The name of the workflow instance.

WorkInstance1

Type

string

The type of the workflow instance. Valid values:

  • Normal: Scheduled execution

  • Manual: Manually triggered node

  • SmokeTest: Testing

  • 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

The 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.

1000

ModifyUser

string

The account ID of the modifier.

1000

WorkflowParameters

string

The workflow parameters.

周期工作流: key1=value1 key2=value2 手动业务流程: {"key1":"value1", "key2": "value2"}

Tags

array<object>

The task tag.

object

Key

string

The key of a tag.

key1

Value

string

The value of a tag.

value1

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.