創(chuàng)建或修改任務(wù)告警規(guī)則
調(diào)用CreateJobMonitorRule接口創(chuàng)建或修改DTS任務(wù)的告警規(guī)則。
DTS目前支持的監(jiān)控項(xiàng)為延遲、遷移狀態(tài)和全量運(yùn)行耗時:
- 延遲:監(jiān)控增量數(shù)據(jù)遷移延遲信息,當(dāng)遷移延遲、同步延遲或訂閱延遲的時間超過設(shè)定值時(單位為秒),觸發(fā)告警規(guī)則。
- 遷移狀態(tài):監(jiān)控任務(wù)的狀態(tài),當(dāng)任務(wù)的狀態(tài)為異常或恢復(fù)時,觸發(fā)告警規(guī)則。
- 全量運(yùn)行耗時:全量運(yùn)行的耗時,超過設(shè)定值時(單位為小時),觸發(fā)告警規(guī)則。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | CreateJobMonitorRule | 系統(tǒng)規(guī)定參數(shù)。取值:CreateJobMonitorRule。 |
DtsJobId | String | 是 | i03e3zty16i**** | 遷移、同步或訂閱任務(wù)ID,可通過調(diào)用DescribeDtsJobs獲取。 |
Type | String | 否 | delay | 監(jiān)控項(xiàng)的類型,取值:
默認(rèn)值:error;需手動填入。 |
State | String | 否 | Y | 是否啟用告警規(guī)則,取值:
默認(rèn)值:Y |
Phone | String | 否 | 1361234****,1371234**** | 告警的聯(lián)系人手機(jī)號碼,多個手機(jī)號碼以英文逗號(,)分隔。 說明
|
DelayRuleTime | Long | 否 | 11 | 觸發(fā)告警的閾值。
說明 當(dāng)Type取值為delay或full_timeout且State取值為Y時,本參數(shù)必須傳入。 |
RegionId | String | 否 | cn-hangzhou | DTS實(shí)例所屬的地域,詳情請參見支持的地域列表。 |
Period | Integer | 否 | 5 | 增量校驗(yàn)任務(wù)的統(tǒng)計(jì)周期,單位為分鐘。 說明 當(dāng)前支持取值為1分鐘、5分鐘、10分鐘和30分鐘。 |
Times | Integer | 否 | 2 | 增量校驗(yàn)任務(wù)的周期數(shù)。 |
NoticeValue | Integer | 否 | 2 | 告警閾值。 |
ResourceGroupId | String | 否 | rg-acfmzawhxxc**** | 資源組ID。 |
返回?cái)?shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | 狀態(tài)碼。 |
RequestId | String | 8C498360-7892-433C-847A-BA71A850**** | 請求ID。 |
DtsJobId | String | i03e3zty16i**** | 遷移、同步或訂閱任務(wù)ID。 |
ErrCode | String | 403 | 調(diào)用錯誤時返回的錯誤碼。 |
Success | Boolean | true | 請求是否成功,返回值:
|
ErrMessage | String | The Value of Input Parameter %s is not valid. | 調(diào)用錯誤時返回的錯誤信息。 |
Code | String | 200 | 錯誤碼,本參數(shù)即將下線。 |
DynamicMessage | String | DtsJobId | 動態(tài)錯誤信息,用于替換返回參數(shù)ErrMessage錯誤信息中的%s。 說明 如果ErrMessage返回The Value of Input Parameter %s is not valid,且DynamicMessage返回DtsJobId,則代表所傳入的請求參數(shù)DtsJobId不合法。 |
示例
請求示例
http(s)://dts.aliyuncs.com/?Action=CreateJobMonitorRule
&DtsJobId=i03e3zty16i****
&Type=delay
&State=Y
&Phone=1361234****,1371234****
&DelayRuleTime=11
&<公共請求參數(shù)>
正常返回示例
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. | 由于請求頻次達(dá)到閾值,請求被拒絕,請稍后重試。 |
500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 由于服務(wù)端響應(yīng)超時或者不可用導(dǎo)致請求失敗,請重試,重試后仍失敗請聯(lián)系技術(shù)支持。 |
403 | InvalidSecurityToken.Expired | Specified SecurityToken is expired. | 簽名已經(jīng)過期,請更新簽名 |
訪問錯誤中心查看更多錯誤碼。