All Products
Search

This Product

    DataWorks:UpdateFile

    Document Center

    DataWorks:UpdateFile

    Last Updated:Jun 11, 2026

    Memperbarui file.

    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
    FileFolderPath

    string

    No

    Jalur ke folder tempat file berada.

    Business_process/First_Business_Process/data_integration/Folder_1/Folder_2
    ProjectId

    integer

    No

    ID ruang kerja DataWorks. Untuk mendapatkan ID, masuk ke Konsol DataWorks dan buka halaman manajemen ruang kerja.

    100001
    FileName

    string

    No

    Nama file. Anda dapat mengubah nama file dengan menetapkan nilai baru untuk FileName. Misalnya, Anda dapat memanggil operasi ListFiles untuk mengkueri ID file di direktori target, lalu memanggil operasi UpdateFile dengan ID file yang ditentukan di parameter FileId dan nilai baru yang ditentukan di parameter FileName untuk mengubah nama file.

    ods_user_info_d
    FileDescription

    string

    No

    Deskripsi file.

    Here is the file description
    Content

    string

    No

    Konten kode file. Jenis kode yang berbeda (fileType) memiliki format kode yang berbeda. Di Pusat Operasi, Anda dapat mengklik kanan tugas jenis yang sesuai dan memilih Lihat Kode untuk melihat format kode spesifik.

    SELECT "1";
    AutoRerunTimes

    integer

    No

    Jumlah pengulangan otomatis setelah eksekusi file gagal.

    3
    AutoRerunIntervalMillis

    integer

    No

    Interval pengulangan otomatis node setelah kegagalan. Unit: milidetik. Nilai maksimum: 1800000 milidetik (30 menit).

    Parameter ini sesuai dengan parameter Interval pengulangan di Properti > Penjadwalan > Pengulangan Otomatis saat Kegagalan untuk node pengembangan data di Konsol DataWorks. Di konsol, unit interval pengulangan adalah menit. Konversi unit waktu saat Anda memanggil operasi ini.

    120000
    RerunMode

    string

    No

    Kebijakan pengulangan. Nilai valid:

    • ALL_ALLOWED: Pengulangan diizinkan terlepas dari apakah Tugas berhasil atau gagal.

    • FAILURE_ALLOWED: Pengulangan hanya diizinkan saat Tugas gagal.

    • ALL_DENIED: Pengulangan tidak diizinkan terlepas dari apakah Tugas berhasil atau gagal.

    Parameter ini sesuai dengan pengaturan Dukungan untuk Pengulangan di Penjadwalan > Kebijakan Penjadwalan untuk Tugas Data Studio di Konsol DataWorks.

    Nilai valid:

    • ALL_ALLOWD

    • FAILURE_ALLOWED

    • ALL_DENIED

    • ALL_ALLOWED.

    ALL_ALLOWED
    Stop

    boolean

    No

    Apakah akan melewati eksekusi. Nilai valid:

    • true

    • false

    Parameter ini sesuai dengan opsi Lewati Eksekusi di Properti > Penjadwalan > Pengulangan untuk node pengembangan data di Konsol DataWorks.

    false
    ParaValue

    string

    No

    Parameter penjadwalan node.

    Parameter ini sesuai dengan pengaturan Parameter Penjadwalan di Properti untuk node pengembangan data di Konsol DataWorks. Untuk informasi lebih lanjut, lihat Parameter penjadwalan.

    x=a y=b z=c
    StartEffectDate

    integer

    No

    Stempel waktu (dalam milidetik) saat penjadwalan otomatis dimulai.

    Parameter ini sesuai dengan Waktu mulai Periode Efektif di Penjadwalan > Waktu Penjadwalan untuk tugas Data Studio di Konsol DataWorks.

    936923400000
    EndEffectDate

    integer

    No

    Stempel waktu (dalam milidetik) saat penjadwalan otomatis berhenti.

    Parameter ini sesuai dengan Waktu berakhir Periode Efektif di Penjadwalan > Waktu Penjadwalan untuk tugas Data Studio di Konsol DataWorks.

    4155787800000
    CronExpress

    string

    No

    Ekspresi cron untuk eksekusi terjadwal. Parameter ini sesuai dengan pengaturan Ekspresi cron di Penjadwalan > Waktu Penjadwalan untuk tugas Data Studio di Konsol DataWorks. Setelah Anda mengonfigurasi Siklus Penjadwalan dan Waktu Terjadwal, DataWorks secara otomatis menghasilkan ekspresi cron.

    Contoh:

    • Terjadwal pada pukul 05:30 setiap hari: 00 30 05 * * ?

    • Terjadwal pada menit ke-15 setiap jam: 00 15 * * * ?

    • Terjadwal setiap 10 menit: 00 00/10 * * * ?

    • Terjadwal setiap 10 menit antara pukul 08:00 dan 23:00 setiap hari: 00 00-59/10 8-23 * * * ?

    • Terjadwal pada pukul 00:20 pada hari pertama setiap bulan: 00 20 00 1 * ?

    • Terjadwal setiap 3 bulan mulai dari pukul 00:10 pada 1 Januari: 00 10 00 1 1-12/3 ?

    • Terjadwal pada pukul 00:05 setiap hari Selasa dan Jumat: 00 05 00 * * 2,5

    Karena aturan sistem penjadwalan DataWorks, ekspresi cron memiliki batasan berikut:

    • Interval penjadwalan minimum adalah 5 menit.

    • Waktu penjadwalan paling awal setiap hari adalah 00:05.

    00 00-59/5 1-23 * * ?
    CycleType

    string

    No

    Tipe siklus penjadwalan. Nilai valid: NOT_DAY (menit, jam) dan DAY (hari, minggu, bulan).

    Parameter ini sesuai dengan pengaturan Siklus Penjadwalan di Penjadwalan > Waktu Penjadwalan untuk Tugas Data Studio di Konsol DataWorks.

    NOT_DAY
    DependentType

    string

    No

    Mode dependensi pada siklus sebelumnya. Nilai valid:

    • SELF: Bergantung pada node saat ini.

    • CHILD: Bergantung pada node anak.

    • USER_DEFINE: Bergantung pada node lain.

    • NONE: Tidak ada dependensi. Tidak bergantung pada siklus sebelumnya.

    USER_DEFINE
    DependentNodeIdList

    string

    No

    ID node yang menjadi dependensi node saat ini. Parameter ini hanya berlaku saat parameter DependentType diatur ke USER_DEFINE. Pisahkan beberapa ID node dengan koma (,).

    Parameter ini sesuai dengan opsi Node Lain di Properti > Dependensi > Dependensi Lintas Siklus (Dependensi Siklus Sebelumnya Asli) untuk node pengembangan data di Konsol DataWorks.

    5,10,15,20
    InputList

    string

    No

    Nama output dari node leluhur yang menjadi dependensi node saat ini. Pisahkan beberapa nama output dengan koma (,).

    Parameter ini sesuai dengan pengaturan Nama Output Node Leluhur di Properti > Dependensi untuk node pengembangan data di Konsol DataWorks.

    Catatan

    Parameter ini wajib saat Anda memanggil operasi CreateDISyncTask atau UpdateFile untuk membuat node sinkronisasi Batch.

    project_root,project.file1,project.001_out
    ProjectIdentifier

    string

    No

    Nama ruang kerja DataWorks. Untuk mendapatkan nama ruang kerja, masuk ke Konsol DataWorks dan buka halaman konfigurasi ruang kerja.

    Anda harus menentukan parameter ini atau ProjectId untuk mengidentifikasi ruang kerja DataWorks target untuk panggilan API ini.

    dw_project
    FileId

    integer

    Yes

    ID file. Anda dapat memanggil operasi ListFiles untuk mendapatkan ID file.

    100000001
    OutputList

    string

    No

    Output node.

    Parameter ini sesuai dengan pengaturan Nama Output di Properti > Dependensi untuk node pengembangan data di Konsol DataWorks.

    dw_project.ods_user_info_d
    ResourceGroupIdentifier

    string

    No

    Kelompok sumber daya untuk Tugas yang dipublikasikan dari file. Anda dapat memanggil operasi ListResourceGroups untuk mengkueri kelompok sumber daya yang tersedia di ruang kerja.

    default_group
    ConnectionName

    string

    No

    Nama Sumber data yang digunakan untuk menjalankan node. Anda dapat memanggil operasi ListDataSources untuk mengkueri Sumber data yang tersedia.

    odps_source
    Owner

    string

    No

    ID Pemilik file.

    18023848927592
    AutoParsing

    boolean

    No

    Apakah akan mengaktifkan Penguraian otomatis untuk file. Nilai valid:

    • true

    • false

    Parameter ini sesuai dengan pengaturan Analisis Kode di Properti > Dependensi untuk node pengembangan data di Konsol DataWorks.

    true
    SchedulerType

    string

    No

    Tipe penjadwalan. Nilai valid:

    • NORMAL: Tugas terjadwal Normal.

    • MANUAL: Node yang dipicu secara manual. Tidak dijadwalkan untuk eksekusi harian. Sesuai dengan node dalam alur kerja yang dipicu secara manual.

    • PAUSE: Tugas yang dijeda.

    • SKIP: Tugas dry-run. Dijadwalkan untuk eksekusi harian tetapi langsung ditandai berhasil saat penjadwalan dimulai.

    NORMAL
    AdvancedSettings

    string

    No

    Pengaturan lanjutan untuk Tugas.

    Parameter ini sesuai dengan Pengaturan Lanjutan di panel navigasi sisi kanan pada halaman pengeditan untuk Tugas EMR Spark Streaming dan EMR Streaming SQL di Data Studio di Konsol DataWorks.

    Saat ini, hanya Tugas EMR Spark Streaming dan EMR Streaming SQL yang mendukung parameter ini, dan parameter harus dalam format JSON.

    {"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}
    StartImmediately

    boolean

    No

    Apakah akan memulai Tugas segera setelah dipublikasikan. Nilai valid:

    • true: Memulai Tugas segera setelah dipublikasikan.

    • false: Tidak memulai Tugas segera setelah dipublikasikan.

    Parameter ini sesuai dengan pengaturan Metode Mulai di Konfigurasi > Kebijakan Penjadwalan di panel navigasi sisi kanan pada halaman pengeditan untuk Tugas EMR Spark Streaming dan EMR Streaming SQL di Data Studio di Konsol DataWorks.

    true
    InputParameters

    string

    No

    Parameter konteks input node. Nilai harus dalam format JSON. Untuk informasi lebih lanjut tentang struktur parameter, lihat parameter InputContextParameterList di parameter tanggapan operasi GetFile.

    Parameter ini sesuai dengan pengaturan Parameter Input di Properti > Parameter Input dan Output untuk node pengembangan data di Konsol DataWorks.

    [{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]
    OutputParameters

    string

    No

    Parameter konteks output node. Nilai harus dalam format JSON. Untuk informasi lebih lanjut tentang struktur parameter, lihat parameter OutputContextParameterList di parameter tanggapan operasi GetFile.

    Parameter ini sesuai dengan pengaturan Parameter Output di Properti > Parameter Input dan Output untuk node pengembangan data di Konsol DataWorks.

    [{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
    IgnoreParentSkipRunningProperty

    boolean

    No

    Parameter ini sesuai dengan opsi Lewati Properti Dry-Run Node Leluhur di Properti > Dependensi > Dependensi Lintas Siklus (Dependensi Siklus Sebelumnya Asli) saat Instans Node Saat Ini atau Node Anak Tingkat-1 dipilih untuk node pengembangan data di Konsol DataWorks.

    true
    ApplyScheduleImmediately

    boolean

    No

    Apakah akan menerapkan konfigurasi penjadwalan segera setelah file dipublikasikan.

    true
    Timeout

    integer

    No

    Pengaturan timeout untuk konfigurasi penjadwalan.

    1
    ImageId

    string

    No

    ID gambar kustom.

    m-uf6d7npxk1hhek8ng0cb

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The response.

    HttpStatusCode

    integer

    The HTTP status code.

    200
    ErrorMessage

    string

    The error message.

    The connection does not exist.
    RequestId

    string

    The request ID. Use this ID to troubleshoot issues.

    0000-ABCD-EFGH-IJKLMNOPQ
    ErrorCode

    string

    The error code.

    Invalid.Tenant.ConnectionNotExists
    Success

    boolean

    Indicates whether the call succeeded. Valid values:

    • true: The call succeeded.

    • false: The call failed.

    true

    Contoh

    Respons sukses

    JSONformat

    {
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFGH-IJKLMNOPQ",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

    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.