All Products
Search

This Product

    Data Management:CreateDataArchiveOrder

    Document Center

    Data Management:CreateDataArchiveOrder

    Last Updated:Jun 11, 2026

    Anda dapat memanggil API ini untuk membuat tiket arsip data dan mengarsipkan data ke penyimpanan khusus, RDS MySQL, atau target lainnya.

    Deskripsi operasi

    Hanya instans database yang dikelola dalam mode Security Collaboration yang dapat memanggil API ini.

    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

    dms:CreateDataArchiveOrder

    create

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    Comment

    string

    Yes

    Deskripsi tugas.

    业务测试
    Tid

    integer

    No

    ID tenant. Anda dapat memanggil operasi GetUserActiveTenant atau ListUserTenants untuk mendapatkan ID tenant.

    3***
    PluginType

    string

    No

    Tipe plug-in. Nilai default: DATA_ARCHIVE.

    DATA_ARCHIVE
    RelatedUserList

    array

    No

    Daftar pengguna terkait.

    string

    No

    ID pengguna yang terkait dengan tiket.

    123***
    ParentId

    integer

    No

    ID tiket induk. Tiket induk diperlukan hanya ketika tiket anak dibuat.

    896****
    Param

    object

    Yes

    Parameter arsip.

    ArchiveMethod

    string

    Yes

    Database tujuan untuk pengarsipan.

    Catatan

    Kecuali penyimpanan bawaan sebagai tujuan arsip, database yang terlibat dalam tujuan arsip lainnya harus ditambahkan ke DMS dan instans harus ditampilkan sebagai sudah login di konsol.

    • inner_oss: penyimpanan khusus (penyimpanan bawaan).

    • oss_userself: OSS pengguna.

    • mysql: RDS MySQL.

    • polardb: PolarDB MySQL.

    • adb_mysql: AnalyticDB for MySQL 3.0.

    • lindorm: Lindorm.

    adb_mysql
    RunMethod

    string

    Yes

    Metode menjalankan tugas arsip.

    • schedule: eksekusi terjadwal.

    • now: eksekusi segera.

    now
    Variables

    array<object>

    No

    Konfigurasi variabel arsip. Pengguna dapat mendefinisikan variabel waktu sebagai kondisi filter untuk pengarsipan. Setiap variabel memiliki dua properti: name dan pattern.

    object

    No

    Konfigurasi variabel arsip.

    {name: "time", pattern: "yyyy-MM-dd|+2d"}
    Name

    string

    No

    Nama variabel waktu. Jika variabel digunakan sebagai kondisi filter arsip, nama harus sama dengan nama variabel yang ditentukan dalam kondisi filter.

    t
    Pattern

    string

    No

    Format variabel waktu. Digunakan untuk mendefinisikan nilai variabel waktu. Untuk informasi lebih lanjut tentang format variabel waktu, lihat Konfigurasi variabel. Contoh format variabel waktu:

    • yyyy-MM-dd|-3d: tiga hari sebelum waktu jalan bisnis.

    • yyyy-MM-dd|-1w: satu minggu sebelum waktu jalan bisnis.

    • yyyy-MM-dd|-4M: empat bulan sebelum waktu jalan bisnis.

    • yyyy-MM-dd|-2y: dua tahun sebelum waktu jalan bisnis.

    • yyyy-MM-dd|-3h: tiga jam sebelum waktu jalan bisnis.

    • yyyy-MM-dd|+5m: lima menit setelah waktu jalan bisnis.

    Catatan

    Bagian pertama yyyy-MM-dd| bersifat tetap. Pada bagian kedua, - menunjukkan sebelum waktu bisnis, dan + menunjukkan setelah waktu bisnis.

    yyyy-MM-dd|-3d
    Logic

    boolean

    No

    Menentukan apakah database adalah database logis.

    false
    TableIncludes

    array<object>

    Yes

    Kumpulan tabel yang akan diarsipkan.

    object

    Yes

    Informasi tentang tabel yang akan diarsipkan.

    TableName

    string

    Yes

    Nama tabel.

    table1
    TableWhere

    string

    No

    Kondisi filter WHERE untuk konfigurasi arsip. Jika variabel waktu digunakan dalam kondisi filter, format kondisi filter adalah: field_name<='${variable_name}'. Nama variabel harus sama dengan nama yang sesuai yang ditentukan dalam parameter Variables.

    gmt_modified<'${t}'
    TableMapping

    array

    No

    Nama tabel di tujuan arsip. Saat memanggil API, Anda tidak perlu menentukan parameter ini, dan sistem menggunakan nilai default.

    string

    No

    Pemetaan tabel arsip.

    table1
    OrderAfter

    array

    No

    Aksi pasca.

    string

    No

    Parameter aksi pasca. Nilai valid:

    • delete: bersihkan data yang diarsipkan di tabel sumber.

    • check: verifikasi data yang diarsipkan (operasi ini mungkin memakan waktu lama).

    • clear: hapus tabel sementara (parameter ini hanya berlaku ketika dua parameter sebelumnya dikonfigurasi pada saat yang sama).

    delete
    SourceCatalogName

    string

    Yes

    Katalog database sumber.

    • def: Untuk database dengan struktur logis dua tingkat seperti MySQL, PolarDB MySQL, dan AnalyticDB MySQL, nilainya tetap def.

    • String kosong: Untuk Lindorm dan MongoDB, masukkan string kosong.

    • Nama katalog: Untuk database dengan struktur logis tiga tingkat seperti PostgreSQL, masukkan nama katalog.

    def
    SourceSchemaName

    string

    Yes

    Skema database sumber. Database sumber dan database tujuan memiliki nama yang sama. Untuk MySQL, ini adalah nama database. Untuk PostgreSQL, ini adalah nama skema.

    schema_test
    SourceInstanceName

    string

    Yes

    Nama instans sumber. Untuk database yang dikelola sendiri atau database di cloud pihak ketiga, Anda dapat memanggil operasi GetInstance untuk mendapatkan nilai parameter InstanceId.

    rm-bp187l****380w
    TargetInstanceHost

    string

    Yes

    Host database tujuan. Jika instans tujuan dapat diakses melalui jaringan internal dan Internet, host internal yang lebih diutamakan untuk ditulis.

    • Jika tujuan arsip adalah OSS, ini adalah nama bucket.

    • Jika tujuan arsip adalah penyimpanan khusus, ini adalah inner_oss.

    amv-bp1****00444.ads.aliyuncs.com
    CronStr

    string

    No

    Masukkan ekspresi Crontab untuk menjalankan tugas secara periodik. Untuk informasi lebih lanjut, lihat Ekspresi Crontab. Parameter ini diperlukan ketika metode jalan adalah pengarsipan terjadwal.

    00 05 11 * * ?
    DatabaseId

    string

    No

    ID database. Untuk database yang dikelola sendiri atau database di cloud pihak ketiga, Anda dapat memanggil operasi GetDatabase untuk mendapatkan ID database. Untuk instans Alibaba Cloud, Anda dapat mengabaikan parameter ini.

    1***

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema Respons

    RequestId

    string

    ID permintaan. Digunakan untuk menemukan log dan memecahkan masalah.

    283C461F-11D8-48AA-B695-DF092DA32AF3
    Success

    boolean

    Menunjukkan apakah permintaan berhasil. Nilai valid:

    • true: Permintaan berhasil.

    • false: Permintaan gagal.

    true
    ErrorMessage

    string

    Pesan kesalahan yang dikembalikan jika panggilan gagal.

    UnknownError
    ErrorCode

    string

    Kode kesalahan yang dikembalikan jika panggilan gagal.

    UnknownError
    CreateOrderResult

    array

    ID tiket arsip data yang dibuat.

    integer

    ID tiket arsip data.

    12*****

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "283C461F-11D8-48AA-B695-DF092DA32AF3",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    0
  ]
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.