Configures alert settings to monitor a data synchronization instance.

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 ConfigureSynchronizationJobAlert

The operation that you want to perform. Set the value to ConfigureSynchronizationJobAlert.

SynchronizationJobId String Yes dtskxz1170c10p****

The ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query the instance ID.

RegionId String No cn-hangzhou

The ID of the region where the data synchronization instance resides. For more information, see List of supported regions.

SynchronizationDirection String No Forward

The synchronization direction. Valid values:

  • Forward
  • Reverse
Note Default value: Forward.
DelayAlertStatus String No enable

Specifies whether to monitor task latency. Valid values:

  • enable: yes
  • disable: no
Note
  • The default value is enable.
  • You must specify at least one of the DelayAlertStatus and ErrorAlertStatus parameters.
DelayAlertPhone String No 1361234****,1371234****

The mobile phone numbers that receive latency-related alerts. Separate mobile phone numbers with commas (,).

Note
  • This parameter is available only for China site (aliyun.com) users. Only mobile phone numbers in mainland China are supported. Up to 10 mobile phone numbers can be specified.
  • International site (alibabacloud.com) users cannot receive alerts by using mobile phones, but can set alert rules for DTS tasks in the Cloud Monitor console.
ErrorAlertStatus String No enable

Specifies whether to monitor task status. Valid values:

  • enable: yes
  • disable: no
Note
  • The default value is enable.
  • You must specify at least one of the DelayAlertStatus and ErrorAlertStatus parameters.
  • If the task that you monitor enters an abnormal state, an alert is triggered.
ErrorAlertPhone String No 1361234****,1371234****

The mobile phone numbers that receive status-related alerts. Separate mobile phone numbers with commas (,).

Note
  • This parameter is available only for China site (aliyun.com) users. Only mobile phone numbers in mainland China are supported. Up to 10 mobile phone numbers can be specified.
  • International site (alibabacloud.com) users cannot receive alerts by using mobile phones, but can set alert rules for DTS tasks in the Cloud Monitor console.
DelayOverSeconds String No 10

The threshold for triggering latency alerts. The unit is seconds and the value must be an integer. You can set the threshold based on your business needs. To avoid delay fluctuations caused by network and database loads, we recommend that you set the threshold to more than 10 seconds.

Note If the DelayAlertStatus parameter is set to enable, this parameter must be specified.
AccountId String No 12323344****

The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter will be removed in the future.

Response parameters

Parameter Type Example Description
ErrCode String InternalError

The error code returned if the call failed.

ErrMessage String The request processing has failed due to some unknown error.

The error message returned if the call failed.

RequestId String 8EEE7858-7D41-4EDF-9435-AEED2A34****

The ID of the request.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=ConfigureSynchronizationJobAlert
&SynchronizationJobId=dtskxz1170c10p****
&DelayAlertStatus=enable
&DelayAlertPhone=1361234****,1371234****
&DelayOverSeconds=10
&<Common request parameters>

Sample responses

XML format

<ConfigureSynchronizationJobAlertResponse>
      <RequestId>8EEE7858-7D41-4EDF-9435-AEED2A34****</RequestId>
      <Success>true</Success>
</ConfigureSynchronizationJobAlertResponse>

JSON format

{
    "RequestId": "8EEE7858-7D41-4EDF-9435-AEED2A34****",
    "Success": true
}

Error codes

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