為DTS執行個體續約 - Data Transmission Service

調試

您可以在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.	由於服務端響應逾時或者不可用導致請求失敗，請重試，重試後仍失敗請聯絡支援人員。

訪問錯誤中心查看更多錯誤碼。