调用RenewInstance可以为DTS实例续费。本接口仅适用于预付费类型的DTS实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 RenewInstance

系统规定参数。取值：RenewInstance。

DtsJobId String 是 qi0r643lc31****

同步或订阅任务ID，可调用DescribeDtsJobs查询。

ChargeType String 是 PREPAY

付费类型为PREPAY，包年包月（预付费）。

Period String 否 Month

续费实例的计费方式，取值：

  • Year：包年。
  • Month：包月（默认值）。
BuyCount String 否 1

续费实例购买时长，默认为1。

  • 当Period为Year（包年）时，取值范围为1~5。
  • 当Period为Month（包月）时，取值范围为1~60。
RegionId String 否 cn-hangzhou

DTS实例所在地域的ID，请参见支持的地域列表。

返回数据

名称 类型 示例值 描述
HttpStatusCode Integer 200

状态码。
EndTime String 2021-08-04T16:00:00.000+00:00

续费实例到期时间，格式为yyyy-MM-ddTHH:mm:ssZZZ（UTC时间）。

说明 ZZZ表示完整时区偏移量（“+”或“-”后面跟有小时和分钟），例如：+00:00。
RequestId String 1112E255-0C38-4970-8159-1D54AD92****

请求ID。
ErrCode String InternalError

调用出错时返回的错误码。
DtsJobId String qi0r643lc31****

同步或订阅任务ID。
Success Boolean true

请求是否成功，返回值：

  • true：请求成功。
  • false：请求失败。
ErrMessage String The request processing has failed due to some unknown error.

调用错误时返回对应的错误信息。
ChargeType String PREPAY

付费类型为PREPAY，包年包月（预付费）。

Code String 200

错误码。

说明 本参数即将下线。
DynamicMessage String DtsJobId

动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。

说明 如果ErrMessage返回The Value of Input Parameter %s is not valid，且DynamicMessage返回DtsJobId，则表示所传入的请求参数DtsJobId不合法。
InstanceId String dtsqi0r643lc31****

实例ID。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=RenewInstance
&ChargeType=PREPAY
&DtsJobId=qi0r643lc31****
&Period=Month
&BuyCount=1
&<公共请求参数>

正常返回示例

XML格式 

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格式 

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
}

错误码

HttpCode 错误码 错误信息 描述
400 Throttling.User Request was denied due to user flow control. 由于请求频次达到阈值，请求被拒绝，请稍后重试。
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. 签名已经过期，请更新签名
500 ServiceUnavailable The request has failed due to a temporary failure of the server. 由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。

访问错误中心查看更多错误码。