Ringkasan GetTaskInstance API dan field respons - DataWorks - Alibaba Cloud - DataWorks

Mengkueri informasi tentang sebuah instance.

Deskripsi operasi

Anda harus membeli DataWorks Basic Edition atau edisi yang lebih tinggi untuk menggunakan fitur ini.

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 instance.	1234

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
RequestId	string	ID permintaan.	22C97E95-F023-56B5-8852-B1A77****
TaskInstance	object	Detail instance tugas.
TaskId	integer	ID tugas tempat instance dihasilkan.	1234
TaskType	string	Jenis tugas tempat instance dihasilkan.	ODPS_SQL
TaskName	string	Nama tugas tempat instance dihasilkan.	SQL node
Description	string	Deskripsi.	test
WorkflowId	integer	ID alur kerja tempat instance berada.	1234
WorkflowName	string	Nama alur kerja tempat instance berada.	Test workflow
TriggerType	string	Metode untuk memicu penjadwalan instance. Nilai parameter Trigger.Type dalam respons operasi GetTask digunakan. Nilai yang valid: Scheduler Manual	Scheduler
TriggerRecurrence	string	Mode menjalankan instance setelah dipicu. Parameter ini hanya berlaku jika parameter TriggerType disetel ke Scheduler. Nilai yang valid: Pause Skip Normal	Normal
WorkflowInstanceId	integer	ID instance alur kerja.	1234
WorkflowInstanceType	string	Jenis instance alur kerja. Nilai yang valid: SmokeTest SupplementData Manual ManualWorkflow Normal ManualFlow	Normal
UnifiedWorkflowInstanceId	integer	ID instance alur kerja terpadu. Semua instance tugas yang dipicu pada stempel waktu data yang sama memiliki nilai yang sama untuk bidang ini.	1234
Timeout	integer	Periode batas waktu menjalankan tugas. Satuan: detik. Catatan: Nilai parameter ini dibulatkan ke atas berdasarkan jam.	3600
RerunMode	string	Mode jalankan ulang. Nilai yang valid: AllDenied: Tugas tidak dapat dijalankan ulang terlepas dari apakah tugas berhasil dijalankan atau gagal dijalankan. AllAllowed: Tugas dapat dijalankan ulang terlepas dari apakah tugas berhasil dijalankan atau gagal dijalankan. FailureAllowed: Tugas hanya dapat dijalankan ulang setelah gagal dijalankan.	AllAllowed
RunNumber	integer	Jumlah kali instance dijalankan. Secara default, nilai dimulai dari 1.	1
PeriodNumber	integer	Nomor urut siklus. Parameter ini menunjukkan siklus instance tugas pada hari ini.	1
BaselineId	integer	ID baseline.	1234
Priority	integer	Prioritas tugas. Nilai yang valid: 1 hingga 8. Nilai yang lebih besar menunjukkan prioritas yang lebih tinggi. Nilai default: 1.	1
Script	object	Informasi skrip.
Content	string	The script content.	echo "helloWorld"
Parameters	string	The script parameters.	para1=$bizdate
RuntimeResource	object	Informasi tentang grup sumber daya yang terkait dengan instance.
ResourceGroupId	string	The ID of the resource group for scheduling configured for task running.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	The ID of the image configured for task running.	i-xxxxxx
Cu	string	The default number of CUs configured for task running.	0.25
Runtime	object	Informasi runtime tentang instance.
ProcessId	string	The instance run ID.	T3_123
Gateway	string	The host for running.	cn-shanghai.1.2
DataSource	object	Informasi tentang sumber data terkait.
Name	string	The name of the data source.	mysql_test
Inputs	object	Informasi input.
Variables	array<object>	The variables.
	object
Name	string	The name of the variable.	Key1
Type	string	The type. Valid values: Constant: constant PassThrough: node output System: variable NodeOutput: script output	Constant
Value	string	The value of the variable.	Value1
Outputs	object	Informasi output.
TaskOutputs	array<object>	The task outputs.
	object
Output	string	The output identifier.	pre.odps_sql_demo_0
Variables	array<object>	The variables.
	object
Name	string	The name of the variable.	key1
Type	string	The type. Valid values: Constant: constant PassThrough: node output System: variable NodeOutput: script output	Constant
Value	string	The value of the variable.	value1
Tags	array<object>	Tag tugas.
	object
Key	string	The tag key.	key1
Value	string	The tag value.	value1
Status	string	Status instance. Nilai yang valid: NotRun: Instance tidak dijalankan. Running: Instance sedang berjalan. WaitTime: Instance menunggu waktu penjadwalan tiba. CheckingCondition: Kondisi cabang sedang diperiksa untuk instance. WaitResource: Instance sedang menunggu sumber daya. Failure: Instance gagal dijalankan. Success: Instance berhasil dijalankan. Checking: Kualitas data sedang diperiksa untuk instance.	Success
TriggerTime	integer	Waktu penjadwalan.	1710239005403
Bizdate	integer	Stempel waktu data.	1710239005403
StartedTime	integer	Waktu ketika instance mulai berjalan.	1710239005403
FinishedTime	integer	Waktu ketika instance selesai berjalan.	1710239005403
Id	integer	ID instance.	1234
ProjectId	integer	ID ruang kerja.	100
ProjectEnv	string	Lingkungan ruang kerja. Nilai yang valid: Prod: lingkungan produksi Dev: lingkungan pengembangan	Prod
Owner	string	ID akun pemilik tugas.	1000
CreateTime	integer	Waktu pembuatan.	1710239005403
ModifyTime	integer	Waktu modifikasi.	1710239005403
CreateUser	string	ID akun pembuat.	1000
ModifyUser	string	ID akun pengubah.	1000
WaitingResourceTime	integer	Stempel waktu kapan mulai menunggu sumber daya.	1710239005403
WaitingTriggerTime	integer	Stempel waktu kapan mulai menunggu waktu yang dijadwalkan.	1710239005403

Contoh

Respons sukses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77****",
  "TaskInstance": {
    "TaskId": 1234,
    "TaskType": "ODPS_SQL",
    "TaskName": "SQL node\n",
    "Description": "test",
    "WorkflowId": 1234,
    "WorkflowName": "Test workflow",
    "TriggerType": "Scheduler",
    "TriggerRecurrence": "Normal",
    "WorkflowInstanceId": 1234,
    "WorkflowInstanceType": "Normal",
    "UnifiedWorkflowInstanceId": 1234,
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RunNumber": 1,
    "PeriodNumber": 1,
    "BaselineId": 1234,
    "Priority": 1,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "RuntimeResource": {
      "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
      "Image": "i-xxxxxx",
      "Cu": "0.25"
    },
    "Runtime": {
      "ProcessId": "T3_123",
      "Gateway": "cn-shanghai.1.2"
    },
    "DataSource": {
      "Name": "mysql_test"
    },
    "Inputs": {
      "Variables": [
        {
          "Name": "Key1",
          "Type": "Constant",
          "Value": "Value1"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant",
          "Value": "value1"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Status": "Success",
    "TriggerTime": 1710239005403,
    "Bizdate": 1710239005403,
    "StartedTime": 1710239005403,
    "FinishedTime": 1710239005403,
    "Id": 1234,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "WaitingResourceTime": 1710239005403,
    "WaitingTriggerTime": 1710239005403
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.