Purchases a change tracking instance.

Before you call this operation, make sure that you fully understand the billing methods and pricing of Data Transmission Service (DTS).

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 CreateSubscriptionInstance

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

Region String Yes cn-hangzhou

The region ID of the change tracking instance. The region ID is the same as that of the source instance. For more information, see List of supported regions.

RegionId String No cn-hangzhou

The region ID of the change tracking instance. You do not need to specify this parameter because this parameter will be removed in the future.

SourceEndpoint.InstanceType String No MySQL

The type of the source instance. Valid values: MySQL, PolarDB, DRDS, and Oracle.

Note Default value: MySQL.
PayType String No Prepaid

The billing method of the change tracking instance.

  • Postpaid: pay-as-you-go
  • Prepaid: subscription
Period String No Month

The billing cycle of the subscription instance. Valid values:

  • Year
  • Month
Note You must specify this parameter only if you set the PayType parameter to Prepaid.
UsedTime Integer No 12

The subscription length.

  • If the billing cycle is Year, the value range is 1 to 5.
  • If the billing cycle is Month, the value range is 1 to 60.
Note You must specify this parameter only if you set the PayType parameter to Prepaid.
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.

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.

RequestId String 4E9564C5-F99D-4176-A6BA-2D7F2DC8****

The ID of the request.

SubscriptionInstanceId String dtsfen11q2g23x****

The ID of the change tracking instance.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=CreateSubscriptionInstance
&Region=cn-hangzhou
&<Common request parameters>

Sample responses

XML format 

<CreateSubscriptionInstanceResponse>
      <RequestId>4E9564C5-F99D-4176-A6BA-2D7F2DC8****</RequestId>
      <SubscriptionInstanceId>dtsfen11q2g23x****</SubscriptionInstanceId>
      <Success>true</Success>
</CreateSubscriptionInstanceResponse>

JSON format 

{
    "RequestId": "4E9564C5-F99D-4176-A6BA-2D7F2DC8****",
    "SubscriptionInstanceId": "dtsfen11q2g23x****",
    "Success": true
}

Error codes

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