Queries the monitoring 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-hangzhou

The region ID of the DTS instance. For more information, see List of supported regions.

Response parameters

Parameter Type Example Description
Code String 200

The error code. This parameter will be removed in the future.

DtsJobId String ta7w132u12h****

The ID of the data migration, data synchronization, or change tracking task.

DynamicMessage String DtsJobId

The dynamic part in the error message. This parameter is used to replace the %s variable in the ErrMessage parameter.

Note If the specified DtsJobId parameter is invalid, The Value of Input Parameter %s is not valid is returned for ErrMessage and DtsJobId is returned for DynamicMessage.
ErrCode String 403

The error code returned if the call failed.

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

The error message returned if the call failed.

HttpStatusCode Integer 200

The HTTP status code.

MonitorRules Array of MonitorRule

The monitoring rules of the DTS task.

DelayRuleTime Long 11

The threshold that triggers the alert.

  • If the request parameter Type of the CreateJobMonitorRule operation is set to delay, the unit of DelayRuleTime is seconds.
  • If the request parameter Type of the CreateJobMonitorRule operation is set to full_timeout, the unit of DelayRuleTime is hours.
Phone String 1361234****,1371234****

The mobile phone numbers that receive alert notifications. Multiple mobile numbers are separated by commas (,).

State String Y

Indicates whether the monitoring rule is enabled. Valid values:

  • Y: The monitoring rule is enabled.
  • N: The monitoring rule is disabled.
Type String delay

The type of the monitoring rule. Valid values:

  • delay: If the task latency reaches the threshold, an alert is triggered.
  • error: If an exception occurs, an alert is triggered.
RequestId String 0CA14388-DD89-4A7B-8CDD-884A10CE****

The ID of the request.

Success Boolean true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false:The call failed.
Topics List cn_hangzhou_rm_bp1n0x0x5tz******_dtstestdata_version2

The topics of all subtasks in the distributed change tracking task.

Examples

Sample requests

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

Sample success responses

XML format 

<DtsJobId>ta7w132u12h****</DtsJobId>
<RequestId>0CA14388-DD89-4A7B-8CDD-884A10CE****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<MonitorRules>
    <Type>delay</Type>
    <Phone>1361234****,1371234****</Phone>
    <State>Y</State>
    <DelayRuleTime>11</DelayRuleTime>
</MonitorRules>
<DynamicMessage>DtsJobId</DynamicMessage>
<ErrMessage>The Value of Input Parameter %s is not valid.</ErrMessage>
<Code>200</Code>
<Success>true</Success>
<ErrCode>403</ErrCode>

JSON format 

{
    "DtsJobId": "ta7w132u12h****",
    "RequestId": "0CA14388-DD89-4A7B-8CDD-884A10CE****",
    "HttpStatusCode": 200,
    "MonitorRules": {
        "Type": "delay",
        "Phone": "1361234****,1371234****",
        "State": "Y",
        "DelayRuleTime": 11
    },
    "DynamicMessage": "DtsJobId",
    "ErrMessage": "The Value of Input Parameter %s is not valid.",
    "Code": 200,
    "Success": true,
    "ErrCode": 403
}

Error codes

For a list of error codes, visit the API Error Center.