建立或修改任務警示規則 - Data Transmission Service

DTS目前支援的監控項為延遲、遷移狀態和全量運行耗時：

延遲：監控增量資料移轉延遲資訊，當遷移延遲、同步延遲或訂閱延遲的時間超過設定值時（單位為秒），觸發警示規則。
遷移狀態：監控任務的狀態，當任務的狀態為異常或恢複時，觸發警示規則。
全量運行耗時：全量啟動並執行耗時，超過設定值時（單位為小時），觸發警示規則。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	CreateJobMonitorRule	系統規定參數。取值：CreateJobMonitorRule。
DtsJobId	String	是	i03e3zty16i****	遷移、同步或訂閱任務ID，可通過調用DescribeDtsJobs擷取。
Type	String	否	delay	監控項的類型，取值： delay：延遲監控項。 error：遷移狀態監控項。 full_timeout：全量運行耗時監控項。預設值：error；需手動填入。
State	String	否	Y	是否啟用警示規則，取值： Y：啟用。 N：不啟用。預設值：Y
Phone	String	否	1361234**,1371234**	警示的連絡人手機號碼，多個手機號碼以英文逗號（,）分隔。說明本參數目前只支援中國站，僅支援中國內地手機號碼，且最多傳入10個手機號碼。國際站不支援手機警示，僅支援通過CloudMonitor平台為DTS任務設定警示規則。
DelayRuleTime	Long	否	11	觸發警示的閾值。當Type取值為delay時，單位為秒且需為整數，可根據業務需要設定閾值，建議設定10秒以上，避免因網路、資料庫負載等原因導致的延遲波動。當Type取值為full_timeout時，單位為小時且需為整數。說明當Type取值為delay或full_timeout且State取值為Y時，本參數必須傳入。
RegionId	String	否	cn-hangzhou	DTS執行個體所屬的地區，詳情請參見支援的地區列表。
Period	Integer	否	5	增量校正任務的統計周期，單位為分鐘。說明當前支援取值為1分鐘、5分鐘、10分鐘和30分鐘。
Times	Integer	否	2	增量校正任務的周期數。
NoticeValue	Integer	否	2	警示閾值。
ResourceGroupId	String	否	rg-acfmzawhxxc****	資源群組ID。

返回資料

名稱	類型	樣本值	描述
HttpStatusCode	Integer	200	狀態代碼。
RequestId	String	8C498360-7892-433C-847A-BA71A850****	請求ID。
DtsJobId	String	i03e3zty16i****	遷移、同步或訂閱任務ID。
ErrCode	String	403	調用錯誤時返回的錯誤碼。
Success	Boolean	true	請求是否成功，傳回值： true：請求成功。 false：請求失敗。
ErrMessage	String	The Value of Input Parameter %s is not valid.	調用錯誤時返回的錯誤資訊。
Code	String	200	錯誤碼，本參數即將下線。
DynamicMessage	String	DtsJobId	動態錯誤資訊，用於替換返回參數ErrMessage錯誤資訊中的%s。說明如果ErrMessage返回The Value of Input Parameter %s is not valid，且DynamicMessage返回DtsJobId，則代表所傳入的請求參數DtsJobId不合法。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=CreateJobMonitorRule
&DtsJobId=i03e3zty16i****
&Type=delay
&State=Y
&Phone=1361234****,1371234****
&DelayRuleTime=11
&<公用請求參數>

正常返回樣本

XML格式

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

<CreateJobMonitorRuleResponse>
    <RequestId>8C498360-7892-433C-847A-BA71A850****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <Success>true</Success>
    <DtsJobId>i03e3zty16i****</DtsJobId>
</CreateJobMonitorRuleResponse>

JSON格式

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

{
  "RequestId" : "8C498360-7892-433C-847A-BA71A850****",
  "HttpStatusCode" : 200,
  "Success" : true,
  "DtsJobId" : "i03e3zty16i****"
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	Throttling.User	Request was denied due to user flow control.	由於請求頻次達到閾值，請求被拒絕，請稍後重試。
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	由於服務端響應逾時或者不可用導致請求失敗，請重試，重試後仍失敗請聯絡支援人員。
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	簽名已經到期，請更新簽名

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