Queries the list of change tracking instances and the details of each instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSubscriptionInstances

The operation that you want to perform. Set the value to DescribeSubscriptionInstances.

Tag.N.Key String Yes testkey1

The tag key.

Note
  • N specifies the serial number of the tag. For example, Tag.1.Key specifies the key of the first tag and Tag.2.Key specifies the key of the second tag. You can specify 1 to 20 tag keys at a time.
  • This parameter cannot be an empty string.
RegionId String No cn-hangzhou

The ID of the region where the change tracking instance resides. For more information, see List of supported regions.

PageSize Integer No 30

The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.

PageNum Integer No 1

The number of the page to return. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: 1.

SubscriptionInstanceName String No MySQL Change Tracking

The name of the change tracking instance.

Note If you specify this parameter, DTS returns all the change tracking instances that match the specified name.
ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe63****

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The ClientToken parameter can contain only ASCII characters and cannot exceed 64 characters in length.

AccountId String No 12323344****

The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter will be removed in the future.

Tag.N.Value String No testvalue1

The tag value.

Note
  • N specifies the serial number of the tag. For example, Tag.1.Value specifies the value of the first tag and Tag.2.Value specifies the value of the second tag. You can specify 1 to 20 tag values at a time.
  • This parameter can be an empty string.

Response parameters

Parameter Type Example Description
ErrCode String InternalError

The error code returned if the call failed.

ErrMessage String The request processing has failed due to some unknown error.

The error message returned if the call failed.

PageNumber Integer 1

The page number of the returned page.

PageRecordCount Integer 30

The maximum number of entries that can be displayed on the current page.

RequestId String FC3BAAF2-74E3-4471-8EB5-96202D6A****

The ID of the request.

SubscriptionInstances Array of SubscriptionInstance

The list of change tracking instances and the details of each instance.

SubscriptionInstance
BeginTimestamp String 2021-03-15T08:25:34Z

The start of the time range for change tracking. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

ConsumptionCheckpoint String 2021-03-23T07:30:31Z

The consumption checkpoint of the change tracking instance. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

ConsumptionClient String 114.xxx.xxx.xx:dtsxxxxxxxx

The downstream client information, in the following format: <IP address of the downstream client>:<Random ID generated by DTS>.

EndTimestamp String 2021-03-26T14:03:21Z

The end of the time range for change tracking. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

ErrorMessage String xxxxxxxx

The error message returned if change tracking failed.

PayType String PrePaid

The billing method of the change tracking instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
SourceEndpoint Struct

The connection settings of the source instance.

InstanceID String rm-bp1162kryivb8****

The ID of the source instance.

InstanceType String RDS

The type of the source instance.

Note This parameter is returned only for change tracking instances of the new version.
Status String Normal

The status of the change tracking task. Valid values:

  • NotStarted: The task is not started.
  • Prechecking: The task is being prechecked.
  • PrecheckFailed: The task failed to pass the precheck.
  • Starting: The task is being started.
  • Normal: The task is running as expected.
  • Abnormal: The task is not running as expected.
SubscribeTopic String cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2

The topic of the change tracking instance.

Note This parameter is returned only if your change tracking instances are of the new version and you have called the CreateConsumerGroup operation to create a consumer group.
SubscriptionDataType Struct

The types of operations that are tracked by the task.

DDL Boolean true

Indicates whether data definition language (DDL) operations are tracked. Valid values:

  • true: yes
  • false: no
DML Boolean true

Indicates whether data manipulation language (DML) operations are tracked. Valid values:

  • true: yes
  • false: no
SubscriptionHost Struct

The endpoint of the change tracking instance.

PrivateHost String dts-cn-****-internal.aliyuncs.com:18002

The private endpoint of the change tracking instance. The format is <Address>:<Port number>.

PublicHost String dts-cn-****.aliyuncs.com:18001

The public endpoint of the change tracking instance. The format is <Address>:<Port number>.

VPCHost String dts-cn-****-vpc.aliyuncs.com:18003

The virtual private cloud (VPC) endpoint of the change tracking instance. The format is <Address>:<Port number>.

SubscriptionInstanceID String rm-bp1162kryivb8****

The ID of the change tracking instance.

SubscriptionInstanceName String API test

The name of the change tracking instance.

SubscriptionObject Array of SynchronousObject

The objects for change tracking.

SynchronousObject
DatabaseName String dtstestdata

The name of the database to which the object belongs.

TableList List test1

The table name.

WholeDatabase String false

Indicates whether the data of an entire database is tracked. Valid values:

  • true: yes
  • false: no
Tags Array of Tag

The collection of tags.

Tag
Key String testkey1

The tag key.

Value String testvalue1

The tag value that corresponds to the tag key.

Success String true

Indicates whether the call was successful.

TotalRecordCount Long 1

The total number of change tracking instances that belong to your Alibaba Cloud account.

Examples

Sample requests

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

Sample success responses

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>API test</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_bp1162kryivb8****_dtstest_version2</SubscribeTopic>
                  <SourceEndpoint>
                        <InstanceID>rm-bp1162kryivb8****</InstanceID>
                        <InstanceType>RDS</InstanceType>
                  </SourceEndpoint>
                  <EndTimestamp>2021-03-26T14:03:21Z</EndTimestamp>
                  <PayType>PrePaid</PayType>
                  <SubscriptionInstanceID>dtsy0zz3t13h7dnbd0</SubscriptionInstanceID>
                  <BeginTimestamp>2021-03-15T08:25:34Z</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": "API test",
                "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_bp1162kryivb8o9w6_dtstest_version2",
                "SourceEndpoint": {
                    "InstanceID": "rm-bp1162kryivb8****",
                    "InstanceType": "RDS"
                },
                "EndTimestamp": "2021-03-26T14:03:21Z",
                "PayType": "PrePaid",
                "SubscriptionInstanceID": "dtsy0zz3t13h7dnbd0",
                "BeginTimestamp": "2021-03-15T08:25:34Z",
                "Tags": {
                    "Tag": []
                }
            }
        ]
    }
}

Error codes

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