DescribeSynchronizationJobs - Data Transmission Service - Alibaba Cloud Documentation Center

Gunakan API ini untuk mendapatkan daftar instance sinkronisasi data beserta detailnya.

Debugging

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

Parameter permintaan

Parameter	Type	Wajib	Contoh	Deskripsi
Action	String	Ya	DescribeSynchronizationJobs	Tindakan API. Nilai yang valid: `DescribeSynchronizationJobs`
RegionId	String	Tidak	cn-hangzhou	ID wilayah dari instansi sinkronisasi data. Untuk informasi selengkapnya, lihat Daftar wilayah yang didukung.
PageSize	Integer	Tidak	30	Jumlah entri yang ditampilkan per halaman. Nilai yang valid: 10, 20, dan 30. Nilai default: 30. Nilai maksimum: 30.
PageNum	Integer	Tidak	1	Nomor halaman. Nilainya harus lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data Integer. Nilai default: 1.
SynchronizationJobName	String	Tidak	MySQL Synchronization	Nama tugas sinkronisasi data. Catatan Pencocokan fuzzy didukung.
ClientToken	String	Tidak	0c593ea1-3bea-11e9-b96b-88e9fe63****	Nilai unik yang dihasilkan oleh client untuk setiap permintaan guna memastikan idempotensi. Hanya mendukung karakter ASCII dan tidak boleh melebihi 64 karakter.
AccountId	String	Tidak	12323344****	ID akun Alibaba Cloud Anda. Anda tidak perlu mengatur parameter ini karena akan segera ditinggalkan.
Tag.N.Key	String	Ya	testkey1	Kunci tag. Anda dapat memperolehnya dengan memanggil API ListTagResources. Catatan N menentukan nomor urut tag. Misalnya, Tag.1.Key menentukan kunci tag pertama, dan Tag.2.Key menentukan kunci tag kedua. Anda dapat menentukan 1 hingga 20 kunci tag sekaligus. Parameter ini tidak boleh berupa string kosong.
Tag.N.Value	String	Tidak	testvalue1	Nilai tag. Anda dapat memperolehnya dengan memanggil API ListTagResources. Catatan N menentukan nomor urut tag. Misalnya, Tag.1.Value menentukan nilai tag pertama, dan Tag.2.Value menentukan nilai tag kedua. Anda dapat menentukan 1 hingga 20 nilai tag sekaligus. Nilai tag dapat berupa string kosong.
ResourceGroupId	String	Tidak	rg-acfmzawhxxc****	ID kelompok sumber daya.

Parameter respons

Parameter	Type	Contoh	Deskripsi
PageNumber	Integer	1	Nomor halaman dari hasil yang dikembalikan.
RequestId	String	92E1E99D-5224-4AD3-8C94-23A3516B****	ID permintaan unik.
PageRecordCount	Integer	30	Jumlah maksimum entri yang dapat ditampilkan pada halaman saat ini.
TotalRecordCount	Long	100	Total jumlah instansi sinkronisasi data yang dimiliki oleh akun Alibaba Cloud Anda.
SynchronizationInstances	Array of SynchronizationInstance		Daftar instansi sinkronisasi data beserta detailnya.
DataInitialization	String	true	Menunjukkan apakah sinkronisasi data penuh dilakukan. Nilai yang valid: `true`: ya. `false`: tidak.
Status	String	synchronizing	Status saat ini dari tugas sinkronisasi data. Nilai yang valid: `NotStarted`: Tugas belum dimulai. `Prechecking`: Tugas sedang dalam pemeriksaan awal. `PrecheckFailed`: Tugas gagal dalam pemeriksaan awal. `Initializating` : Tugas sedang melakukan sinkronisasi awal. `InitializeFailed`: Sinkronisasi awal gagal. `Synchronizing`: Tugas sedang menyinkronkan data. `Failed`: Tugas gagal menyinkronkan data. `Suspending`: Tugas dijeda. `Modifying`: Objek dalam tugas sedang dimodifikasi. `Finished`: Tugas selesai.
SynchronizationJobName	String	MySQL Synchronization	Nama tugas sinkronisasi data.
Delay	String	0	Latensi sinkronisasi. Unit: detik.
ErrorMessage	String	DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].	Pesan kesalahan yang dikembalikan jika sinkronisasi data gagal.
ExpireTime	String	2021-07-07T16:00:00Z	Waktu kedaluwarsa instansi sinkronisasi data dalam format yyyy-MM-ddTHH:mm:ssZ (UTC). Catatan Parameter ini hanya dikembalikan jika nilai kembali parameter `PayType` adalah `PrePaid`.
CreateTime	String	2021-06-28 17:34:53.0	Waktu pembuatan tugas sinkronisasi data dalam format yyyy-MM-dd HH:mm:ss.0 (UTC+8).
PayType	String	PrePaid	Metode penagihan instansi sinkronisasi data. Nilai yang valid: `PrePaid`: langganan. `PostPaid`: pay-as-you-go.
StructureInitialization	String	true	Menunjukkan apakah sinkronisasi skema dilakukan. Nilai yang valid: `true`: ya `false`: tidak
SynchronizationJobClass	String	large	Spesifikasi instansi sinkronisasi data.
InstanceCreateTime	String	2021-06-28T09:36:32Z	Waktu pembuatan instans dalam format yyyy-MM-ddTHH:mm:ssZ (UTC).
SynchronizationJobId	String	dtsexjk1alb116****	ID instansi sinkronisasi data.
SynchronizationDirection	String	Forward	Arah sinkronisasi. Nilai yang valid: Forward: maju. Reverse: mundur.
JobCreateTime	String	2021-06-28T09:34:53Z	Waktu pembuatan tugas sinkronisasi data dalam format yyyy-MM-ddTHH:mm:ssZ (UTC).
Tags	Array of Tag		Kumpulan tag.
Key	String	testkey1	Kunci tag.
Value	String	testvalue1	Nilai tag yang sesuai dengan kunci tag tersebut.
SynchronizationObjects	Array of SynchronizationObject		Objek yang disinkronkan oleh tugas tersebut.
NewSchemaName	String	newdtstestdatabase	Nama database yang digunakan di instans tujuan.
SchemaName	String	dtstestdatabase	Nama database yang disinkronkan.
TableExcludes	Array of TableExclude		Tabel sumber yang dikecualikan dari tugas sinkronisasi data.
TableName	String	order	Nama tabel yang dikecualikan.
TableIncludes	Array of TableInclude		Tabel yang disinkronkan oleh tugas tersebut.
TableName	String	customer	Nama tabel yang disinkronkan.
DataInitializationStatus	Object		Status sinkronisasi data penuh.
Status	String	Finished	Status sinkronisasi data penuh. Nilai yang valid: `NotStarted`: Sinkronisasi data penuh belum dimulai. `Migrating`: Sinkronisasi data penuh sedang berlangsung. `Failed`: Sinkronisasi data penuh gagal. `Finished`: Sinkronisasi data penuh selesai.
Percent	String	100	Kemajuan sinkronisasi data penuh. Unit: %.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	Pesan kesalahan yang dikembalikan jika sinkronisasi data penuh gagal.
Progress	String	200001	Jumlah entri yang telah disinkronkan selama sinkronisasi data penuh.
DataSynchronizationStatus	Object		Status sinkronisasi data inkremental. Catatan Parameter ini dan sub-parameternya tidak lagi tersedia.
Status	String	Finished	Status sinkronisasi data inkremental. Catatan Parameter ini tidak lagi tersedia.
Delay	String	0	Latensi sinkronisasi data inkremental. Catatan Parameter ini tidak lagi tersedia.
Percent	String	100	Kemajuan sinkronisasi data inkremental. Catatan Parameter ini tidak lagi tersedia.
ErrorMessage	String	The task has failed for a long time and cannot be recovered	Pesan kesalahan yang dikembalikan jika sinkronisasi data inkremental gagal. Catatan Parameter ini tidak lagi tersedia.
DestinationEndpoint	Object		Pengaturan koneksi instans tujuan.
InstanceId	String	rm-bp162d4tp0500****	ID instans tujuan.
IP	String	172.16.88.***	Titik akhir instans tujuan.
InstanceType	String	RDS	Jenis instans tujuan.
Port	String	3306	Port layanan database instans tujuan.
UserName	String	dtstest	Akun database instans tujuan.
EngineName	String	MySQL	Jenis database instans tujuan.
Performance	Object		Kinerja instansi sinkronisasi data.
RPS	String	100	Jumlah pernyataan SQL yang disinkronkan per detik, termasuk pernyataan `BEGIN`, `COMMIT`, `DML`, dan `DDL`. Pernyataan DML mencakup `INSERT`, `DELETE`, dan `UPDATE`.
FLOW	String	1	Trafik data yang disinkronkan per detik. Unit: MB/s.
PrecheckStatus	Object		Status pemeriksaan awal.
Status	String	Success	Hasil pemeriksaan awal. Nilai yang valid: `Success`: Tugas lulus pemeriksaan awal. `Failed`: Tugas gagal dalam pemeriksaan awal.
Percent	String	100	Kemajuan pemeriksaan awal. Unit: %.
Detail	Array of CheckItem		Hasil setiap item pemeriksaan awal.
CheckStatus	String	Success	Hasil pemeriksaan awal. Nilai yang valid: `Success`: Tugas lulus pemeriksaan awal. `Failed`: Tugas gagal dalam pemeriksaan awal.
ErrorMessage	String	Original error: Access denied for user 'dtstest'@'100.104.*.' (using password: YES)	Pesan kesalahan yang dikembalikan jika tugas gagal dalam pemeriksaan awal. Catatan Parameter ini hanya dikembalikan jika nilai kembali parameter `CheckStatus` adalah `Failed`.
ItemName	String	CHECK_CONN_SRC	Nama item pemeriksaan awal.
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	Metode untuk memperbaiki kegagalan pemeriksaan awal. Catatan Parameter ini hanya dikembalikan jika nilai kembali parameter `CheckStatus` adalah `Failed`.
SourceEndpoint	Object		Pengaturan koneksi instans sumber.
InstanceId	String	rm-bp1i99e8l7913****	ID instans sumber.
IP	String	172.16.88.***	Titik akhir instans sumber.
InstanceType	String	RDS	Jenis instans sumber.
Port	String	3306	Port layanan database instans sumber.
UserName	String	dtstest	Akun database instans sumber.
EngineName	String	MySQL	Jenis database dari instance sumber.
StructureInitializationStatus	Object		Status sinkronisasi skema.
Status	String	Finished	Status sinkronisasi skema. Nilai yang valid: `NotStarted`: Sinkronisasi skema belum dimulai. `Migrating` : Sinkronisasi skema sedang berlangsung. `Failed` : Sinkronisasi skema gagal. `Finished`: Sinkronisasi skema selesai.
Percent	String	100	Kemajuan sinkronisasi skema. Unit: %.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	Pesan kesalahan yang dikembalikan jika sinkronisasi skema gagal.
Progress	String	1	Jumlah tabel yang skemanya telah disinkronkan.

Contoh

Permintaan Contoh

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobs
&Tag.1.Key=testkey1
&<Common request parameters>

Respons Sukses Contoh

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSynchronizationJobsResponse>
    <TotalRecordCount>100</TotalRecordCount>
    <SynchronizationInstances>
        <Status>synchronizing</Status>
        <SynchronizationObjects>
            <SchemaName>dtstestdatabase</SchemaName>
            <NewSchemaName>newdtstestdatabase</NewSchemaName>
        </SynchronizationObjects>
        <DataInitializationStatus>
            <Status>Finished</Status>
            <Progress>200001</Progress>
            <Percent>100</Percent>
        </DataInitializationStatus>
        <SynchronizationJobName>MySQL Synchronization</SynchronizationJobName>
        <InstanceCreateTime>2021-06-28T09:36:32Z</InstanceCreateTime>
        <CreateTime>2021-06-28 17:34:53.0</CreateTime>
        <JobCreateTime>2021-06-28T09:34:53Z</JobCreateTime>
        <PayType>PostPaid</PayType>
        <Delay>0</Delay>
        <PrecheckStatus>
            <Status>Finished</Status>
            <Percent>100</Percent>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_CONN_SRC</ItemName>
            
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_AUTH_SRC</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_CONN_DEST</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_AUTH_DEST</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_BINLOG_ON</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_BINLOG_MODE</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_BINLOG_ROW_IMAGE</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_SERVER_ID</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_BINLOG_EXIST</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_ENGINE</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_MYSQL_PASSOWRD_FORMAT</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_SRC</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_SAME_OBJ</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_SQL_MODE</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_SAME_USER</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_TOPOLOGY</ItemName>
            </Detail>
        </PrecheckStatus>
        <SynchronizationJobId>dtsexjk1alb116lbf1</SynchronizationJobId>
        <DataInitialization>true</DataInitialization>
        <DestinationEndpoint>
            <InstanceId>rm-bp162d4tp0500****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
        </DestinationEndpoint>
        <SourceEndpoint>
            <InstanceId>rm-bp1i99e8l7913****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
        </SourceEndpoint>
        <StructureInitialization>true</StructureInitialization>
        <ExpireTime>2021-07-07T16:00:00Z</ExpireTime>
        <Performance>
            <RPS>0</RPS>
            <FLOW>0.00MB/s</FLOW>
        </Performance>
        <SynchronizationJobClass>large</SynchronizationJobClass>
        <DataSynchronizationStatus/>
        <StructureInitializationStatus>
            <Status>Finished</Status>
            <Progress>1</Progress>
            <Percent>100</Percent>
        </StructureInitializationStatus>
    </SynchronizationInstances>
    <PageRecordCount>30</PageRecordCount>
    <RequestId>92E1E99D-5224-4AD3-8C94-23A3516B****</RequestId>
    <PageNumber>1</PageNumber>
</DescribeSynchronizationJobsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 100,
  "SynchronizationInstances" : [ {
    "Status" : "synchronizing",
    "SynchronizationObjects" : [ {
      "TableIncludes" : [ ],
      "TableExcludes" : [ ],
      "SchemaName" : "dtstestdatabase",
      "NewSchemaName" : "newdtstestdatabase"
    } ],
    "DataInitializationStatus" : {
      "Status" : "Finished",
      "Progress" : "200001",
      "Percent" : "100"
    },
    "SynchronizationJobName" : "MySQL Synchronization",
    "InstanceCreateTime" : "2021-06-28T09:36:32Z",
    "CreateTime" : "2021-06-28 17:34:53.0",
    "JobCreateTime" : "2021-06-28T09:34:53Z",
    "PayType" : "PostPaid",
    "Delay" : "0",
    "PrecheckStatus" : {
      "Status" : "Finished",
      "Percent" : "100",
      "Detail" : [ {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_CONN_SRC"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_AUTH_SRC"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_CONN_DEST"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_AUTH_DEST"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_BINLOG_ON"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_BINLOG_MODE"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_BINLOG_ROW_IMAGE"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_SERVER_ID"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_BINLOG_EXIST"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_ENGINE"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_MYSQL_PASSOWRD_FORMAT"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_SRC"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_SAME_OBJ"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_SQL_MODE"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_SAME_USER"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_TOPOLOGY"
      } ]
    },
    "SynchronizationJobId" : "dtsexjk1alb116lbf1",
    "DataInitialization" : true,
    "DestinationEndpoint" : {
      "InstanceId" : "rm-bp162d4tp0500****",
      "InstanceType" : "RDS",
      "EngineName" : "MySQL"
    },
    "SourceEndpoint" : {
      "InstanceId" : "rm-bp1i99e8l7913****",
      "InstanceType" : "RDS",
      "EngineName" : "MySQL"
    },
    "StructureInitialization" : true,
    "ExpireTime" : "2021-07-07T16:00:00Z",
    "Performance" : {
      "RPS" : "0",
      "FLOW" : "0.00MB/s"
    },
    "SynchronizationJobClass" : "large",
    "Tags" : [ ],
    "DataSynchronizationStatus" : { },
    "StructureInitializationStatus" : {
      "Status" : "Finished",
      "Progress" : "1",
      "Percent" : "100"
    }
  } ],
  "PageRecordCount" : 30,
  "RequestId" : "92E1E99D-5224-4AD3-8C94-23A3516B****",
  "PageNumber" : 1
}

Kode kesalahan

HttpCode	Kode kesalahan	Pesan kesalahan	Deskripsi
400	Throttling.User	Request was denied due to user flow control.	Jumlah permintaan mencapai batas, sehingga permintaan ditolak. Coba lagi nanti.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	Respons server mengalami timeout atau server tidak tersedia. Coba lagi. Jika kesalahan tetap terjadi, hubungi dukungan teknis.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	Signature telah kedaluwarsa. Gunakan signature baru.

Untuk daftar kode kesalahan, kunjungi API Error Center.