Mengambil informasi mengenai tiket perubahan data di Data Management (DMS).
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| Tid |
integer |
No |
ID penyewa. Anda dapat memanggil operasi GetUserActiveTenant atau ListUserTenants untuk mendapatkan ID penyewa. |
3*** |
| OrderId |
integer |
Yes |
ID tiket. Anda dapat memanggil operasi ListOrders untuk mendapatkan ID tiket. |
420**** |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Parameter respons. |
||
| RequestId |
string |
ID permintaan. |
427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D |
| DataCorrectOrderDetail |
object |
Informasi mengenai tiket perubahan data. |
|
| PreCheckDetail |
object |
||
| TaskCheckDO |
array<object> |
Detail pemeriksaan awal tiket. |
|
|
object |
|||
| UserTip |
string |
Pesan yang muncul saat langkah pemeriksaan dijalankan. |
tip messsage |
| CheckStatus |
string |
Status pemeriksaan awal. Nilai yang valid:
|
SUCCESS |
| CheckStep |
string |
Langkah pemeriksaan dalam pemeriksaan awal. Nilai yang valid:
|
PERMISSION_CHECK |
| OrderDetail |
object |
Detail tiket. |
|
| RbSQL |
string |
Pernyataan SQL yang digunakan untuk mengembalikan perubahan data (rollback). |
empty |
| RbAttachmentName |
string |
Nama lampiran yang berisi pernyataan SQL untuk mengembalikan perubahan data (rollback). |
test |
| Classify |
string |
Kategori alasan perubahan data. |
test |
| ExeSQL |
string |
Pernyataan SQL yang dieksekusi. |
update t1 set name = 'xxx' where id <= 100 |
| EstimateAffectRows |
integer |
Perkiraan jumlah baris yang terpengaruh. |
100 |
| RbSQLType |
string |
Format pernyataan SQL yang digunakan untuk mengembalikan perubahan data (rollback). Nilai yang valid:
|
text |
| ActualAffectRows |
integer |
Jumlah baris yang terpengaruh yang diperoleh dari pemeriksaan awal. |
100 |
| IgnoreAffectRows |
boolean |
Menunjukkan apakah hasil pemeriksaan awal diabaikan. Nilai yang valid:
|
false |
| AttachmentName |
string |
Nama lampiran yang berisi pernyataan SQL untuk mengubah data. |
xxx |
| SqlType |
string |
Format pernyataan SQL yang digunakan untuk mengubah data. Nilai yang valid:
|
text |
| IgnoreAffectRowsReason |
string |
Alasan mengapa hasil pemeriksaan awal diabaikan. |
test |
| DatabaseList |
object |
||
| Database |
array<object> |
Informasi mengenai database tempat data diubah. |
|
|
object |
|||
| DbId |
integer |
ID database. |
1860**** |
| DbType |
string |
Engine database. |
mysql |
| Logic |
boolean |
Menunjukkan apakah database tersebut merupakan database logis. Nilai yang valid:
|
false |
| SearchName |
string |
Nama yang digunakan untuk mencari database. |
xxx@xxx:3306 |
| EnvType |
string |
Jenis lingkungan tempat database berada. Nilai yang valid:
|
product |
| Status |
string |
Status spesifik tiket perubahan data. Nilai yang valid: Catatan
Status tiket tidak sepenuhnya setara dengan kode status tiket. Untuk menanyakan kode status tiket, Anda dapat memanggil operasi GetOrderBaseInfo dan memeriksa nilai StatusCode dalam respons.
|
approved |
| ExecMode |
string |
Mode eksekusi tiket setelah disetujui. Nilai yang valid:
|
COMMITOR |
| ConfigDetail |
object |
Konfigurasi tiket. Parameter ini digunakan untuk menyimpan informasi konfigurasi khusus jenis tiket perubahan data. |
|
| DetailType |
string |
Jenis tiket. Nilai yang valid:
|
BIG_FILE |
| FileType |
string |
Jenis file yang akan diimpor. Parameter ini berlaku jika nilai DetailType adalah BIG_FILE. Nilai yang valid:
|
CSV |
| CsvTableName |
string |
Nama tabel tempat data akan diimpor. Parameter ini hanya berlaku jika nilai DetailType adalah BIG_FILE. Jika nilai FileType adalah SQL, parameter ini kosong. |
tb_import_tb_name |
| FileEncoding |
string |
Metode pengkodean file. Parameter ini boleh kosong, yang berarti nilainya AUTO. Nilai yang valid:
|
UTF-8 |
| Cron |
boolean |
Menunjukkan apakah tugas tersebut merupakan tugas terjadwal untuk pembersihan data historis. Parameter ini merupakan parameter cadangan dan hanya berlaku jika nilai DetailType adalah CRON_CLEAR_DATA. |
true |
| CronCallTimes |
integer |
Jumlah kali tugas terjadwal dijalankan. Parameter ini hanya berlaku jika nilai DetailType adalah CRON_CLEAR_DATA. |
0 |
| CronFormat |
string |
Ekspresi CRON tugas terjadwal. Parameter ini hanya berlaku jika nilai DetailType adalah CRON_CLEAR_DATA. |
0 0 2 * * ? |
| Duration |
integer |
Durasi eksekusi tugas terjadwal. Satuan: jam. Parameter ini hanya berlaku jika nilai DetailType adalah CRON_CLEAR_DATA. Jika nilainya lebih besar dari 0, durasi eksekusi telah ditetapkan. |
1 |
| CronStatus |
string |
Status tugas terjadwal. Jika parameter ini kosong, tugas belum dijalankan. Nilai yang valid:
|
SUCCESS |
| CronLastCallStartTime |
string |
Waktu terakhir tugas dijalankan. |
2024-04-19 02:00:00.0 |
| CronNextCallTime |
string |
Waktu tugas akan dijalankan berikutnya. Parameter ini hanya dikembalikan jika nilai CronStatus adalah SUCCESS. |
2024-04-19 02:00:00 |
| CurrentTaskId |
integer |
ID tugas perubahan data saat ini. Ini adalah parameter cadangan dan dapat diabaikan. |
13*** |
| ImportExtConfig |
object |
Informasi konfigurasi tambahan untuk impor data. Parameter ini berlaku jika nilai DetailType adalah BIG_FILE. |
|
| InsertType |
string |
Mode impor data ke tabel tujuan. Nilai yang valid:
Catatan
Parameter ini berlaku jika nilai FileType adalah CSV atau EXCEL. |
INSERT |
| CsvFirstRowIsColumnDef |
boolean |
Menunjukkan apakah baris pertama file CSV berisi nama bidang. Nilai yang valid:
Catatan
Parameter ini berlaku jika nilai FileType adalah CSV atau EXCEL. |
true |
| IgnoreError |
boolean |
Menunjukkan apakah error yang terjadi diabaikan. Nilai yang valid:
|
false |
| ImportMode |
string |
Mode impor. Nilai yang valid:
|
FAST_MODE |
| CronExtConfig |
object |
Informasi konfigurasi tambahan untuk pembersihan data historis. Parameter ini hanya berlaku jika nilai DetailType adalah CRON_CLEAR_DATA. |
|
| OptimizeTableAfterEveryClearTimes |
integer |
Menunjukkan apakah fitur Optimalkan Tabel Secara Berkala diaktifkan. Nilai yang valid:
|
0 |
| CurrentClearTaskCount |
integer |
Jumlah kali defragmentasi dilakukan. Parameter ini hanya berlaku jika nilai OptimizeTableAfterEveryClearTimes lebih besar dari 0. |
0 |
| ErrorCode |
string |
Kode kesalahan yang dikembalikan jika permintaan gagal. |
UnknownError |
| ErrorMessage |
string |
Pesan kesalahan yang dikembalikan jika permintaan gagal. |
UnknownError |
| Success |
boolean |
Menunjukkan apakah operasi berhasil. Nilai yang valid:
|
true |
Contoh
Respons sukses
JSONformat
{
"RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
"DataCorrectOrderDetail": {
"PreCheckDetail": {
"TaskCheckDO": [
{
"UserTip": "tip messsage",
"CheckStatus": "SUCCESS",
"CheckStep": "PERMISSION_CHECK"
}
]
},
"OrderDetail": {
"RbSQL": "empty",
"RbAttachmentName": "test",
"Classify": "test",
"ExeSQL": "update t1 set name = 'xxx' where id <= 100",
"EstimateAffectRows": 100,
"RbSQLType": "text",
"ActualAffectRows": 100,
"IgnoreAffectRows": false,
"AttachmentName": "xxx",
"SqlType": "text",
"IgnoreAffectRowsReason": "test"
},
"DatabaseList": {
"Database": [
{
"DbId": 0,
"DbType": "mysql",
"Logic": false,
"SearchName": "xxx@xxx:3306",
"EnvType": "product"
}
]
},
"Status": "approved",
"ExecMode": "COMMITOR",
"ConfigDetail": {
"DetailType": "BIG_FILE",
"FileType": "CSV",
"CsvTableName": "tb_import_tb_name",
"FileEncoding": "UTF-8",
"Cron": true,
"CronCallTimes": 0,
"CronFormat": "0 0 2 * * ?",
"Duration": 1,
"CronStatus": "SUCCESS",
"CronLastCallStartTime": "2024-04-19 02:00:00.0",
"CronNextCallTime": "2024-04-19 02:00:00\n",
"CurrentTaskId": 0,
"ImportExtConfig": {
"InsertType": "INSERT",
"CsvFirstRowIsColumnDef": true,
"IgnoreError": false,
"ImportMode": "FAST_MODE"
},
"CronExtConfig": {
"OptimizeTableAfterEveryClearTimes": 0,
"CurrentClearTaskCount": 0
}
}
},
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.