ConfigureSynchronizationJob - Data Transmission Service - Alibaba Cloud Documentation Center

Konfigurasikan tugas sinkronisasi data.

Sebelum memanggil operasi ini, Anda harus terlebih dahulu memanggil operasi CreateSynchronizationJob untuk membuat instansi sinkronisasi data.

Catatan

Setelah memanggil operasi ini untuk mengonfigurasi tugas sinkronisasi data, tugas tersebut akan secara otomatis dimulai dan menjalani pemeriksaan awal. Anda tidak perlu memanggil operasi StartSynchronizationJob untuk memulainya.
Tugas sinkronisasi data mungkin gagal dimulai akibat kegagalan pemeriksaan awal. Anda dapat memanggil operasi DescribeSynchronizationJobStatus untuk memeriksa status tugas tersebut, lalu menyesuaikan parameter berdasarkan pesan kesalahan terkait kegagalan pemeriksaan awal. Setelah masalah diperbaiki, Anda harus memanggil operasi StartSynchronizationJob untuk me-restart tugas sinkronisasi data.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. Layanan tersebut juga secara otomatis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Wajib	Contoh	Deskripsi
Action	String	Ya	ConfigureSynchronizationJob	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke ConfigureSynchronizationJob.
DataInitialization	Boolean	Ya	true	Menentukan apakah akan melakukan sinkronisasi data penuh awal. Nilai yang valid: true: ya false: tidak Catatan Nilai default: true.
StructureInitialization	Boolean	Ya	true	Menentukan apakah akan melakukan initial schema synchronization. Nilai yang valid: true: ya false: tidak Catatan Nilai default: true.
SynchronizationJobId	String	Ya	dtsz4ao1dor13d****	ID instansi sinkronisasi data. Anda dapat memanggil operasi DescribeSynchronizationJobs untuk menanyakan ID instans tersebut.
SynchronizationObjects	String	Ya	[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]	Objek yang ingin Anda sinkronkan. Nilainya berupa string JSON dan dapat berisi ekspresi reguler. Untuk informasi selengkapnya, lihat SynchronizationObjects.
RegionId	String	Tidak	cn-hangzhou	ID wilayah tempat instansi sinkronisasi data berada. Untuk informasi selengkapnya, lihat List of supported regions.
SynchronizationJobName	String	Tidak	MySQL Synchronization	Nama tugas sinkronisasi data. Catatan Kami menyarankan agar Anda menentukan nama yang informatif agar mudah diidentifikasi. Anda tidak perlu menggunakan nama tugas yang unik.
SynchronizationDirection	String	Tidak	Forward	Arah sinkronisasi. Nilai yang valid: Forward Reverse Catatan Nilai default: Forward. Nilai Reverse hanya berlaku jika topologi instansi sinkronisasi data adalah two-way synchronization.
SourceEndpoint.InstanceId	String	Tidak	rm-bp1i99e8l7913****	ID instans sumber.
SourceEndpoint.InstanceType	String	Tidak	RDS	Jenis instans sumber. Nilai yang valid: RDS: Instans ApsaraDB RDS Redis: Instans ApsaraDB for Redis PolarDB: Kluster PolarDB for MySQL atau kluster PolarDB O Edition ECS: Database yang dikelola sendiri yang di-hosting di Elastic Compute Service (ECS) Express: Database yang dikelola sendiri yang terhubung melalui Express Connect dg: Database yang dikelola sendiri yang terhubung melalui Database Gateway cen: Database yang dikelola sendiri yang terhubung melalui Cloud Enterprise Network (CEN) Catatan Nilai default adalah RDS.
SourceEndpoint.IP	String	Tidak	172.16.88.***	Alamat IP database sumber. Catatan Anda harus menentukan parameter ini hanya jika parameter SourceEndpoint.InstanceType diatur ke ECS, Express, dg, atau cen.
SourceEndpoint.Port	String	Tidak	3306	Nomor port layanan database sumber. Catatan Anda harus menentukan parameter ini hanya jika parameter SourceEndpoint.InstanceType diatur ke ECS, Express, dg, atau cen.
SourceEndpoint.UserName	String	Tidak	dtstestaccount	Akun database dari database sumber. Catatan Anda harus menentukan parameter ini hanya jika parameter SourceEndpoint.InstanceType diatur ke ECS, Express, dg, atau cen. Jika parameter SourceEndpoint.InstanceType diatur ke Redis, Anda tidak perlu menentukan akun database. Izin yang dibutuhkan untuk akun database bervariasi tergantung skenario sinkronisasi. Untuk informasi selengkapnya, lihat Overview of data synchronization scenarios.
SourceEndpoint.Password	String	Tidak	Test123456	Password akun database sumber. Catatan Anda harus menentukan parameter ini hanya jika parameter SourceEndpoint.InstanceType diatur ke ECS, Express, dg, atau cen.
DestinationEndpoint.InstanceId	String	Tidak	rm-bp1r46452ai50****	ID instans tujuan. Catatan Jika parameter DestinationEndpoint.InstanceType diatur ke MaxCompute atau DataHub, Anda harus menentukan nama proyek MaxCompute atau proyek DataHub. Jika instans tujuan adalah kluster AnalyticDB for MySQL, tentukan ID kluster AnalyticDB for MySQL tersebut.
DestinationEndpoint.InstanceType	String	Tidak	RDS	Jenis instans tujuan. Nilai yang valid: Redis: Instans ApsaraDB for Redis RDS: Instans ApsaraDB RDS PolarDB: Kluster PolarDB for MySQL atau kluster PolarDB O Edition ECS: Database yang dikelola sendiri yang di-hosting di ECS Express: Database yang dikelola sendiri yang terhubung melalui Express Connect DataHub: Proyek DataHub MaxCompute: Proyek MaxCompute AnalyticDB: Kluster AnalyticDB for MySQL V3.0 atau V2.0 Greenplum: Instans AnalyticDB for PostgreSQL Catatan Nilai default adalah RDS.
DestinationEndpoint.IP	String	Tidak	172.16.88.***	Alamat IP database tujuan. Catatan Anda harus menentukan parameter ini hanya jika parameter DestinationEndpoint.InstanceType diatur ke Express, dg, atau cen.
DestinationEndpoint.Port	String	Tidak	3306	Nomor port layanan database tujuan. Catatan Anda harus menentukan parameter ini hanya jika parameter DestinationEndpoint.InstanceType diatur ke ECS, Express, dg, atau cen.
DestinationEndpoint.UserName	String	Tidak	dtstestaccount	Akun database dari database tujuan. Catatan Izin yang dibutuhkan untuk akun database bervariasi tergantung skenario sinkronisasi. Untuk informasi selengkapnya, lihat Overview of data synchronization scenarios. Jika parameter DestinationEndpoint.InstanceType diatur ke ECS, Express, dg, atau cen, Anda harus menentukan parameter DestinationEndpoint.UserName. Jika parameter DestinationEndpoint.InstanceType diatur ke RDS dan versi database adalah MySQL 5.5 atau MySQL 5.6, Anda tidak perlu menentukan parameter DestinationEndpoint.UserName dan DestinationEndpoint.Password. Jika parameter DestinationEndpoint.InstanceType diatur ke Redis, Anda tidak perlu menentukan parameter DestinationEndpoint.UserName.
DestinationEndpoint.Password	String	Tidak	Test654321	Password akun database tujuan. Catatan Jika parameter DestinationEndpoint.InstanceType diatur ke ECS, Express, dg, atau cen, Anda harus menentukan parameter DestinationEndpoint.Password.
SourceEndpoint.OwnerID	String	Tidak	140692647406****	ID Akun Alibaba Cloud yang memiliki instans RDS sumber. Catatan Anda dapat menentukan parameter ini untuk menyinkronkan data lintas akun Alibaba Cloud yang berbeda. Dalam kasus ini, Anda juga perlu menentukan parameter SourceEndpoint.Role.
SourceEndpoint.Role	String	Tidak	ram-for-dts	Nama role RAM yang dikonfigurasi untuk Akun Alibaba Cloud yang memiliki instans sumber. Catatan Anda harus menentukan parameter ini saat menyinkronkan data lintas akun Alibaba Cloud yang berbeda. Untuk informasi tentang izin dan metode otorisasi role RAM, lihat Configure RAM authorization for cross-account data migration and synchronization.
PartitionKey.ModifyTime_Year	Boolean	Tidak	true	Menentukan apakah tabel data inkremental berisi partisi yang ditentukan oleh field modifytime_year. Nilai yang valid: true dan false. Catatan Parameter ini tersedia hanya jika parameter DestinationEndpoint.InstanceType diatur ke MaxCompute.
PartitionKey.ModifyTime_Month	Boolean	Tidak	true	Menentukan apakah tabel data inkremental berisi partisi yang ditentukan oleh field modifytime_month. Nilai yang valid: true dan false. Catatan Parameter ini tersedia hanya jika parameter DestinationEndpoint.InstanceType diatur ke MaxCompute.
PartitionKey.ModifyTime_Day	Boolean	Tidak	true	Menentukan apakah tabel data inkremental berisi partisi yang ditentukan oleh field modifytime_day. Nilai yang valid: true dan false. Catatan Parameter ini tersedia hanya jika parameter DestinationEndpoint.InstanceType diatur ke MaxCompute.
PartitionKey.ModifyTime_Hour	Boolean	Tidak	true	Menentukan apakah tabel data inkremental berisi partisi yang ditentukan oleh field modifytime_hour. Nilai yang valid: true dan false. Catatan Parameter ini tersedia hanya jika parameter DestinationEndpoint.InstanceType diatur ke MaxCompute.
PartitionKey.ModifyTime_Minute	Boolean	Tidak	true	Menentukan apakah tabel data inkremental berisi partisi yang ditentukan oleh field modifytime_minute. Nilai yang valid: true dan false. Catatan Parameter ini tersedia hanya jika parameter DestinationEndpoint.InstanceType diatur ke MaxCompute.
MigrationReserved	String	Tidak	{ "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }	Parameter cadangan DTS. Nilainya berupa string JSON. Anda dapat menentukan parameter ini untuk memenuhi persyaratan khusus, misalnya apakah akan secara otomatis memulai pemeriksaan awal. Untuk informasi selengkapnya, lihat MigrationReserved. Catatan Parameter ini dapat digunakan untuk sinkronisasi data antar instans ApsaraDB for Redis Edisi Perusahaan. Untuk informasi selengkapnya, lihat Use OpenAPI Explorer to configure one-way or two-way data synchronization between ApsaraDB for Redis Enterprise Edition instances.
Checkpoint	String	Tidak	1610540493	Checkpoint sinkronisasi.
AccountId	String	Tidak	12323344****	ID Akun Alibaba Cloud. Anda tidak perlu menentukan parameter ini karena parameter ini akan dihapus di masa mendatang.
SourceEndpoint.DatabaseName	String	Tidak	dtstestdata	Nama database tempat objek sinkronisasi pada instans sumber berada.
DestinationEndpoint.DataBaseName	String	Tidak	dtstestdata	Nama database tempat objek sinkronisasi pada instans tujuan berada.

Parameter respons

Parameter	Type	Contoh	Deskripsi
ErrCode	String	InternalError	Kode kesalahan yang dikembalikan jika pemanggilan gagal.
ErrMessage	String	The request processing has failed due to some unknown error.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
RequestId	String	2690E467-7773-43BC-A009-370EE2E7****	ID permintaan.
Success	String	true	Menunjukkan apakah pemanggilan berhasil.

Contoh

Permintaan contoh

http(s)://dts.aliyuncs.com/?Action=ConfigureSynchronizationJob
&DataInitialization=true
&StructureInitialization=true
&SynchronizationJobId=dtsz4ao1dor13d****
&SynchronizationObjects=[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]
&<Common request parameters>

Respons sukses contoh

XML format

<ConfigureSynchronizationJobResponse>
      <RequestId>2690E467-7773-43BC-A009-370EE2E7****</RequestId>
      <Success>true</Success>
</ConfigureSynchronizationJobResponse>

JSON format

{
    "RequestId": "2690E467-7773-43BC-A009-370EE2E7****",
    "Success": true
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.