Queries the alert settings of 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 DescribeSynchronizationJobAlert

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

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.
ClientToken String No ETnLKlblzczshOTUbOCz****

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

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
DelayAlertPhone String 1361234****,1371234****

The mobile phone numbers that receive latency-related alerts.

DelayAlertStatus String enable

Indicates whether task latency is monitored. Valid values:

  • enable: yes
  • disable: no
DelayOverSeconds String 10

The threshold for triggering latency alerts. Unit: seconds.

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.

ErrorAlertPhone String 1361234****,1371234****

The mobile phone numbers that receive status-related alerts.

ErrorAlertStatus String enable

Indicates whether task status is monitored. Valid values:

  • enable: yes
  • disable: no
RequestId String 210ec20e16055205968635339d****

The ID of the request.

Success String true

Indicates whether the call was successful.

SynchronizationDirection String Forward

The synchronization direction. Valid values:

  • Forward
  • Reverse
    Note This parameter is returned only when the topology of data synchronization is two-way synchronization.
SynchronizationJobId String kxz1170c10p****

The ID of the data synchronization instance.

SynchronizationJobName String Polar MySQL_TO_RDS MySQL

The name of the data synchronization task.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobAlert
&SynchronizationJobId=dtskxz1170c10p****
&<Common request parameters>

Sample responses

XML format 

<DescribeSynchronizationJobAlertresponse>
      <SynchronizationJobId>kxz1170c10p****</SynchronizationJobId>
      <RequestId>210ec20e16055205968635339d****</RequestId>
      <SynchronizationJobName>Polar MySQL_TO_RDS MySQL</SynchronizationJobName>
      <DelayAlertPhone>1361234****,1371234****</DelayAlertPhone>
      <ErrorAlertStatus>enable</ErrorAlertStatus>
      <DelayAlertStatus>enable</DelayAlertStatus>
      <DelayOverSeconds>10</DelayOverSeconds>
      <Success>true</Success>
</DescribeSynchronizationJobAlertresponse>

JSON format 

{
    "SynchronizationJobId": "kxz1170c10p****",
    "RequestId": "210ec20e16055205968635339d****",
    "SynchronizationJobName": "Polar MySQL_TO_RDS MySQL",
    "DelayAlertPhone": "1361234****,1371234****",
    "ErrorAlertStatus": "enable",
    "DelayAlertStatus": "enable",
    "DelayOverSeconds": "10",
    "Success": true
}

Error codes

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