调用DescribeJobMonitorRule查询DTS任务的告警规则_数据传输服务(DTS)-阿里云帮助中心

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeJobMonitorRule	系统规定参数。取值：DescribeJobMonitorRule。
DtsJobId	String	是	ta7w132u12h****	迁移、同步或订阅任务ID，可通过调用DescribeDtsJobs获取。
RegionId	String	否	cn-shenzhen	DTS实例所属的地域，详情请参见支持的地域列表。

返回数据


名称	类型	示例值	描述
HttpStatusCode	Integer	200	状态码。
RequestId	String	0CA14388-DD89-4A7B-8CDD-884A10CE****	请求ID。
DtsJobId	String	ta7w132u12h****	迁移、同步或订阅任务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不合法。
MonitorRules	Array of MonitorRule		DTS任务的监控规则信息。
Type	String	delay	监控规则的类型，返回值： delay：延迟告警。 error：异常告警。 full_timeout：全量模块运行耗时告警。 warn：通知类告警（任务执行成功，结果未达到预期）。
DelayRuleTime	Long	60	触发延迟告警的阈值，单位为秒。
State	String	Y	是否启用监控规则，返回值： Y：启用。 N：不启用。
Phone	String	1361234**,1371234**	告警触发后需通知的联系人手机号码，多个手机号码之间以英文逗号（,）分隔。
JobType	String	normal	DTS实例的任务类型，取值： normal：迁移或同步任务。 full_check：关联的全量校验任务。 etl_check：关联的增量校验任务。
Period	Integer	5	增量校验任务的统计周期，单位为分钟。说明当前支持取值为1分钟、5分钟、10分钟和30分钟。
Times	Integer	2	增量校验任务的周期数。
NoticeValue	Integer	2	告警阈值。
JobId	String	bi6e22ay243****	任务ID。
Topics	Array of String	['topic_zyjg_prd']	同步或迁移到Kafka时的Topic。

示例

请求示例

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

正常返回示例

XML格式

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

<DescribeJobMonitorRuleResponse>
    <DtsJobId>y5il58kzo9n****</DtsJobId>
    <RequestId>90DB5FA4-8C53-5123-91A9-63A4CA42****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <MonitorRules>
        <Type>delay</Type>
        <JobType>normal</JobType>
        <State>N</State>
        <Phone>1361234****</Phone>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>0</NoticeValue>
        <DelayRuleTime>0</DelayRuleTime>
        <JobId>y5il58kzo9n****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>full_timeout</Type>
        <JobType>normal</JobType>
        <State>Y</State>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>0</NoticeValue>
        <JobId>y5il58kzo9n****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>error</Type>
        <JobType>normal</JobType>
        <State>N</State>
        <Phone>1361234****</Phone>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>0</NoticeValue>
        <JobId>y5il58kzo9n****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>error</Type>
        <JobType>full_check</JobType>
        <State>Y</State>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>0</NoticeValue>
        <JobId>qm2g550ku9x****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>warn</Type>
        <JobType>full_check</JobType>
        <State>Y</State>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>1</NoticeValue>
        <JobId>qm2g550ku9x****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>error</Type>
        <JobType>etl_check</JobType>
        <State>Y</State>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>0</NoticeValue>
        <JobId>wrdx5a8pc93****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>delay</Type>
        <JobType>etl_check</JobType>
        <State>Y</State>
        <Times>2</Times>
        <Period>3</Period>
        <NoticeValue>0</NoticeValue>
        <DelayRuleTime>60</DelayRuleTime>
        <JobId>wrdx5a8pc93****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>warn</Type>
        <JobType>etl_check</JobType>
        <State>Y</State>
        <Times>2</Times>
        <Period>3</Period>
        <NoticeValue>1</NoticeValue>
        <JobId>wrdx5a8pc93****</JobId>
    </MonitorRules>
    <Success>true</Success>
</DescribeJobMonitorRuleResponse>

JSON格式

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

{
  "DtsJobId" : "y5il58kzo9n****",
  "Topics" : [ ],
  "RequestId" : "90DB5FA4-8C53-5123-91A9-63A4CA42****",
  "HttpStatusCode" : 200,
  "MonitorRules" : [ {
    "Type" : "delay",
    "JobType" : "normal",
    "State" : "N",
    "Phone" : "1361234****",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 0,
    "DelayRuleTime" : 0,
    "JobId" : "y5il58kzo9n****"
  }, {
    "Type" : "full_timeout",
    "JobType" : "normal",
    "State" : "Y",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 0,
    "JobId" : "y5il58kzo9n****"
  }, {
    "Type" : "error",
    "JobType" : "normal",
    "State" : "N",
    "Phone" : "1361234****",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 0,
    "JobId" : "y5il58kzo9n****"
  }, {
    "Type" : "error",
    "JobType" : "full_check",
    "State" : "Y",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 0,
    "JobId" : "qm2g550ku9x****"
  }, {
    "Type" : "warn",
    "JobType" : "full_check",
    "State" : "Y",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 1,
    "JobId" : "qm2g550ku9x****"
  }, {
    "Type" : "error",
    "JobType" : "etl_check",
    "State" : "Y",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 0,
    "JobId" : "wrdx5a8pc93****"
  }, {
    "Type" : "delay",
    "JobType" : "etl_check",
    "State" : "Y",
    "Times" : 2,
    "Period" : 3,
    "NoticeValue" : 0,
    "DelayRuleTime" : 60,
    "JobId" : "wrdx5a8pc93****"
  }, {
    "Type" : "warn",
    "JobType" : "etl_check",
    "State" : "Y",
    "Times" : 2,
    "Period" : 3,
    "NoticeValue" : 1,
    "JobId" : "wrdx5a8pc93****"
  } ],
  "Success" : true
}

错误码


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.	签名已经过期，请更新签名

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