DescribeSubscriptionInstances - Data Transmission Service

Mengambil daftar instans pelacakan perubahan beserta detail masing-masing instans.

Debugging

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

Parameter permintaan

Parameter	Tipe	Wajib	Contoh	Deskripsi
Action	String	Ya	DescribeSubscriptionInstances	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeSubscriptionInstances.
Tag.N.Key	String	Ya	testkey1	Kunci tag. 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.
RegionId	String	Tidak	cn-hangzhou	ID wilayah tempat instans pelacakan perubahan berada. Untuk informasi selengkapnya, lihat Daftar wilayah yang didukung.
PageSize	Integer	Tidak	30	Jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid: 30, 50, dan 100. Nilai default: 30.
PageNum	Integer	Tidak	1	Nomor halaman yang dikembalikan. Nilainya harus berupa bilangan bulat yang lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data Integer. Nilai default: 1.
SubscriptionInstanceName	String	Tidak	MySQL Change Tracking	Nama instans pelacakan perubahan. Catatan Jika Anda menentukan parameter ini, DTS mengembalikan semua instans pelacakan perubahan yang sesuai dengan nama yang ditentukan.
ClientToken	String	Tidak	0c593ea1-3bea-11e9-b96b-88e9fe63****	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan client untuk menghasilkan nilainya, tetapi Anda harus memastikan bahwa nilainya unik di antara permintaan yang berbeda. Parameter ClientToken hanya dapat berisi karakter ASCII dan panjangnya tidak boleh melebihi 64 karakter.
AccountId	String	Tidak	12323344****	ID Akun Alibaba Cloud. Anda tidak perlu menentukan parameter ini karena parameter ini akan dihapus di masa mendatang.
Tag.N.Value	String	Tidak	testvalue1	Nilai tag. 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. Parameter ini dapat berupa string kosong.

Parameter respons

Parameter	Tipe	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.
PageNumber	Integer	1	Nomor halaman yang dikembalikan.
PageRecordCount	Integer	30	Jumlah maksimum entri yang dapat ditampilkan pada halaman saat ini.
RequestId	String	FC3BAAF2-74E3-4471-8EB5-96202D6A****	ID permintaan.
SubscriptionInstances	Array of SubscriptionInstance		Daftar instans pelacakan perubahan dan detail masing-masing instans.
SubscriptionInstance
BeginTimestamp	String	2021-06-21T08:25:43Z	Awal rentang waktu untuk pelacakan perubahan. Waktu ditampilkan dalam format yyyy-MM-ddTHH:mm:ssZ dalam UTC.
ConsumptionCheckpoint	String	2021-06-21T09:30:31Z	Titik pemeriksaan konsumsi instans pelacakan perubahan. Waktu ditampilkan dalam format yyyy-MM-ddTHH:mm:ssZ dalam UTC.
ConsumptionClient	String	114.*..:dts*******	Informasi client downstream, dalam format berikut: <Alamat IP client downstream>:<ID acak yang dihasilkan oleh DTS>.
EndTimestamp	String	2021-06-21T10:17:21Z	Akhir rentang waktu untuk pelacakan perubahan. Waktu ditampilkan dalam format yyyy-MM-ddTHH:mm:ssZ dalam UTC.
ErrorMessage	String	xxxxxxxx	Pesan kesalahan yang dikembalikan jika pelacakan perubahan gagal.
InstanceCreateTime	String	2021-06-21T02:48:20Z	Waktu pembuatan instans pelacakan perubahan. Waktu ditampilkan dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC.
JobCreateTime	String	2021-06-21T02:48:20Z	Waktu pembuatan tugas pelacakan perubahan. Waktu ditampilkan dalam format yyyy-MM-ddTHH:mm:ssZ dalam UTC.
PayType	String	PrePaid	Metode penagihan instans pelacakan perubahan. Nilai yang valid: PrePaid: subscription PostPaid: pay-as-you-go
SourceEndpoint	Struct		Pengaturan koneksi instans sumber.
InstanceID	String	rm-bp1162kryivb8****	ID instans sumber.
InstanceType	String	RDS	Tipe instans sumber. Catatan Parameter ini hanya dikembalikan untuk instans pelacakan perubahan versi baru.
Status	String	Normal	Status tugas pelacakan perubahan. Nilai yang valid: NotStarted: Tugas belum dimulai. Prechecking: Tugas sedang dalam proses Pemeriksaan Awal. PrecheckFailed: Tugas gagal dalam Pemeriksaan Awal. Starting: Tugas sedang dimulai. Normal: Tugas berjalan sebagaimana mestinya. Abnormal: Tugas tidak berjalan sebagaimana mestinya.
SubscribeTopic	String	cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2	Topik instans pelacakan perubahan. Catatan Parameter ini hanya dikembalikan jika instans pelacakan perubahan Anda merupakan versi baru dan Anda telah memanggil operasi CreateConsumerGroup untuk membuat kelompok konsumen.
SubscriptionDataType	Struct		Tipe operasi yang dilacak oleh tugas.
DDL	Boolean	true	Menunjukkan apakah operasi bahasa definisi data (DDL) dilacak. Nilai yang valid: true: ya false: tidak
DML	Boolean	true	Menunjukkan apakah operasi bahasa manipulasi data (DML) dilacak. Nilai yang valid: true: ya false: tidak
SubscriptionHost	Struct		Titik akhir instans pelacakan perubahan.
PrivateHost	String	dts-cn-****-internal.aliyuncs.com:18002	Titik akhir pribadi instans pelacakan perubahan. Formatnya adalah `<Alamat>:<Nomor Port>`.
PublicHost	String	dts-cn-****.aliyuncs.com:18001	Titik akhir publik instans pelacakan perubahan. Formatnya adalah `<Alamat>:<Nomor Port>`.
VPCHost	String	dts-cn-****-vpc.aliyuncs.com:18003	Titik akhir virtual private cloud (VPC) instans pelacakan perubahan. Formatnya adalah `<Alamat>:<Nomor Port>`.
SubscriptionInstanceID	String	rm-bp1162kryivb8****	ID instans pelacakan perubahan.
SubscriptionInstanceName	String	MySQL Change Tracking	Nama instans pelacakan perubahan.
SubscriptionObject	Array of SynchronousObject		Objek untuk pelacakan perubahan.
SynchronousObject
DatabaseName	String	dtstestdata	Nama database tempat objek tersebut berada.
TableList	List	test1	Nama tabel.
WholeDatabase	String	false	Menunjukkan apakah data seluruh database dilacak. Nilai yang valid: true: ya false: tidak
Tags	Array of Tag		Kumpulan tag.
Tag
Key	String	testkey1	Kunci tag.
Value	String	testvalue1	Nilai tag yang sesuai dengan kunci tag.
Success	String	true	Menunjukkan apakah pemanggilan berhasil.
TotalRecordCount	Long	1	Jumlah total instans pelacakan perubahan yang dimiliki oleh Akun Alibaba Cloud Anda.

Contoh

Permintaan contoh

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

Respons sukses contoh

XML format

<DescribeSubscriptionInstancesResponse>
      <TotalRecordCount>1</TotalRecordCount>
      <PageRecordCount>30</PageRecordCount>
      <RequestId>FC3BAAF2-74E3-4471-8EB5-96202D6A****</RequestId>
      <PageNumber>1</PageNumber>
      <Success>true</Success>
      <SubscriptionInstances>
            <SubscriptionInstance>
                  <Status>Normal</Status>
                  <SubscriptionObject>
                        <SynchronousObject>
                              <DatabaseName>dtstestdata</DatabaseName>
                              <WholeDatabase>false</WholeDatabase>
                              <TableList>
                                    <Table>test1</Table>
                              </TableList>
                        </SynchronousObject>
                  </SubscriptionObject>
                  <SubscriptionDataType>
                        <DML>true</DML>
                        <DDL>true</DDL>
                  </SubscriptionDataType>
                  <SubscriptionInstanceName>MySQL Change Tracking</SubscriptionInstanceName>
                  <SubscriptionHost>
                        <PublicHost>dts-cn-hangzhou.aliyuncs.com:18001</PublicHost>
                        <PrivateHost>dts-cn-hangzhou-internal.aliyuncs.com:18002</PrivateHost>
                        <VPCHost>dts-cn-hangzhou-vpc.aliyuncs.com:18003</VPCHost>
                  </SubscriptionHost>
                  <SubscribeTopic>cn_hangzhou_rm_bp1162kryiv******_dtstest_version2</SubscribeTopic>
                  <SourceEndpoint>
                        <InstanceID>rm-bp1162kryivb8****</InstanceID>
                        <InstanceType>RDS</InstanceType>
                  </SourceEndpoint>
                  <InstanceCreateTime>2021-06-21T10:17:21Z</InstanceCreateTime>
                  <JobCreateTime>2021-06-21T10:17:21Z</JobCreateTime>
                  <EndTimestamp>2021-06-21T10:17:21Z</EndTimestamp>
                  <PayType>PrePaid</PayType>
                  <SubscriptionInstanceID>dtsy0zz3t13h******</SubscriptionInstanceID>
                  <BeginTimestamp>2021-06-21T08:25:43Z</BeginTimestamp>
                  <Tags></Tags>
            </SubscriptionInstance>
      </SubscriptionInstances>
</DescribeSubscriptionInstancesResponse>

JSON format

{
	"TotalRecordCount": 1,
	"PageRecordCount": 30,
	"RequestId": "FC3BAAF2-74E3-4471-8EB5-96202D6A****",
	"PageNumber": 1,
	"Success": true,
	"SubscriptionInstances": {
		"SubscriptionInstance": [
			{
				"Status": "Normal",
				"SubscriptionObject": {
					"SynchronousObject": [
						{
							"DatabaseName": "dtstestdata",
							"WholeDatabase": false,
							"TableList": {
								"Table": [
									"test1"
								]
							}
						}
					]
				},
				"SubscriptionDataType": {
					"DML": true,
					"DDL": true
				},
				"SubscriptionInstanceName": "MySQL Change Tracking",
				"SubscriptionHost": {
					"PublicHost": "dts-cn-hangzhou.aliyuncs.com:18001",
					"PrivateHost": "dts-cn-hangzhou-internal.aliyuncs.com:18002",
					"VPCHost": "dts-cn-hangzhou-vpc.aliyuncs.com:18003"
				},
				"SubscribeTopic": "cn_hangzhou_rm_bp1162kryiv******_dtstest_version2",
				"SourceEndpoint": {
					"InstanceID": "rm-bp1162kryivb8****",
					"InstanceType": "RDS"
				},
				"InstanceCreateTime": "2021-06-21T10:17:21Z",
				"JobCreateTime": "2021-06-21T10:17:21Z",
                "EndTimestamp": "2021-06-21T10:17:21Z",
				"PayType": "PrePaid",
				"SubscriptionInstanceID": "dtsy0zz3t13h******",
				"BeginTimestamp": "2021-06-21T08:25:43Z",
				"Tags": {
					"Tag": []
				}
			}
		]
	}
}

Kode kesalahan

For a list of error codes, visit the API Error Center.