All Products
Search

This Product

    Data Transmission Service:CreateDtsInstance

    Document Center

    Data Transmission Service:CreateDtsInstance

    Last Updated:Oct 25, 2024

    Purchases a Data Transmission Service (DTS) instance.

    • Before you call this operation, make sure that you fully understand the billing methods and pricing of DTS.
    • If you want to run a DTS task on a DTS dedicated cluster, you must configure the task before you purchase a DTS instance. You can call the ConfigureDtsJob operation to configure a DTS task.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically 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 task ID. You can call the ConfigureDtsJob operation to obtain the task ID from DtsJobId.

    Note If this parameter is specified, you do not need to specify SourceRegion, DestinationRegion, Type, SourceEndpointEngineName, or DestinationEndpointEngineName. Even if these parameters are specified, the value of JobId takes precedence.
    InstanceClass String No xxlarge

    The instance class.

    • DTS supports the following instance classes for a data migration instance: xxlarge, xlarge, large, medium, and small.
    • Valid values of 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 Yes PrePaid

    The billing method. Valid values:

    • PrePaid: subscription.
    • PostPaid: pay-as-you-go.
    Note
    Period String No Month

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

    Note This parameter is valid and required only if PayType is set to PrePaid.
    SyncArchitecture String No oneway

    The synchronization topology. Valid values:

    • oneway (default): one-way synchronization.
    • bidirectional: two-way synchronization.
    AutoStart Boolean No false

    Specifies whether to automatically start the task after the DTS instance is purchased. Valid values:

    • false (default)
    • true
    Note This parameter can be set to true and take effect only if you specify a valid value for JobId.
    UsedTime Integer No 5

    The subscription duration.

    • Valid values if Period is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
    • Valid values if Period is set to Year: 1, 2, 3, and 5.
      Note
      • This parameter is valid and required only if PayType is set to PrePaid.
      • You can configure Period to specify the unit of the subscription duration.
    Quantity Integer No 1

    The number of DTS instances that you want to purchase.

    Note Only a single instance can be purchased each time.
    AutoPay Boolean No false

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

    • false (default)
    • true
    Type String No SYNC

    The type of the DTS instance. Valid values:

    • MIGRATION: data migration instance.
    • SYNC: data synchronization instance.

    • SUBSCRIBE: change tracking instance.

      Note You must specify a valid value for this parameter or for JobId.

    DatabaseCount Integer No 3

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

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

    The ID of the region in which the source instance resides. For more information, see Supported regions.

    Note You must specify a valid value for this parameter or for JobId.
    DestinationRegion String No cn-hangzhou

    The ID of the region in which the destination instance resides. For more information, see Supported regions.

    Note You must specify a valid value for this parameter or for JobId.
    SourceEndpointEngineName String No MySQL

    The database engine of the source instance. Valid values:

    • MySQL: ApsaraDB RDS for MySQL instance or self-managed MySQL database.
    • PolarDB: PolarDB for MySQL cluster.
    • polardb_o: PolarDB for Oracle cluster.
    • polardb_pg: PolarDB for PostgreSQL cluster.
    • Redis: ApsaraDB for Redis instance or self-managed Redis database.
    • DRDS: PolarDB-X 1.0 or PolarDB-X 2.0 instance.
    • 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 V2.0 cluster.
    • ADB30: AnalyticDB for MySQL V3.0 cluster.
    • Greenplum: AnalyticDB for PostgreSQL instance.
    • MSSQL: ApsaraDB RDS for SQL Server instance or self-managed SQL Server database.
    • kafka: ApsaraMQ for Kafka instance or self-managed Kafka cluster.
    • DataHub: DataHub project.
    • DB2: self-managed Db2 for LUW database.
    • as400: Db2 for i (AS/400) database.
    • Tablestore: Tablestore instance.
    • OceanBase: ApsaraDB for OceanBase (Compatible with MySQL) database, which is supported only in data migration instances.
    Note
    DestinationEndpointEngineName String No MySQL

    The database engine of the destination instance. Valid values:

    • MySQL: ApsaraDB RDS for MySQL instance or self-managed MySQL database.
    • PolarDB: PolarDB for MySQL cluster.
    • polardb_o: PolarDB for Oracle cluster.
    • polardb_pg: PolarDB for PostgreSQL cluster.
    • Redis: ApsaraDB for Redis instance or self-managed Redis database.
    • DRDS: PolarDB-X 1.0 or PolarDB-X 2.0 instance.
    • 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 V2.0 cluster.
    • ADB30: AnalyticDB for MySQL V3.0 cluster.
    • Greenplum: AnalyticDB for PostgreSQL instance.
    • MSSQL: ApsaraDB RDS for SQL Server instance or self-managed SQL Server database.
    • kafka: ApsaraMQ for Kafka instance or self-managed Kafka cluster.
    • DataHub: DataHub project.
    • DB2: self-managed Db2 for LUW database.
    • as400: Db2 for i (AS/400) database.
    • Tablestore: Tablestore instance.
    Note
    ComputeUnit Integer No 5

    The specifications of the extract, transform, and load (ETL) instance. The unit is compute unit (CU). One CU is equal to 1 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 in which the DTS instance resides. For more information, see Supported regions.

    FeeType String No ONLY_CONFIGURATION_FEE

    The billing type for a change tracking instance. Valid values: ONLY_CONFIGURATION_FEE and CONFIGURATION_FEE_AND_DATA_FEE. ONLY_CONFIGURATION_FEE: charges only configuration fees. CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.

    Du Integer No 30

    The number of DTS units (DUs) that are assigned to a DTS task that is run on a DTS dedicated cluster. Valid values: 1 to 100.

    Note
    • The value of this property must be within the range of the number of DUs available for the DTS dedicated cluster.
    • For more information about DTS dedicated clusters, see What is a DTS dedicated cluster?
    ResourceGroupId String No rg-acfmzawhxxc****

    The resource group ID.

    MinDu double No 1

    The minimum number of DUs.

    Note This parameter is supported only for serverless instances.
    MaxDu double No 16

    The maximum number of DUs.

    Note This parameter is supported only for serverless instances.
    DtsRegion String No cn-hangzhou

    The region ID of the DTS instance. Set this parameter to the value of RegionId.

    Response parameters

    Parameter

    Type

    Example

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

    The request ID.

    ErrCode String InternalError

    The error code returned if the request failed.

    Success String true

    Indicates whether the request was successful.

    JobId String bi6e22ay243****

    The task ID.

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

    The error message returned if the request failed.

    InstanceId String dtsbi6e22ay243****

    The instance ID.

    Examples

    Sample requests

    http(s)://dts.aliyuncs.com/?Action=CreateDtsInstance
&InstanceClass=large
&PayType=PostPaid
&SyncArchitecture=oneway
&AutoStart=false
&Quantity=1
&AutoPay=false
&Type=SYNC
&SourceRegion=cn-hangzhou
&DestinationRegion=cn-hangzhou
&SourceEndpointEngineName=MySQL
&DestinationEndpointEngineName=MySQL
&RegionId=cn-hangzhou
&<Common request parameters>

    Sample success responses

    XML format

    HTTP/1.1 200 OK
Content-Type:application/xml

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

    JSON format

    HTTP/1.1 200 OK
Content-Type:application/json

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

    Error codes

    HttpCode

    Error code

    Error message

    Description
    403 LXCreateOrderError Failed to create order, failure message: The module is invalid The cross-border synchronization feature of DTS is not available to all users. If you want to use this feature, submit <a href="https://page.aliyun.com/form/act409679078/index.htm" target="_blank">an application</a> for review.
    403 LXCreateOrder.NotFoundPricePlan Pricing plan price result not found, please check the parameters of the task configuration. Failed to create an order. No pricing plans are found. Possible causes include invalid parameters and a lack of pricing.
    403 LXPayOrder.InsufficientBalance Insufficient balance, order payment failed. Failed to complete the payment due to insufficient balance. Top up your account and try again.
    403 DTS.Msg.LXCreateOrderError Failed to create order, failure message: The module is invalid The cross-border synchronization feature of DTS is not available to all users. If you want to use this feature, submit <a href="https://page.aliyun.com/form/act409679078/index.htm" target="_blank">an application</a> for review.
    403 DTS.Msg.LXCreateOrder.NotFoundPricePlan Pricing plan price result not found, please check the parameters of the task configuration. Failed to create an order. No pricing plans are found. Possible causes include invalid parameters and a lack of pricing.
    403 DTS.Msg.LXPayOrder.InsufficientBalance Insufficient balance, order payment failed. Failed to complete the payment due to insufficient balance. Top up your account and try again.
    403 DTS.Msg.LXCreateOrderErrorIntl DTS supports cross-border data synchronization only in specific scenarios. To purchase a data synchronization instance used to synchronize data across countries, application for DTS cross-border data synchronization. The cross-border synchronization feature of DTS is not available to all users. If you want to use this feature, submit <a href="https://page-intl.aliyun.com/form/act1633074550/index.htm" target="_blank">an application</a> for review.
    403 InvalidSecurityToken.Expired Specified SecurityToken is expired. The signature expired. Use a new signature.
    400 Throttling.User Request was denied due to user flow control. The number of calls per second exceeds the limit. Try again later.
    500 ServiceUnavailable The request has failed due to a temporary failure of the server. The response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.

    For a list of error codes, see Service error codes.