RenewInstance - Data Transmission Service

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	RenewInstance	The operation that you want to perform. Set the value to RenewInstance.
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.
ChargeType	String	Yes	PREPAY	The billing method of the DTS instance. Set the value to PREPAY, which indicates the subscription billing method.
Period	String	No	Month	The billing cycle of the DTS instance after renewal. Valid values: Year: annual subscription. Month: monthly subscription. This is the default value.
BuyCount	String	No	1	The subscription duration of the DTS instance after renewal. Default value: 1. If the Period parameter is set to Year, the valid values are 1 to 5. If the Period parameter is set to Month, the valid values are 1 to 60.
RegionId	String	No	cn-hangzhou	The region ID of the DTS instance. For more information, see List of supported regions.

Response parameters


Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code.
EndTime	String	2021-08-04T16:00:00.000+00:00	The time when the DTS instance expires after renewal. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZZZ format. The time is displayed in UTC. Note ZZZ indicates the offset of the time zone, which is displayed in the format of a plus sign (+) or a minus sign (-) followed by hours and minutes, such as +00:00.
RequestId	String	1112E255-0C38-4970-8159-1D54AD92****	The ID of the request.
ErrCode	String	InternalError	The error code returned if the request failed.
DtsJobId	String	qi0r643lc31****	The ID of the data synchronization or change tracking task.
Success	Boolean	true	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.
ErrMessage	String	The request processing has failed due to some unknown error.	The error message returned if the request failed.
ChargeType	String	PREPAY	The billing method of the DTS instance. PREPAY is returned, which indicates the subscription billing method.
Code	String	200	The error code. Note This parameter will be removed in the future.
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.
InstanceId	String	dtsqi0r643lc31****	The ID of the DTS instance.

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

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

<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

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

{
  "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


HTTP status code	Error code	Error message	Description
400	Throttling.User	Request was denied due to user flow control.	The error message returned because the number of requests exceeds the limit and the request is rejected. Try again later.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	The error message returned because the signature expired. Use a new signature.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The error message returned because the response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.

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