Gunakan GetInstance untuk kueri informasi instans-DataWorks-Alibaba Cloud -

Mengkueri informasi tentang sebuah instance.

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

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	integer	Yes	ID instance. Anda dapat memanggil operasi ListInstances untuk mengkueri ID.	1234
ProjectEnv	string	Yes	Lingkungan ruang kerja. Nilai yang valid: PROD dan DEV.	PROD

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
HttpStatusCode	integer	Kode status HTTP.	200
RequestId	string	ID permintaan.	E6F0DBDD-5AD****
ErrorMessage	string	Pesan kesalahan yang dikembalikan ketika instance gagal dijadwalkan.	test
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
ErrorCode	string	Kode kesalahan.	0
Data	object	Detail instance.
Status	string	Status node yang menghasilkan instance. Nilai yang valid: NOT_RUN: Node tidak dijalankan. WAIT_TIME: Node sedang menunggu waktu penjadwalannya tiba. WAIT_RESOURCE: Node sedang menunggu sumber daya. RUNNING: Node sedang berjalan. CHECKING: Kualitas data sedang diperiksa untuk node. CHECKING_CONDITION: Kondisi cabang sedang diperiksa untuk node. FAILURE: Node gagal dijalankan. SUCCESS: Node berhasil dijalankan.	NOT_RUN
CycTime	integer	Waktu penjadwalan instance.	1590422400000
BeginRunningTime	integer	Waktu ketika instance mulai berjalan.	1590416703313
FinishTime	integer	Waktu ketika eksekusi instance selesai.	1590416703313
CreateTime	integer	Waktu ketika instance dibuat.	1590416703313
DagId	integer	ID alur kerja.	338450167
Priority	integer	Prioritas instance. Nilai yang valid: 1, 3, 5, 7, dan 8. Nilai yang lebih besar menunjukkan prioritas yang lebih tinggi. Nilai default: 1.	1
TaskType	string	Jenis penjadwalan node yang menghasilkan instance. Nilai yang valid: NORMAL(0): Node adalah node yang dipicu secara otomatis. Sistem penjadwalan menjalankan node secara berkala. MANUAL(1): Node adalah node yang dipicu secara manual. Sistem penjadwalan tidak menjalankan node secara berkala. PAUSE(2): Node adalah node yang dibekukan. Sistem penjadwalan menjalankan node secara berkala tetapi mengatur status node menjadi failed ketika sistem penjadwalan mulai menjalankan node. SKIP(3): Node adalah node dry-run. Sistem penjadwalan menjalankan node secara berkala tetapi mengatur status node menjadi successful ketika sistem penjadwalan mulai menjalankan node. SKIP_UNCHOOSE(4): Node adalah node yang tidak dipilih dalam alur kerja sementara. Jenis node ini hanya ada dalam alur kerja sementara. Sistem penjadwalan mengatur status node menjadi successful ketika sistem penjadwalan mulai menjalankan node. SKIP_CYCLE(5): Node adalah node yang dijadwalkan berdasarkan minggu atau bulan dan sedang menunggu waktu penjadwalan tiba. Sistem penjadwalan menjalankan node secara berkala tetapi mengatur status node menjadi successful ketika sistem penjadwalan mulai menjalankan node. CONDITION_UNCHOOSE(6): Node tidak dipilih oleh node cabang leluhurnya dan dijalankan sebagai node dry-run. REALTIME_DEPRECATED(7): Node memiliki instance yang dihasilkan secara real time tetapi tidak digunakan lagi. Sistem penjadwalan mengatur status node menjadi successful.	NORMAL(0)
ParamValues	string	Parameter yang terkait dengan node.	bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif
Connection	string	String koneksi.	odps_first
BaselineId	integer	ID baseline.	123123
DqcType	integer	Menunjukkan apakah instance terkait dengan aturan pemantauan di Data Quality. Nilai yang valid: 0: Instance terkait dengan aturan pemantauan di Data Quality. 1: Instance tidak terkait dengan aturan pemantauan di Data Quality.	1
DagType	string	Jenis alur kerja. Nilai yang valid: DAILY: Alur kerja digunakan untuk menjalankan node yang dipicu secara otomatis. MANUAL: Alur kerja digunakan untuk menjalankan node yang dipicu secara manual. SMOKE_TEST: Alur kerja digunakan untuk melakukan pengujian smoke. SUPPLY_DATA: Alur kerja digunakan untuk mengisi ulang data.	DAILY
BusinessId	integer	ID alur kerja.	123
TaskRerunTime	integer	Jumlah berapa kali node dapat dijalankan ulang. Nilai parameter ini dapat berupa kosong atau bilangan bulat yang lebih besar atau sama dengan 0. Jika nilai parameter ini kosong, jumlah berapa kali node dapat dijalankan ulang tidak ditentukan. Jika nilai parameter ini adalah 0, node tidak dapat dijalankan ulang. Jika nilai parameter ini adalah bilangan bulat positif seperti n, node masih dapat dijalankan ulang n kali. Misalnya, jika nilai parameter ini adalah 1, node masih dapat dijalankan ulang satu kali. Jika nilai parameter ini adalah 2, node masih dapat dijalankan ulang dua kali.	0
PeriodNumber	integer	Nomor urut siklus. Parameter ini menunjukkan nomor urut siklus instance pada hari ini.	1
ModifyTime	integer	Waktu ketika instance terakhir kali diubah.	1590416703313
Repeatability	boolean	Menunjukkan apakah node yang menghasilkan instance dapat dijalankan ulang.	true
RepeatInterval	integer	Interval ketika node dijalankan ulang setelah node gagal dijalankan. Unit: milidetik.	60000
InstanceId	integer	ID instance.	11713307578
BeginWaitResTime	integer	Waktu ketika instance mulai menunggu sumber daya.	1590416703313
RelatedFlowId	integer	ID alur kerja tempat node berada.	123123
Bizdate	integer	Stempel waktu data instance. Dalam sebagian besar kasus, nilainya adalah satu hari sebelum waktu ketika instance dijalankan.	1590336000000
NodeName	string	Nama node.	kzh
BeginWaitTimeTime	integer	Waktu ketika instance mulai menunggu untuk dijadwalkan.	1590416703313
DqcDescription	string	Ekspresi filter tabel dan partisi di Data Quality yang terkait dengan node.	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
NodeId	integer	ID node.	33115
CreateUser	string	Pembuat instance.	111
Owner	string	Pemilik instance.	111

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "test",
  "Success": true,
  "ErrorCode": "0",
  "Data": {
    "Status": "NOT_RUN",
    "CycTime": 1590422400000,
    "BeginRunningTime": 1590416703313,
    "FinishTime": 1590416703313,
    "CreateTime": 1590416703313,
    "DagId": 338450167,
    "Priority": 1,
    "TaskType": "NORMAL(0)",
    "ParamValues": "bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif",
    "Connection": "odps_first",
    "BaselineId": 123123,
    "DqcType": 1,
    "DagType": "DAILY",
    "BusinessId": 123,
    "TaskRerunTime": 0,
    "PeriodNumber": 1,
    "ModifyTime": 1590416703313,
    "Repeatability": true,
    "RepeatInterval": 60000,
    "InstanceId": 11713307578,
    "BeginWaitResTime": 1590416703313,
    "RelatedFlowId": 123123,
    "Bizdate": 1590336000000,
    "NodeName": "kzh",
    "BeginWaitTimeTime": 1590416703313,
    "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
    "NodeId": 33115,
    "CreateUser": "111",
    "Owner": "111"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.