Menghapus file dari DataStudio. Jika file tersebut telah dikomit, proses asinkron akan dipicu untuk menghapus file tersebut di sistem penjadwalan. Nilai parameter DeploymentId yang dikembalikan dapat digunakan untuk memanggil operasi GetDeployment guna melakukan polling status proses asinkron tersebut.
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectId |
integer |
No |
ID ruang kerja DataWorks. Anda dapat login ke Konsol DataWorks dan membuka halaman Workspace untuk mendapatkan ID tersebut. Anda harus menentukan salah satu dari parameter ini atau parameter ProjectIdentifier untuk mengidentifikasi ruang kerja DataWorks saat memanggil operasi ini. |
10000 |
| ProjectIdentifier |
string |
No |
Nama ruang kerja DataWorks. Anda dapat login ke Konsol DataWorks dan membuka halaman Workspace untuk mengetahui nama tersebut. Anda harus menentukan salah satu dari parameter ini atau parameter ProjectId untuk mengidentifikasi ruang kerja DataWorks saat memanggil operasi ini. |
dw_project |
| FileId |
integer |
Yes |
ID file. Anda dapat memanggil operasi ListFiles untuk mendapatkan ID folder. |
10000201 |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Hasil yang dikembalikan. |
||
| HttpStatusCode |
integer |
Kode status HTTP. |
200 |
| DeploymentId |
integer |
Jika file telah dikirimkan, operasi DeleteFile juga memicu proses penghapusan asinkron di sistem penjadwalan. Anda harus menggunakan DeploymentId yang dikembalikan oleh operasi DeleteFile untuk memanggil GetDeployment dan melakukan polling status proses penghapusan asinkron yang dipicu tersebut. Jika bidang ini kosong, berarti file telah dihapus dan tidak perlu polling lebih lanjut. |
1000000001 |
| RequestId |
string |
ID permintaan. Digunakan untuk troubleshooting ketika terjadi kesalahan. |
0000-ABCD-EFG**** |
| ErrorMessage |
string |
Pesan kesalahan. |
The connection does not exist. |
| Success |
boolean |
Menunjukkan apakah pemanggilan berhasil. Nilai yang valid:
|
true |
| ErrorCode |
string |
Kode kesalahan. |
Invalid.Tenant.ConnectionNotExists |
Contoh
Respons sukses
JSONformat
{
"HttpStatusCode": 200,
"DeploymentId": 1000000001,
"RequestId": "0000-ABCD-EFG****",
"ErrorMessage": "The connection does not exist.",
"Success": true,
"ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.