Queries the alert settings of a change tracking 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 DescribeSubscriptionInstanceAlert

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

SubscriptionInstanceId String Yes dtsl8zl9ek6292****

The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID.
RegionId String No cn-hangzhou

The ID of the region where the change tracking 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 ensure 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. The unit is seconds and the value is an integer. The recommended value is 10 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 210ec2e116055198849072222d****

The ID of the request.

SubscriptionInstanceID String dtsl8zl9ek6292****

The ID of the change tracking instance.

SubscriptionInstanceName String test

The name of the change tracking instance.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeSubscriptionInstanceAlert
&SubscriptionInstanceId=dtsl8zl9ek6292****
&<Common request parameters>

Sample responses

XML format 

<DescribeSubscriptionInstanceAlertResponse>
      <SubscriptionInstanceName>test</SubscriptionInstanceName>
      <RequestId>210ec2e116055198849072222d****</RequestId>
      <DelayAlertPhone>1361234****,1371234****</DelayAlertPhone>
      <ErrorAlertStatus>enable</ErrorAlertStatus>
      <DelayAlertStatus>enable</DelayAlertStatus>
      <DelayOverSeconds>10</DelayOverSeconds>
      <Success>true</Success>
</DescribeSubscriptionInstanceAlertResponse>

JSON format 

{
    "SubscriptionInstanceName": "test",
    "RequestId": "210ec2e116055198849072222d****",
    "DelayAlertPhone": "1361234****,1371234****",
    "ErrorAlertStatus": "enable",
    "DelayAlertStatus": "enable",
    "DelayOverSeconds": "10",
    "Success": true
}

Error codes

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