调用CreateDtsInstance接口购买DTS实例。
- 请确保在使用该接口前,已充分了解云数据库DTS产品的收费方式和价格。
- 专属集群的任务仅支持先配置任务后购买实例,您可以调用ConfigureDtsJob接口配置任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | CreateDtsInstance | 系统规定参数。取值:CreateDtsInstance。 |
JobId | String | 否 | bi6e22ay243**** | 调用ConfigureDtsJob接口获得的任务ID(DtsJobId)。 说明 传入本参数后,则无需再传SourceRegion、DestinationRegion、Type、SourceEndpointEngineName、DestinationEndpointEngineName参数。即使传入也以JobId中的配置为准。 |
InstanceClass | String | 否 | xxlarge | 迁移或同步实例的规格。
说明 不同规格对应的性能说明,请参见数据迁移链路规格说明和数据同步链路规格说明。 |
PayType | String | 否 | PrePaid | 支付类型:
说明 更正:本参数为必填参数。 |
Period | String | 否 | Month | 预付费实例的计费方式,取值:Year(年)Month(月)。 说明 当PayType为PrePaid(预付费)时,该参数才有效且必须传入。 |
SyncArchitecture | String | 否 | oneway | 同步拓扑,取值:
|
AutoStart | Boolean | 否 | false | 购买完成后是否自动启动任务,取值:
说明 仅当参数JobId传入有效的任务ID时,本参数取值为true才会生效。 |
UsedTime | Integer | 否 | 5 | 预付费实例购买时长。
|
Quantity | Integer | 否 | 1 | 购买实例数量。 说明 当前单次调用最多支持购买1个。 |
AutoPay | Boolean | 否 | false | 到期是否自动续费,取值:
|
Type | String | 否 | SYNC | 实例类型,取值为:
|
DatabaseCount | Integer | 否 | 3 | PolarDB-X下的私有定制RDS实例的数量,默认值为1。 说明 仅SourceEndpointEngineName为drds时需要传入该参数。 |
SourceRegion | String | 否 | cn-hangzhou | 源实例区域,详情请参见支持的地域列表。 说明 本参数或JobId必须传入其中之一。 |
DestinationRegion | String | 否 | cn-hangzhou | 目标实例区域,详情请参见支持的地域列表。 说明 本参数或JobId必须传入其中之一。 |
SourceEndpointEngineName | String | 否 | MySQL | 源实例数据库引擎类型。
说明
|
DestinationEndpointEngineName | String | 否 | MySQL | 目标数据库引擎类型。
说明
|
ComputeUnit | Integer | 否 | 5 | ETL的规格。单位为计算单元ComputeUnit(CU),1CU=1vCPU+4 GB内存。取值范围为大于等于2的整数。 |
RegionId | String | 否 | cn-hangzhou | 实例所属的地域,请参见支持的地域列表。 |
FeeType | String | 否 | ONLY_CONFIGURATION_FEE | 订阅计费类型,ONLY_CONFIGURATION_FEE,仅收取配置费,免收数据流量费;CONFIGURATION_FEE_AND_DATA_FEE,将额外收取数据流量费用。 |
Du | Integer | 否 | 30 | 分配指定数量的DU资源给DTS专属集群上的DTS任务。取值范围:1~100。 说明
|
ResourceGroupId | String | 否 | rg-acfmzawhxxc**** | 资源组ID。 |
MinDu | double | 否 | 1 | DU下限。 说明 仅Serverless实例支持。 |
MaxDu | double | 否 | 16 | DU上限。 说明 仅Serverless实例支持。 |
DtsRegion | String | 否 | cn-hangzhou | 实例的归属地域,需与RegionId保持一致。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | C166D79D-436B-45F0-B5A5-25E1**** | 请求ID。 |
ErrCode | String | InternalError | 调用出错时返回的错误码。 |
Success | String | true | 请求是否成功。 |
JobId | String | bi6e22ay243**** | 任务ID。 |
ErrMessage | String | The request processing has failed due to some unknown error. | 调用错误时返回对应的错误信息。 |
InstanceId | String | dtsbi6e22ay243**** | 实例ID。 |
示例
请求示例
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
&<公共请求参数>
正常返回示例
XML
格式
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
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C166D79D-436B-45F0-B5A5-25E1****",
"InstanceId" : "dtsmne11yo2j9n****",
"Success" : true,
"JobId" : "mne11yo2j9n****"
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
403 | LXCreateOrderError | Failed to create order, failure message: The module is invalid | DTS跨境同步功能未全网开放,如果需要使用,请填写<a href="https://page.aliyun.com/form/act409679078/index.htm" target="_blank">DTS跨境数据同步权限申请表单</a>进行需求审核 |
403 | LXCreateOrder.NotFoundPricePlan | Pricing plan price result not found, please check the parameters of the task configuration. | 创建订单失败,定价计划没有找到,可能的原因有:传入的购买参数尚不支持购买、定价缺失、购买参数传入错误。 |
403 | LXPayOrder.InsufficientBalance | Insufficient balance, order payment failed. | 账户下余额不足,无法完成支付,请充值后重试。 |
403 | DTS.Msg.LXCreateOrderError | Failed to create order, failure message: The module is invalid | DTS跨境同步功能未全网开放,如果需要使用,请填写<a href="https://page.aliyun.com/form/act409679078/index.htm" target="_blank">DTS跨境数据同步权限申请表单</a>进行需求审核 |
403 | DTS.Msg.LXCreateOrder.NotFoundPricePlan | Pricing plan price result not found, please check the parameters of the task configuration. | 创建订单失败,定价计划没有找到,可能的原因有:传入的购买参数尚不支持购买、定价缺失、购买参数传入错误。 |
403 | DTS.Msg.LXPayOrder.InsufficientBalance | Insufficient balance, order payment failed. | 账户下余额不足,无法完成支付,请充值后重试。 |
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. | DTS跨境同步功能未全网开放,如果需要使用,请填写<a href="https://page-intl.aliyun.com/form/act1633074550/index.htm" target="_blank">DTS跨境数据同步权限申请表单</a>进行需求审核 |
403 | InvalidSecurityToken.Expired | Specified SecurityToken is expired. | 签名已经过期,请更新签名 |
400 | Throttling.User | Request was denied due to user flow control. | 由于请求频次达到阈值,请求被拒绝,请稍后重试。 |
500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 由于服务端响应超时或者不可用导致请求失败,请重试,重试后仍失败请联系技术支持。 |
访问错误中心查看更多错误码。