DescribeJobMonitorRule - Data Transmission Service - Alibaba Cloud Documentation Center

Queries the alert rules of a Data Transmission Service (DTS) task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeJobMonitorRule	The operation that you want to perform. Set the value to DescribeJobMonitorRule.
DtsJobId	String	Yes	ta7w132u12h****	The ID of the data migration, data synchronization, or change tracking task. You can call the DescribeDtsJobs operation to query the task ID.
RegionId	String	No	cn-shenzhen	The region ID of the DTS instance. For more information, see Supported regions.

Response parameters


Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code.
RequestId	String	0CA14388-DD89-4A7B-8CDD-884A10CE****	The request ID.
DtsJobId	String	ta7w132u12h****	The ID of the data migration, data synchronization, or change tracking task.
ErrCode	String	403	The error code returned if the request failed.
Success	Boolean	true	Indicates whether the request was successful. Valid values: true false
ErrMessage	String	The Value of Input Parameter %s is not valid.	The error message returned if the request failed.
Code	String	200	The response code. This parameter will be removed in the future.
DynamicMessage	String	DtsJobId	The dynamic part in the error message. This parameter is used to replace the %s variable in the value of ErrMessage. Note For example, if the return value of ErrMessage is The Value of Input Parameter %s is not valid and the return value of DynamicMessage is DtsJobId, the specified value of DtsJobId is invalid.
MonitorRules	Array of MonitorRule		The alert rules of the DTS task.
Type	String	delay	The type of the alert rule. Valid values: delay: If the latency of the task exceeds the specified threshold, an alert is triggered. error: If an exception occurs, an alert is triggered. full_timeout: If the duration of the full data migration or synchronization module exceeds the specified threshold, an alert is triggered. warn: If the task is complete but the result is not as expected, an alert is triggered.
DelayRuleTime	Long	60	The threshold for triggering an alert. Unit: seconds.
State	String	Y	Indicates whether the alert rule is enabled. Valid values: Y: The alert rule is enabled. N: The alert rule is disabled.
Phone	String	1361234**,1371234**	The mobile numbers that receive alert notifications. Multiple mobile numbers are separated by commas (,).
JobType	String	normal	The type of the DTS task. Valid values: normal: data migration task or data synchronization task. full_check: associated full data verification task. etl_check: associated incremental data verification task.
Period	Integer	5	The statistical period of the incremental data verification task. Unit: minutes. Note Valid values: 1, 5, 10, and 30.
Times	Integer	2	The number of statistical periods of the incremental data verification task.
NoticeValue	Integer	2	The alert threshold.
JobId	String	bi6e22ay243****	The task ID.
Topics	Array of String	['topic_zyjg_prd']	The topics in the Kafka cluster that are used to receive the synchronized or migrated data.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeJobMonitorRule
&DtsJobId=ta7w132u12h****
&<Common request parameters>

Sample success responses

XML format

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 format

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
}

Error codes


HTTP status code	Error code	Error message	Description
400	Throttling.User	Request was denied due to user flow control.	The number of requests exceeds the upper limit, and the request is rejected. Try again later.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	The signature expired. Use a new signature.

For a list of error codes, see Service error codes.