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 automatically 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.

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 %s in the ErrMessage parameter.

Note If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid.
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 for triggering latency alerts. Unit: seconds.

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

The mobile 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 the task enters an abnormal state, 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.

Examples

Sample requests

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

Sample success responses

XML format

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

{
  "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
}

Error codes

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