TransferInstanceClass - Data Transmission Service - Alibaba Cloud Documentation Center

Note You cannot downgrade a DTS instance.

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	TransferInstanceClass	The operation that you want to perform. Set the value to TransferInstanceClass.
OrderType	String	Yes	UPGRADE	Set the value to UPGRADE.
InstanceClass	String	Yes	large	The new instance class of the DTS instance. You can call the DescribeDtsJobDetail operation to query the original instance class of the DTS instance. 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 channels.
RegionId	String	No	cn-hangzhou	The ID of the region in which the DTS instance resides. For more information, see Supported regions.
DtsJobId	String	Yes	r4yr723m199****	The ID of the data migration or data synchronization task. You can call the DescribeDtsJobs operation to query the task ID.

Response parameters

Parameter	Type	Example	Description
EndTime	String	2021-08-04T16:00:00.000+00:00	The expiration time of the DTS instance. Note This parameter is returned only if the value of the ChargeType parameter is PREPAY.
HttpStatusCode	Integer	200	The HTTP status code.
RequestId	String	716DB03E-2D0B-4DC3-BC4C-F7A9EE21****	The request ID.
DtsJobId	String	r4yr723m199****	The ID of the data migration or data synchronization task.
ErrCode	String	InternalError	The error code returned if the request failed.
Success	Boolean	true	Indicates whether the request was successful. Valid values: true false
ChargeType	String	POSTPAY	The billing method of the DTS instance. Valid values: POSTPAY: pay-as-you-go. PREPAY: subscription.
ErrMessage	String	The request processing has failed due to some unknown error.	The error message returned if the request failed.
Code	String	200	The error code that is returned.
DynamicMessage	String	DtsJobId	The dynamic part in the error message. This parameter is used to replace the %s variable in the value of the ErrMessage parameter. Note For example, if the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified value of the DtsJobId parameter is invalid.
InstanceId	String	dtsr4yr723m199****	The ID of the DTS instance.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=TransferInstanceClass
&OrderType=UPGRADE
&InstanceClass=large
&DtsJobId=r4yr723m199****
&<Common request parameters>

Sample success responses

XML format

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

<TransferInstanceClassResponse>
      <DtsJobId>r4yr723m199****</DtsJobId>
      <RequestId>716DB03E-2D0B-4DC3-BC4C-F7A9EE21****</RequestId>
      <InstanceId>dtsr4yr723m199****</InstanceId>
      <ChargeType>POSTPAY</ChargeType>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>  
</TransferInstanceClassResponse>

JSON format

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

{
  "DtsJobId" : "r4yr723m199****",
  "RequestId" : "716DB03E-2D0B-4DC3-BC4C-F7A9EE21****",
  "InstanceId" : "dtsr4yr723m199****",
  "ChargeType" : "POSTPAY",
  "HttpStatusCode" : 200,
  "Success" : true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Throttling.User	Request was denied due to user flow control.	The number of requests exceeded the limit, and the request was rejected. 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.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	The signature expired. Use a new signature.

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