Upgrades or downgrades 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 automatically 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

Specifies whether to upgrade or downgrade the DTS instance. Valid values:

  • UPGRADE
  • DOWNGRADE
Note To downgrade a DTS instance, you must submit a ticket.
InstanceClass String No 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 instances.
RegionId String No cn-hangzhou

The ID of the region where the DTS instance resides. For more information, see List of supported regions.

DtsJobId String No 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
ChargeType String POSTPAY

The billing method of the DTS instance. Valid values:

  • POSTPAY: pay-as-you-go
  • PREPAY: subscription
Code String 200

The error code.

DtsJobId String r4yr723m199****

The ID of the data migration or data synchronization task.

DynamicMessage String DtsJobId

The dynamic part in the error message. This parameter is used to replace the %s variable in the ErrMessage parameter.

Note 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 DtsJobId parameter is invalid.
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 ChargeType parameter is set to PREPAY.
ErrCode String InternalError

The error code returned if the call failed.

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

The error message returned if the call failed.

HttpStatusCode Integer 200

The HTTP status code.

InstanceId String dtsr4yr723m199****

The ID of the DTS instance.

RequestId String 716DB03E-2D0B-4DC3-BC4C-F7A9EE21****

The ID of the request.

Success Boolean true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

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

Sample success responses

XML format

<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

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

Error codes

For a list of error codes, visit the API Error Center.