All Products
Search

This Product

    :UpdateFile

    Document Center

    :UpdateFile

    Last Updated:Jun 11, 2026

    Memperbarui file.

    Deskripsi operasi

    When you debug or call this operation, you must specify new values for the specified parameters to ensure that the values are different from the original configurations of the file. For example, if the original value of a parameter is A, you must change the value of this parameter to B before you commit the node. If you set the parameter to A, an exception that indicates invalid data occurs.

    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:*

    update

    *All Resource

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    FileFolderPath

    string

    No

    Jalur file.

    Business_process/First_Business_Process/data_integration/Folder_1/Folder_2
    ProjectId

    integer

    No

    ID ruang kerja DataWorks. Anda dapat masuk ke Konsol DataWorks dan membuka halaman Workspace untuk mengkueri ID tersebut.

    10000
    FileName

    string

    No

    Nama file. Anda dapat mengatur parameter FileName ke nilai baru untuk mengubah nama file.

    Anda dapat memanggil operasi ListFiles untuk mengkueri ID file yang namanya ingin diubah. Kemudian, Anda dapat mengatur parameter FileId ke ID tersebut dan mengatur parameter FileName ke nilai baru saat memanggil operasi UpdateFile.

    ods_user_info_d
    FileDescription

    string

    No

    Deskripsi file.

    Here is the file description
    Content

    string

    No

    Kode file. Format kode bervariasi berdasarkan tipe file. Untuk melihat format kode untuk tipe file tertentu, buka Pusat Operasi, klik kanan node dari tipe file tersebut, lalu pilih Tampilan Kode.

    SELECT "1";
    AutoRerunTimes

    integer

    No

    Jumlah rerun otomatis yang diizinkan setelah terjadi error.

    3
    AutoRerunIntervalMillis

    integer

    No

    Interval antara dua rerun otomatis berturut-turut setelah terjadi error. Unit: milidetik. Nilai maksimum: 1800000 (30 menit).

    Parameter ini sesuai dengan parameter Rerun Interval yang ditampilkan setelah kotak centang Auto Rerun upon Error dipilih di bagian Schedule pada tab Properti di Konsol DataWorks.

    Interval yang Anda tentukan di Konsol DataWorks diukur dalam menit. Perhatikan konversi antar unit waktu saat Anda memanggil operasi ini.

    120000
    RerunMode

    string

    No

    Apakah node yang sesuai dengan file dapat di-rerun. Nilai valid:

    • ALL_ALLOWED: Node dapat di-rerun terlepas dari apakah node berhasil dijalankan atau gagal dijalankan.

    • FAILURE_ALLOWED: Node hanya dapat di-rerun setelah gagal dijalankan.

    • ALL_DENIED: Node tidak dapat di-rerun terlepas dari apakah node berhasil dijalankan atau gagal dijalankan.

    Parameter ini sesuai dengan parameter Rerun di bagian Schedule pada tab Properti di Konsol DataWorks.

    Nilai valid:

    • ALL_ALLOWD

    • FAILURE_ALLOWED

    • ALL_DENIED

    • ALL_ALLOWED.

    ALL_ALLOWED
    Stop

    boolean

    No

    Apakah akan menangguhkan penjadwalan node. Nilai valid:

    • true: menangguhkan penjadwalan node.

    • false: tidak menangguhkan penjadwalan node.

    Parameter ini sesuai dengan parameter Recurrence di bagian Schedule pada tab Properti di Konsol DataWorks.

    false
    ParaValue

    string

    No

    Parameter penjadwalan node.

    Parameter ini sesuai dengan bagian Parameters pada tab Properti di Konsol DataWorks. Untuk informasi lebih lanjut, lihat Mengonfigurasi parameter penjadwalan.

    x=a y=b z=c
    StartEffectDate

    integer

    No

    Waktu mulai penjadwalan otomatis. Atur parameter ini ke Stempel waktu UNIX yang mewakili jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC.

    Parameter ini sesuai dengan parameter Validity Period di bagian Schedule pada tab Properti di Konsol DataWorks.

    936923400000
    EndEffectDate

    integer

    No

    Waktu akhir penjadwalan otomatis. Atur parameter ini ke Stempel waktu UNIX yang mewakili jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC.

    Parameter ini sesuai dengan waktu akhir yang ditentukan untuk parameter Validity Period di bagian Schedule pada tab Properti di Konsol DataWorks.

    4155787800000
    CronExpress

    string

    No

    Ekspresi CRON yang mewakili kebijakan penjadwalan periodik node. Parameter ini sesuai dengan parameter Cron Expression di bagian Schedule pada tab Properti di Konsol DataWorks. Setelah Anda mengonfigurasi parameter Scheduling Cycle dan Run At di Konsol DataWorks, DataWorks secara otomatis menghasilkan nilai untuk parameter Cron Expression.

    Contoh:

    • Ekspresi CRON untuk node yang dijadwalkan berjalan pada pukul 05:30 setiap hari: 00 30 05 * * ?

    • Ekspresi CRON untuk node yang dijadwalkan berjalan pada menit ke-15 setiap jam: 00 15 * * * ?

    • Ekspresi CRON untuk node yang dijadwalkan berjalan setiap 10 menit: 00 00/10 * * * ?

    • Ekspresi CRON untuk node yang dijadwalkan berjalan setiap 10 menit dari pukul 08:00 hingga 17:00 setiap hari: 00 00-59/10 8-23 * * * ?

    • Ekspresi CRON untuk node yang dijadwalkan berjalan pada pukul 00:20 di hari pertama setiap bulan: 00 20 00 1 * ?

    • Ekspresi CRON untuk node yang dijadwalkan berjalan setiap tiga bulan dimulai dari pukul 00:10 pada 1 Januari: 00 10 00 1 1-12/3 ?

    • Ekspresi CRON untuk node yang dijadwalkan berjalan pada pukul 00:05 setiap hari Selasa dan Jumat: 00 05 00 * * 2,5

    Sistem penjadwalan DataWorks memberlakukan batasan berikut pada ekspresi CRON:

    • Node dapat dijadwalkan berjalan dengan interval minimum 5 menit.

    • Node dapat dijadwalkan berjalan paling awal pada pukul 00:05 setiap hari.

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

    string

    No

    Tipe siklus penjadwalan node yang sesuai dengan file. Nilai valid: NOT_DAY dan DAY. Nilai NOT_DAY menunjukkan bahwa node dijadwalkan berjalan per menit atau per jam. Nilai DAY menunjukkan bahwa node dijadwalkan berjalan per hari, per minggu, atau per bulan.

    Parameter ini sesuai dengan parameter Scheduling Cycle di bagian Schedule pada tab Properti di Konsol DataWorks.

    NOT_DAY
    DependentType

    string

    No

    Tipe dependensi penjadwalan lintas siklus node. Nilai valid:

    • SELF: Instans yang dihasilkan untuk node pada siklus saat ini bergantung pada instans yang dihasilkan untuk node pada siklus sebelumnya.

    • CHILD: Instans yang dihasilkan untuk node pada siklus saat ini bergantung pada instans yang dihasilkan untuk node turunan pada level terdekat dari node pada siklus sebelumnya.

    • USER_DEFINE: Instans yang dihasilkan untuk node pada siklus saat ini bergantung pada instans yang dihasilkan untuk satu atau beberapa node yang ditentukan pada siklus sebelumnya.

    • NONE: Tidak ada tipe dependensi penjadwalan lintas siklus yang dipilih untuk node.

    USER_DEFINE
    DependentNodeIdList

    string

    No

    ID node yang menjadi dependensi node yang sesuai dengan file saat parameter DependentType diatur ke USER_DEFINE. Beberapa ID dipisahkan dengan koma (,).

    Nilai parameter ini sesuai dengan ID node yang Anda tentukan setelah memilih Previous Cycle dan mengatur Depend On ke Other Nodes di bagian Dependencies pada tab Properti di Konsol DataWorks.

    5,10,15,20
    InputList

    string

    No

    Nama output file induk yang menjadi dependensi file saat ini. Jika Anda menentukan beberapa nama output, pisahkan dengan koma (,).

    Parameter ini sesuai dengan parameter Parent Nodes yang ditampilkan setelah Anda memilih Same Cycle di bagian Dependencies pada tab Properti di Konsol DataWorks.

    Catatan

    Anda harus mengonfigurasi parameter ini saat memanggil operasi CreateDISyncTask atau UpdateFile untuk membuat tugas sinkronisasi batch.

    project_root,project.file1,project.001_out
    ProjectIdentifier

    string

    No

    Nama ruang kerja DataWorks. Anda dapat masuk ke Konsol DataWorks dan membuka halaman Workspace Management untuk mendapatkan nama ruang kerja.

    Anda harus mengonfigurasi parameter ini atau parameter ProjectId untuk menentukan ruang kerja DataWorks tempat operasi diterapkan.

    dw_project
    FileId

    integer

    Yes

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

    100000001
    OutputList

    string

    No

    Nama output file saat ini.

    Parameter ini sesuai dengan parameter Output Name di bagian Dependencies pada tab Properti di Konsol DataWorks.

    dw_project.ods_user_info_d
    ResourceGroupIdentifier

    string

    No

    Pengenal kelompok sumber daya yang digunakan untuk menjalankan node. Anda dapat memanggil operasi ListResourceGroups untuk mengkueri kelompok sumber daya yang tersedia di ruang kerja.

    default_group
    ConnectionName

    string

    No

    Nama sumber data terhubung yang digunakan untuk menjalankan node. Anda dapat memanggil operasi ListDataSources untuk mengkueri sumber data yang tersedia di ruang kerja.

    odps_first
    Owner

    string

    No

    ID pemilik file.

    18023848927592
    AutoParsing

    boolean

    No

    Apakah fitur penguraian otomatis diaktifkan untuk file. Nilai valid:

    • true: Fitur penguraian otomatis diaktifkan untuk file.

    • false: Fitur penguraian otomatis tidak diaktifkan untuk file.

    Parameter ini sesuai dengan parameter Analyze Code yang ditampilkan setelah Same Cycle dipilih di bagian Dependencies pada tab Properti di Konsol DataWorks.

    true
    SchedulerType

    string

    No

    Tipe penjadwalan node. Nilai valid:

    • NORMAL: Node adalah node yang dipicu otomatis.

    • MANUAL: Node adalah node yang dipicu secara manual. Node yang dipicu secara manual tidak dapat dipicu secara otomatis. Node ini sesuai dengan node di panel Manually Triggered Workflows.

    • PAUSE: Node adalah node yang dijeda.

    • SKIP: Node adalah node dry-run. Node dry-run dimulai sesuai jadwal, tetapi sistem mengatur status node menjadi berhasil saat sistem mulai menjalankannya.

    NORMAL
    AdvancedSettings

    string

    No

    Konfigurasi lanjutan node.

    Parameter ini hanya valid untuk node EMR Spark Streaming atau node EMR Streaming SQL. Parameter ini sesuai dengan tab Pengaturan Lanjutan node di Konsol DataWorks.

    Parameter ini dikonfigurasi dalam format JSON.

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

    boolean

    No

    Apakah akan segera menjalankan node setelah node di-deploy ke lingkungan produksi. Nilai valid:

    • true: Node segera dijalankan setelah node di-deploy ke lingkungan produksi.

    • false: Node tidak segera dijalankan setelah node di-deploy ke lingkungan produksi.

    Parameter ini hanya valid untuk node EMR Spark Streaming atau node EMR Streaming SQL. Parameter ini sesuai dengan parameter Start Method di bagian Schedule pada tab Configure di Konsol DataWorks.

    true
    InputParameters

    string

    No

    Parameter input node. Parameter ini dikonfigurasi dalam format JSON. Untuk informasi lebih lanjut tentang parameter input, lihat parameter InputContextParameterList di bagian Response parameters operasi GetFile.

    Parameter ini sesuai dengan tabel Input Parameters di bagian Input and Output Parameters pada tab Properti di Konsol DataWorks.

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

    string

    No

    Parameter output node. Parameter ini dikonfigurasi dalam format JSON. Untuk informasi lebih lanjut tentang parameter output, lihat parameter OutputContextParameterList di bagian Response parameters operasi GetFile.

    Parameter ini sesuai dengan tabel Output Parameters di bagian Input and Output Parameters pada tab Properti di Konsol DataWorks.

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

    boolean

    No

    Apakah akan melewatkan properti dry-run node leluhur dari node. Parameter ini sesuai dengan parameter Skip the dry-run property of the ancestor node yang ditampilkan setelah Anda mengonfigurasi parameter Depend On di bagian Dependencies pada tab Properti di Konsol DataWorks.

    true
    ApplyScheduleImmediately

    boolean

    No

    Apakah konfigurasi penjadwalan langsung berlaku setelah node di-deploy.

    true
    Timeout

    integer

    No

    Periode timeout.

    1
    ImageId

    string

    No

    ID gambar kustom.

    m-uf6d7npxk1hhek8ng0cb

    Elemen respons

    Element

    Type

    Description

    Example

    object

    HttpStatusCode

    integer

    The HTTP status code returned.

    200
    ErrorMessage

    string

    The error message returned.

    The connection does not exist.
    RequestId

    string

    The ID of the request. You can use the ID to troubleshoot issues.

    0000-ABCD-EFGH-IJKLMNOPQ
    ErrorCode

    string

    The error code returned.

    Invalid.Tenant.ConnectionNotExists
    Success

    boolean

    Indicates whether the request is successful. Valid values:

    • true: The request is successful.

    • false: The request fails.

    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.