调用CreateDtsInstance接口购买DTS实例。

请确保在使用该接口前,已充分了解云数据库DTS产品的收费方式和价格

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDtsInstance

系统规定参数,取值:CreateDtsInstance

JobId String bi6e22ay243****

任务ID。

InstanceClass String xxlarge

迁移或同步实例的规格。

  • 迁移实例支持的规格:xxlarge xlargelargemediumsmall
  • 同步实例支持的规格:largemediumsmallmicro
说明 不同规格对应的性能说明,请参见 数据迁移链路规格说明数据同步链路规格说明
PayType String PrePaid

支付类型:

  • PrePaid:预付费。
  • PostPaid:后付费。
说明 更正:本参数为必填参数。
Period String Month

预付费实例的计费方式,取值:Year(年)、Month(月)。

说明PayTypePrePaid(预付费)时,该参数才有效且必须传入。
SyncArchitecture String oneway

同步拓扑,取值:

  • oneway:单向同步,为默认值。
  • bidirectional:双向同步。
AutoStart Boolean false

购买完成后是否自动启动任务,取值:

  • false:否。
  • true:是。
UsedTime Integer 5

预付费实例购买时长。

说明
  • PayTypePrePaid(预付费)时,该参数才有效且必须传入。
  • 预付费实例的计费方式,您可在参数Period中进行设置。
Quantity Integer 1

购买实例数量。

AutoPay Boolean false

到期是否自动续费,取值:

  • false:否。
  • true:是。
Type String MIGRATION

实例类型,取值为:

  • MIGRATION:迁移。
  • SYNC:同步。
  • SUBSCRIBE:订阅。
DatabaseCount Integer 3

PolarDB-X下的私有定制RDS实例的数量,默认值为1

说明SourceEndpointEngineNamedrds时需要传入该参数。
SourceRegion String cn-hangzhou

源实例区域,详情请参见支持的地域列表

DestinationRegion String cn-hangzhou

目标实例区域,详情请参见支持的地域列表

SourceEndpointEngineName String MYSQL

源实例数据库引擎类型。

  • MySQL:MySQL数据库(包括RDS MySQL和自建MySQL)。
  • PolarDB:PolarDB MySQL。
  • polardb_o:PolarDB-O。
  • polardb_pg:PolarDB PostgreSQL。
  • Redis:Redis数据库(包括云数据库Redis和自建Redis)。
  • DRDS:云原生分布式数据库PolarDB-X 1.0和2.0。
  • PostgreSQL:自建PostgreSQL。
  • odps:MaxCompute。
  • oracle:自建Oracle。
  • mongodb:MongoDB数据库(包括云数据库MongoDB和自建MongoDB)。
  • tidb:TiDB数据库。
  • ADS:云原生数仓 AnalyticDB MySQL 2.0。
  • ADB30:云原生数仓 AnalyticDB MySQL 3.0。
  • Greenplum:云原生数仓 AnalyticDB PostgreSQL。
  • MSSQL:SQL Server数据库(包括RDS SQL Server和自建SQL Server)。
  • kafka:Kafka数据库(包括消息队列Kafka版和自建Kafka)。
  • DataHub:阿里云流式数据服务DataHub。
  • clickhouse:云数据库 ClickHouse。
  • DB2:自建DB2 LUW。
  • as400:AS/400。
  • Tablestore:表格存储Tablestore。
说明
DestinationEndpointEngineName String MySQL

目标数据库引擎类型。

  • MySQL:MySQL数据库(包括RDS MySQL和自建MySQL)。
  • PolarDB:PolarDB MySQL。
  • polardb_o:PolarDB-O。
  • polardb_pg:PolarDB PostgreSQL。
  • Redis:Redis数据库(包括云数据库Redis和自建Redis)。
  • DRDS:云原生分布式数据库PolarDB-X 1.0和2.0。
  • PostgreSQL:自建PostgreSQL。
  • odps:MaxCompute。
  • oracle:自建Oracle。
  • mongodb:MongoDB数据库(包括云数据库MongoDB和自建MongoDB)。
  • tidb:TiDB数据库。
  • ADS:云原生数仓 AnalyticDB MySQL 2.0。
  • ADB30:云原生数仓 AnalyticDB MySQL 3.0。
  • Greenplum:云原生数仓 AnalyticDB PostgreSQL。
  • MSSQL:SQL Server数据库(包括RDS SQL Server和自建SQL Server)。
  • kafka:Kafka数据库(包括消息队列Kafka版和自建Kafka)。
  • DataHub:阿里云流式数据服务DataHub。
  • clickhouse:云数据库 ClickHouse。
  • DB2:自建DB2 LUW。
  • as400:AS/400。
  • Tablestore:表格存储Tablestore。
说明
ComputeUnit Integer 5

ETL的规格。单位为计算单元ComputeUnit(CU),1CU=1vCPU​+4 GB内存。取值范围为大于等于2的整数。

> 传入该参数,开通ETL功能,进行数据清洗和转换。

RegionId String cn-hangzhou

实例所属的地域,请参见支持的地域列表

返回数据

名称 类型 示例值 描述
ErrCode String InternalError

调用出错时返回的错误码。

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

调用错误时返回对应的错误信息。

InstanceId String dtsbi6e22ay243****

实例ID。

JobId String bi6e22ay243****

任务ID。

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

请求ID。

Success String true

请求是否成功。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=CreateDtsInstance
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

访问错误中心查看更多错误码。