Otomatisasi Pengarsipan Data dengan API CreateDataArchiveOrder - Data Management

Membuat tiket pengarsipan data untuk mengarsipkan data ke tujuan seperti storage space khusus atau instans ApsaraDB RDS for MySQL.

Deskripsi operasi

Operasi API ini hanya dapat dipanggil untuk instans database yang dikelola dalam mode Security Collaboration.

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
Comment	string	Yes	Deskripsi task.	业务测试
Tid	integer	No	ID tenant. Anda dapat memanggil operasi GetUserActiveTenant atau ListUserTenants untuk mendapatkan ID tenant.	3***
PluginType	string	No	Jenis plug-in. Nilai default: DATA_ARCHIVE.	DATA_ARCHIVE
RelatedUserList	array	No	Daftar pengguna terkait.
	string	No	ID operator yang terkait dengan tiket.	123***
ParentId	integer	No	ID tiket induk. Tiket induk hanya dihasilkan ketika tiket anak dibuat.	896****
Param	object	Yes	Parameter untuk mengarsipkan data.
ArchiveMethod	string	Yes	Tujuan pengarsipan tempat Anda ingin mengarsipkan data. Nilai yang valid: Catatan Jika Anda menetapkan ArchiveMethod ke nilai selain inner_oss, Anda harus mendaftarkan database tujuan yang sesuai ke Data Management (DMS) sebelum membuat tiket pengarsipan data. Setelah database terdaftar di DMS, database tersebut akan ditampilkan di bagian Instances Connected pada Konsol DMS. inner_oss: storage khusus, yaitu bucket Object Storage Service (OSS) bawaan. oss_userself: bucket OSS milik pengguna. mysql: instans ApsaraDB RDS for MySQL. polardb: kluster PolarDB for MySQL. adb_mysql: kluster AnalyticDB for MySQL V3.0. lindorm: instans Lindorm.	adb_mysql
RunMethod	string	Yes	Metode yang digunakan untuk menjalankan task pengarsipan data. Nilai yang valid: schedule: Task pengarsipan data dijadwalkan secara berkala. now: Task pengarsipan data dijalankan segera.	now
Variables	array<object>	No	Konfigurasi variabel pengarsipan. Anda dapat menggunakan variabel waktu sebagai kondisi filter untuk mengarsipkan data. Setiap variabel memiliki dua atribut: name dan pattern.
	object	No	Konfigurasi variabel pengarsipan.	{name: "time", pattern: "yyyy-MM-dd\|+2d"}
Name	string	No	Nama variabel waktu. Jika variabel waktu digunakan sebagai kondisi filter untuk mengarsipkan data, nama variabel harus sama dengan yang ditentukan di TableWhere.	t
Pattern	string	No	Format variabel waktu. Format ini digunakan untuk menentukan nilai variabel waktu. Untuk informasi lebih lanjut, lihat Configure variables. Contoh berikut menunjukkan format variabel waktu: yyyy-MM-dd\|-3d: tiga hari sebelum waktu task dijalankan. yyyy-MM-dd\|-1w: tujuh hari sebelum waktu task dijalankan. yyyy-MM-dd\|-4M: empat bulan sebelum waktu task dijalankan. yyyy-MM-dd\|-2y: dua tahun sebelum waktu task dijalankan. yyyy-MM-dd\|-3h: 3 jam sebelum waktu task dijalankan. yyyy-MM-dd\|+5m: 5 menit setelah waktu task dijalankan. Catatan Dalam contoh-contoh ini, yyyy-MM-dd\| menunjukkan nilai tetap. Untuk bagian sisanya, tanda minus (-) menunjukkan waktu sebelum task dijalankan, dan tanda plus (+) menunjukkan waktu setelah task dijalankan.	yyyy-MM-dd\|-3d
Logic	boolean	No	Menentukan apakah database merupakan database logis.	false
TableIncludes	array<object>	Yes	Kumpulan tabel yang akan diarsipkan.
	object	Yes
TableName	string	Yes	Nama tabel.	table1
TableWhere	string	No	Kondisi filter yang ditentukan oleh klausa WHERE dari konfigurasi pengarsipan. Jika variabel waktu digunakan dalam kondisi filter, kondisi filter ditentukan dalam format berikut: nama field <='${nama variabel}'. Nama variabel dalam kondisi filter harus sama dengan nama variabel waktu yang ditentukan dalam parameter Variables.	gmt_modified<'${t}'
TableMapping	array	No	Nama tabel yang dipetakan ke database tujuan. Parameter ini tidak wajib dan menggunakan nilai default.
	string	No	Nama tabel yang dipetakan ke database tujuan.	table1
OrderAfter	array	No	Perilaku setelah eksekusi.
	string	No	Perilaku pasca-arsip. Nilai yang valid: delete: menghapus data yang diarsipkan dari database sumber. check: memverifikasi data yang diarsipkan. Operasi ini memakan waktu. clear: menghapus tabel temporary. Nilai ini hanya berlaku jika Anda memilih dua nilai lainnya secara bersamaan untuk parameter ini.	delete
SourceCatalogName	string	Yes	Catalog database sumber. Nilai yang valid: def: Tetapkan parameter ini ke def jika database sumber menggunakan skema logis dua lapis, seperti database MySQL, kluster PolarDB for MySQL, atau instans AnalyticDB for MySQL. String kosong: Tetapkan parameter ini ke string kosong jika database sumber adalah instans Lindorm atau ApsaraDB for MongoDB. Nama catalog: Tetapkan parameter ini ke nama catalog database sumber jika database sumber menggunakan skema logis tiga lapis, seperti database PostgreSQL.	def
SourceSchemaName	string	Yes	Nama skema database sumber. Nama skema database sumber sama dengan database tujuan. Jika database sumber adalah database MySQL, parameter ini menentukan nama database sumber. Jika database sumber adalah database PostgreSQL, parameter ini menentukan nama skema database sumber.	schema_test
SourceInstanceName	string	Yes	Nama instans sumber. Jika instans database adalah database yang dikelola sendiri atau database cloud pihak ketiga, Anda dapat memanggil operasi GetInstance untuk menanyakan ID instans.	rm-bp187l****380w
TargetInstanceHost	string	Yes	Host instans tujuan. Jika instans tujuan dapat diakses melalui jaringan internal atau Internet, sebaiknya tetapkan nilainya ke titik akhir internal instans tujuan. Jika data diarsipkan ke bucket OSS, tetapkan nilainya ke nama bucket. Jika data diarsipkan ke storage space khusus, tetapkan nilainya ke inner_oss.	amv-bp1****00444.ads.aliyuncs.com
CronStr	string	No	Ekspresi crontab yang menentukan siklus penjadwalan task pengarsipan data. Untuk informasi lebih lanjut, lihat bagian Crontab expressions pada topik "Create shadow tables for synchronization". Anda harus menentukan parameter ini jika menetapkan RunMethod ke schedule.	00 05 11 * * ?
DatabaseId	string	No	ID database. Jika database adalah database yang dikelola sendiri atau database cloud pihak ketiga, Anda dapat memanggil operasi GetDatabase untuk menanyakan ID database. Jika database adalah database Alibaba Cloud, abaikan parameter ini.	1***

Elemen respons

Element	Type	Description	Example
	object	Skema respons.
RequestId	string	ID permintaan, yang digunakan untuk menanyakan log dan memecahkan masalah.	283C461F-11D8-48AA-B695-DF092DA32AF3
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true false	true
ErrorMessage	string	Pesan kesalahan yang dikembalikan jika permintaan gagal.	UnknownError
ErrorCode	string	Kode kesalahan yang dikembalikan jika permintaan gagal.	UnknownError
CreateOrderResult	array	ID tiket pengarsipan data.
	integer	ID tiket pengarsipan 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.