调用DescribeJobMonitorRule查询DTS任务的告警规则。

调试

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

请求参数

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

系统规定参数,取值:DescribeJobMonitorRule

DtsJobId String ta7w132u12h****

迁移、同步或订阅任务ID,可通过调用DescribeDtsJobs获取。

返回数据

名称 类型 示例值 描述
Code String 200

错误码,本参数即将下线。

DtsJobId String ta7w132u12h****

迁移、同步或订阅任务ID。

DynamicMessage String DtsJobId

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

说明 如果ErrMessage返回The Value of Input Parameter %s is not valid,且DynamicMessage返回DtsJobId,则代表所传入的请求参数DtsJobId不合法。
ErrCode String 403

调用出错时返回的错误码。

ErrMessage String The Value of Input Parameter %s is not valid.

调用错误时返回的错误信息。

HttpStatusCode Integer 200

状态码。

MonitorRules Array of MonitorRule

DTS任务的监控规则信息。

DelayRuleTime Long 11

触发延迟告警的阈值,单位为秒。

Phone String 1361234****,1371234****

告警触发后需通知的联系人手机号码,多个手机号码之间以英文逗号(,)分隔。

State String Y

是否启用监控规则,返回值:

  • Y:启用。
  • N:不启用。
Type String delay

监控规则的类型,返回值:

  • delay:延迟告警。
  • error:异常告警。
RequestId String 0CA14388-DD89-4A7B-8CDD-884A10CE****

请求ID。

Success Boolean true

请求是否成功,返回值:

  • true:请求成功。
  • false:请求失败。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeJobMonitorRule
&DtsJobId=ta7w132u12h****
&<公共请求参数>

正常返回示例

XML格式

<DescribeJobMonitorRuleResponse>
      <DtsJobId>ta7w132u12h****</DtsJobId>
      <RequestId>0CA14388-DD89-4A7B-8CDD-884A10CE****</RequestId>
      <HttpStatusCode>200</HttpStatusCode>
      <MonitorRules>
            <Type>delay</Type>
            <Phone>1361234****,1371234****</Phone>
            <State>Y</State>
      </MonitorRules>
      <MonitorRules>
            <Type>error</Type>
            <Phone>1361234****,1371234****</Phone>
            <State>Y</State>
      </MonitorRules>
      <Success>true</Success>
</DescribeJobMonitorRuleResponse>

JSON格式

{
  "DtsJobId": "ta7w132u12h****",
  "RequestId": "0CA14388-DD89-4A7B-8CDD-884A10CE****",
  "HttpStatusCode": 200,
  "MonitorRules": [
    {
      "Type": "delay",
      "Phone": "1361234****,1371234****",
      "State": "Y"
    },
    {
      "Type": "error",
      "Phone": "1361234****,1371234****",
      "State": "Y"
    }
  ],
  "Success": true
}

错误码

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