Gunakan GetDISyncInstanceInfo untuk kueri status tugas dan solusi sinkronisasi - DataWorks - Alibaba Cloud - DataWorks

Mengkueri status tugas sinkronisasi pengatur waktu atau solusi sinkronisasi data.

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

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID ruang kerja DataWorks. Anda dapat masuk ke Konsol DataWorks dan membuka halaman Workspace untuk mengkueri ID. Anda harus mengonfigurasi parameter ini untuk menentukan ruang kerja DataWorks tempat operasi API diterapkan.	10000
TaskType	string	Yes	Tipe objek yang ingin Anda kueri. Nilai valid: DI_REALTIME: tugas sinkronisasi pengatur waktu DI_SOLUTION: solusi sinkronisasi data	DI_REALTIME
FileId	integer	Yes	Jika Anda mengatur parameter TaskType ke DI_REALTIME, atur parameter FileId ke ID tugas sinkronisasi pengatur waktu yang ingin Anda kueri. Jika Anda mengatur parameter TaskType ke DI_SOLUTION, atur parameter FileId ke ID solusi sinkronisasi data yang ingin Anda kueri. Anda dapat memanggil operasi ListFiles untuk mengkueri ID tugas sinkronisasi pengatur waktu atau solusi sinkronisasi data.	100

Elemen respons

Element	Type	Description	Example
	object	The returned data.
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
RequestId	string	The request ID.	0bc1411515937635973****
Data	object	The status of the real-time synchronization task or data synchronization solution.
Status	string	If the TaskType parameter is set to DI_REALTIME, the Status parameter indicates the status of the real-time synchronization task. Valid values: PAUSE, NORUN, RUN, KILLING, and WAIT. If the TaskType parameter is set to DI_SOLUTION, the Status parameter indicates the status of the data synchronization solution. Valid values: success and fail.	RUN
Message	string	The cause of the failure to obtain the status of the real-time synchronization task or data synchronization solution. If the status of the real-time synchronization task or data synchronization solution is obtained, the value null is returned.	fileId[100] is invalid
Name	string	If the TaskType parameter is set to DI_REALTIME, the Name parameter indicates the name of the real-time synchronization task. If the TaskType parameter is set to DI_SOLUTION, the value null is returned.	streamx_name
SolutionInfo	object	If the TaskType parameter is set to DI_REALTIME, the value null is returned. If the TaskType parameter is set to DI_SOLUTION, the SolutionInfo parameter indicates the details of the data synchronization solution.
Status	string	The status of the data synchronization solution.	run
Id	integer	The ID of the data synchronization solution.	100
CreatorName	string	The creator of the data synchronization solution.	dataworks_3h1
StepDetail	array<object>	The step details of the data synchronization solution.
	object	The returned data.
Status	string	The status of the step in the data synchronization solution.	success
StepId	integer	The ID of the step in the data synchronization solution.	1
StepName	string	The name of the step in the data synchronization solution.	Create a base table
Info	string	The information of the data synchronization solution.	{\"fusionProps\":{\"dataSource\":[{\"fileName\":\"holo_20221020161613\",\"status\":\"SUCCESS\"}]},\"customProps\":{\"showSN\":true,\"columns\":[{\"dataIndex\":\"fileName\",\"width\":0.8,\"title\":\"Real-time synchronization name\"},{\"dataIndex\":\"status\",\"width\":0.2,\"title\":\"Status\"}]},\"componentName\":\"Table\"}

Contoh

Respons sukses

JSONformat

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "RUN",
    "Message": "fileId[100] is invalid",
    "Name": "streamx_name",
    "SolutionInfo": {
      "Status": "run",
      "Id": 100,
      "CreatorName": "dataworks_3h1",
      "StepDetail": [
        {
          "Status": "success",
          "StepId": 1,
          "StepName": "Create a base table",
          "Info": "{\\\"fusionProps\\\":{\\\"dataSource\\\":[{\\\"fileName\\\":\\\"holo_20221020161613\\\",\\\"status\\\":\\\"SUCCESS\\\"}]},\\\"customProps\\\":{\\\"showSN\\\":true,\\\"columns\\\":[{\\\"dataIndex\\\":\\\"fileName\\\",\\\"width\\\":0.8,\\\"title\\\":\\\"Real-time synchronization name\\\"},{\\\"dataIndex\\\":\\\"status\\\",\\\"width\\\":0.2,\\\"title\\\":\\\"Status\\\"}]},\\\"componentName\\\":\\\"Table\\\"}"
        }
      ]
    }
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Param.Invalid	The parameter is invalid.
500	InternalError.System	An internal error occurred.
403	Forbidden.Access	Access is forbidden.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.