Queries the alert settings of a data migration 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 DescribeMigrationJobAlert

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

MigrationJobId String Yes dtslb9113qq11n****

The ID of the data migration instance. You can call the DescribeMigrationJobs operation to query the instance ID.

RegionId String No cn-hangzhou

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

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

The mobile phone numbers that receive status-related alerts.

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.

DelayOverSeconds String 10

The threshold for triggering latency alerts. Unit: seconds.

ErrorAlertStatus String enable

Indicates whether task status is monitored. Valid values:

  • enable: yes
  • disable: no
MigrationJobId String lb9113qq11n****

The ID of the data migration instance.

MigrationJobName String PolarDB MySQL_to_RDS MySQL

The name of the data migration task.

RequestId String 210ec21916055187057342533d****

The ID of the request.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeMigrationJobAlert
&MigrationJobId=dtslb9113qq11n****
&<Common request parameters>

Sample responses

XML format 

<DescribeMigrationJobAlertresponse>
      <RequestId>210ec21916055187057342533d****</RequestId>
      <DelayAlertPhone>1361234****,1371234****</DelayAlertPhone>
      <ErrorAlertStatus>enable</ErrorAlertStatus>
      <MigrationJobName>PolarDB MySQL_to_RDS MySQL</MigrationJobName>
      <DelayAlertStatus>enable</DelayAlertStatus>
      <DelayOverSeconds>10</DelayOverSeconds>
      <Success>true</Success>
      <MigrationJobId>lb9113qq11n****</MigrationJobId>
</DescribeMigrationJobAlertresponse>

JSON format 

{
    "RequestId": "210ec21916055187057342533d****",
    "DelayAlertPhone": "1361234****,1371234****",
    "ErrorAlertStatus": "enable",
    "MigrationJobName": "PolarDB MySQL_to_RDS MySQL",
    "DelayAlertStatus": "enable",
    "DelayOverSeconds": "10",
    "Success": true,
    "MigrationJobId": "lb9113qq11n****"
}

Error codes

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