Queries the status of the task that changes the database connection settings.

Before you call this operation, you must call the SwitchSynchronizationEndpoint operation to change the database connection settings.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeEndpointSwitchStatus

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

TaskId String Yes 11****

The task ID, which is returned after you call the SwitchSynchronizationEndpoint operation.

RegionId String No cn-hangzhou

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

ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe63****

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 ClientToken parameter 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
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.

ErrorMessage String 400

This parameter is no longer available.

RequestId String 0DD6B201-604B-4CAB-B6A8-4B2953B5****

The ID of the request.

Status String Finished

The status of the task. Valid values:

  • NotStarted: The task is not started.
  • Initializing: The task is being initialized.
  • Switching: The task is running.
  • Failed: The task failed.
  • Finished: The task is completed.
Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeEndpointSwitchStatus
&TaskId=11****
&<Common request parameters>

Sample success responses

XML format 

<SwitchSynchronizationEndpointResponse>
      <RequestId>0DD6B201-604B-4CAB-B6A8-4B2953B5****</RequestId>
      <Status>Finished</Status>
      <Success>true</Success>
</SwitchSynchronizationEndpointResponse>

JSON format 

{
    "SwitchSynchronizationEndpointResponse": {
        "RequestId": "0DD6B201-604B-4CAB-B6A8-4B2953B5****",
        "Status": "Finished",
        "Success": true
    }
}

Error codes

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