Purchases a DTS 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 CreateDtsInstance

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

JobId String No bi6e22ay243****

The ID of the DTS task.

InstanceClass String No xxlarge

The instance class.

  • DTS supports the following instance classes for a data migration instance: xxlarge, xlarge, large, medium, and small.
  • DTS supports the following instance classes for a data synchronization instance: large, medium, small, and micro.
Note For more information about the test performance of each instance class, see Specifications of data migration instances and Specifications of data synchronization instances.
PayType String No PrePaid

The billing method. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
Note This parameter must be specified.
Period String No Month

The unit of the subscription length. Valid values: Year and Month.

Note You must specify this parameter only if you set the PayType parameter to PrePaid.
SyncArchitecture String No oneway

The synchronization topology. Valid values:

  • oneway: one-way synchronization
  • bidirectional: two-way synchronization
AutoStart Boolean No false

Specifies whether to automatically start the task after the purchase is completed. Valid values:

  • false: no
  • true: yes
UsedTime Integer No 5

The subscription length.

Note
  • You must specify this parameter only if you set the PayType parameter to PrePaid.
  • You can set the Period parameter to specify the unit of the subscription length.
Quantity Integer No 1

The number of DTS instances that you want to purchase.

AutoPay Boolean No false

Specifies whether to automatically renew the DTS instance when it expires. Valid values:

  • false: no
  • true: yes
Type String No MIGRATION

The type of the DTS instance. Valid values:

  • MIGRATION: data migration instance
  • SYNC: data synchronization instance
  • SUBSCRIBE: change tracking instance
DatabaseCount Integer No 3

The number of private custom RDS instances in PolarDB-X. Default value: 1.

Note You must specify this parameter only if the SourceEndpointEngineName parameter is set to drds.
SourceRegion String No cn-hangzhou

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

DestinationRegion String No cn-hangzhou

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

SourceEndpointEngineName String No MYSQL

The database engine of the source instance.

  • MySQL: ApsaraDB RDS for MySQL instance or self-managed MySQL database
  • PolarDB: PolarDB for MySQL cluster
  • polardb_o: PolarDB-O cluster
  • polardb_pg: PolarDB for PostgreSQL cluster
  • Redis: ApsaraDB for Redis instance or self-managed Redis database
  • DRDS: PolarDB-X instance V1.0 or V2.0
  • PostgreSQL: self-managed PostgreSQL database
  • odps: MaxCompute project
  • oracle: self-managed Oracle database
  • mongodb: ApsaraDB for MongoDB instance or self-managed MongoDB database
  • tidb: TiDB database
  • ADS: AnalyticDB for MySQL cluster V2.0
  • ADB30: AnalyticDB for MySQL cluster V3.0
  • Greenplum: AnalyticDB for PostgreSQL instance
  • MSSQL: ApsaraDB RDS for SQL Server instance or self-managed SQL Server database
  • kafka: Message Queue for Apache Kafka instance or self-managed Kafka cluster
  • DataHub: DataHub project
  • clickhouse: ApsaraDB for ClickHouse cluster
  • DB2: self-managed Db2 for LUW database
  • as400: AS/400
  • Tablestore: Tablestore instance
Note
DestinationEndpointEngineName String No MySQL

The database engine of the destination instance.

  • MySQL: ApsaraDB RDS for MySQL instance or self-managed MySQL database
  • PolarDB: PolarDB for MySQL cluster
  • polardb_o: PolarDB-O cluster
  • polardb_pg: PolarDB for PostgreSQL cluster
  • Redis: ApsaraDB for Redis instance or self-managed Redis database
  • DRDS: PolarDB-X instance V1.0 or V2.0
  • PostgreSQL: self-managed PostgreSQL database
  • odps: MaxCompute project
  • oracle: self-managed Oracle database
  • mongodb: ApsaraDB for MongoDB instance or self-managed MongoDB database
  • tidb: TiDB database
  • ADS: AnalyticDB for MySQL cluster V2.0
  • ADB30: AnalyticDB for MySQL cluster V3.0
  • Greenplum: AnalyticDB for PostgreSQL instance
  • MSSQL: ApsaraDB RDS for SQL Server instance or self-managed SQL Server database
  • kafka: Message Queue for Apache Kafka instance or self-managed Kafka cluster
  • DataHub: DataHub project
  • clickhouse: ApsaraDB for ClickHouse cluster
  • DB2: self-managed Db2 for LUW database
  • as400: AS/400
  • Tablestore: Tablestore instance
Note
ComputeUnit Integer No 5

The specifications of the extract, transform, and load (ETL) instance. The unit is compute unit (CU). 1 CU is equal to 1-core vCPU and 4 GB of memory. The value of this parameter must be an integer greater than or equal to 2.

RegionId String No cn-hangzhou

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

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.

InstanceId String dtsbi6e22ay243****

The ID of the DTS instance.

JobId String bi6e22ay243****

The ID of the DTS task.

RequestId String C166D79D-436B-45F0-B5A5-25E1****

The ID of the request.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=CreateDtsInstance
&<Common request parameters>

Sample success responses

XML format

<CreateDtsInstanceResponse>
  <RequestId>C166D79D-436B-45F0-B5A5-25E1****</RequestId>
  <Success>true</Success>
</CreateDtsInstanceResponse>

JSON format

{
    "RequestId":"C166D79D-436B-45F0-B5A5-25E1****",
    "Success":"true"
}

Error codes

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