Queries the status of a change tracking instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeSubscriptionInstanceStatus |
The operation that you want to perform. Set the value to DescribeSubscriptionInstanceStatus. |
SubscriptionInstanceId | String | Yes | dtsy0zz3t13h7d**** |
The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID. |
RegionId | String | No | cn-hangzhou |
The ID of the region where the change tracking instance resides. For more information, see List of supported regions. |
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. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
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.***.***.**:dts******** |
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. |
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. |
ErrorMessage | String | ****** |
The error message returned if change tracking failed. |
ErrorMessage | String | ****** |
The error message returned if change tracking failed. |
PayType | String | PrePaid |
The billing method of the change tracking instance. Valid values:
|
RequestId | String | E0845D0A-6D36-4EEB-BE26-CF191E1A**** |
The ID of the request. |
SourceEndpoint | Struct |
The connection settings of the source instance. |
|
InstanceID | String | rm-bp1162kryivb8**** |
The ID of the instance that hosts the source database. |
InstanceType | String | RDS |
The instance type of the source database. 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:
|
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 instance is 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:
|
DML | Boolean | true |
Indicates whether data manipulation language (DML) operations are tracked. Valid values:
|
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 |
PublicHost | String | dts-cn-****.aliyuncs.com:18001 |
The public endpoint of the change tracking instance. The format is |
VPCHost | String | dts-cn-****-vpc.aliyuncs.com:18003 |
The virtual private cloud (VPC) endpoint of the change tracking instance. The format
is |
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:
|
Success | String | true |
Indicates whether the call was successful. |
TaskId | String | y0zz3t13h7d**** |
The ID of the change tracking task. |
Examples
Sample requests
http(s)://dts.aliyuncs.com/?Action=DescribeSubscriptionInstanceStatus
&SubscriptionInstanceId=dtsy0zz3t13h7d****
&<Common request parameters>
Sample success responses
XML
format
<DescribeSubscriptionInstanceStatusResponse>
<Status>Normal</Status>
<TaskId>y0zz3t13h7d****</TaskId>
<RequestId>E0845D0A-6D36-4EEB-BE26-CF191E1A****</RequestId>
<SubscriptionHost>
<PublicHost>dts-cn-****.aliyuncs.com:18001</PublicHost>
<PrivateHost>dts-cn-****-internal.aliyuncs.com:18002</PrivateHost>
<VPCHost>dts-cn-****-vpc.aliyuncs.com:18003</VPCHost>
</SubscriptionHost>
<EndTimestamp>2021-03-26T14:03:21Z</EndTimestamp>
<PayType>PrePaid</PayType>
<SubscriptionInstanceID>dtsy0zz3t13h7d****</SubscriptionInstanceID>
<Success>true</Success>
<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>
<SubscribeTopic>cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2</SubscribeTopic>
<SourceEndpoint>
<InstanceID>rm-bp1162kryivb8****</InstanceID>
<InstanceType>RDS</InstanceType>
</SourceEndpoint>
<BeginTimestamp>2021-03-15T08:25:34Z</BeginTimestamp>
</DescribeSubscriptionInstanceStatusResponse>
JSON
format
{
"Status": "Normal",
"TaskId": "y0zz3t13h7d****",
"RequestId": "E0845D0A-6D36-4EEB-BE26-CF191E1A****",
"SubscriptionHost": {
"PublicHost": "dts-cn-****.aliyuncs.com:18001",
"PrivateHost": "dts-cn-****-internal.aliyuncs.com:18002",
"VPCHost": "dts-cn-****-vpc.aliyuncs.com:18003"
},
"EndTimestamp": "2021-03-26T14:03:21Z",
"PayType": "PrePaid",
"SubscriptionInstanceID": "dtsy0zz3t13h7d****",
"Success": true,
"SubscriptionObject": {
"SynchronousObject": [
{
"DatabaseName": "dtstestdata",
"WholeDatabase": false,
"TableList": {
"Table": [
"test1"
]
}
}
]
},
"SubscriptionDataType": {
"DML": true,
"DDL": true
},
"SubscriptionInstanceName": "API test",
"SubscribeTopic": "cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2",
"SourceEndpoint": {
"InstanceID": "rm-bp1162kryivb8****",
"InstanceType": "RDS"
},
"BeginTimestamp": "2021-03-15T08:25:34Z"
}
Error codes
For a list of error codes, visit the API Error Center.