調用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的整數。 說明 傳入該參數,開通ETL功能,進行數據清洗和轉換。 |
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 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 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 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. | 由于服務端響應超時或者不可用導致請求失敗,請重試,重試后仍失敗請聯系技術支持。 |
訪問錯誤中心查看更多錯誤碼。