调用CreateJobMonitorRule接口创建或修改DTS任务的告警规则。

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****

告警的联系人手机号码,多个手机号码以英文逗号(,)分隔。

说明
DelayRuleTime Long 11

触发告警的阈值。

  • Type取值为delay时,单位为秒且需为整数,可根据业务需要设置阈值,建议设置10秒以上,避免因网络、数据库负载等原因导致的延迟波动。
  • Type取值为full_timeout时,单位为小时且需为整数。
说明Type取值为delayfull_timeoutState取值为Y时,本参数必须传入。
RegionId String cn-hangzhou

DTS实例所属的地域,详情请参见支持的地域列表

Period Integer 5

增量校验任务的统计周期,单位为分钟。

说明 当前支持取值为1分钟、5分钟、10分钟和30分钟。
Times Integer 2

增量校验任务的周期数。

NoticeValue Integer 2

告警阈值。

返回数据

名称 类型 示例值 描述
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. 签名已经过期,请更新签名

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