Renews a DTS instance. This API operation is applicable to only subscription instances.

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 RenewInstance

The operation that you want to perform. Set the value to RenewInstance.

ChargeType String Yes PREPAY

The billing method of the DTS instance. Valid value: PREPAY, which indicates the subscription billing method.

DtsJobId String Yes qi0r643lc31****

The ID of the data synchronization or change tracking task. You can call the DescribeDtsJobs operation to query the task ID.

Period String No Month

The billing cycle of the subscription instance. Valid values:

  • Year
  • Month (default value)
BuyCount String No 1

The subscription length.

  • If the Period parameter is set to Year, the value range is 1 to 5.
  • If the Period parameter is set to Month, the value range is 1 to 60.
RegionId String No cn-hangzhou

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

Response parameters

Parameter Type Example Description
ChargeType String PREPAY

The billing method of the DTS instance. Valid value: PREPAY, which indicates the subscription billing method.

Code String 200

The error code.

Note This parameter will be removed in the future.
DtsJobId String qi0r643lc31****

The ID of the data synchronization or change tracking 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 renewed instance.

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 dtsqi0r643lc31****

The ID of the DTS instance.

RequestId String 1112E255-0C38-4970-8159-1D54AD92****

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=RenewInstance
&ChargeType=PREPAY
&DtsJobId=qi0r643lc31****
&Period=Month
&BuyCount=1
&<Common request parameters>

Sample success responses

XML format

<RenewInstanceResponse>
  <DtsJobId>qi0r643lc31****</DtsJobId>
  <EndTime>2021-08-04T16:00:00.000+00:00</EndTime>
  <RequestId>1112E255-0C38-4970-8159-1D54AD92****</RequestId>
  <InstanceId>dtsqi0r643lc31****</InstanceId>
  <ChargeType>PREPAY</ChargeType>
  <HttpStatusCode>200</HttpStatusCode>
  <Success>true</Success>
</RenewInstanceResponse>

JSON format

{
   "DtsJobId": "qi0r643lc31****",
   "EndTime": "2021-08-04T16:00:00.000+00:00",
   "RequestId": "1112E255-0C38-4970-8159-1D54AD92****",
   "InstanceId": "dtsqi0r643lc31****",
   "ChargeType": "PREPAY",
   "HttpStatusCode": 200,
   "Success": true
}

Error codes

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