DescribeSynchronizationJobStatusList - Data Transmission Service

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	DescribeSynchronizationJobStatusList	The operation that you want to perform. Set the value to DescribeSynchronizationJobStatusList.
SynchronizationJobIdListJsonStr	String	Yes	["dtsexjk1alb116**","dtskfq1149w254**"]	The IDs of the data synchronization instances. The value is a JSON array. You can call the DescribeSynchronizationJobs operation to query the instance IDs.
RegionId	String	No	cn-hangzhou	The ID of the region where the data synchronization instances reside. 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.
PageNumber	Integer	1	The page number of the returned page.
PageRecordCount	Integer	2	The number of data synchronization instances displayed on one page.
RequestId	String	1413460B-138A-48D1-836C-B24EDDC1****	The ID of the request.
Success	String	true	Indicates whether the call was successful.
SynchronizationJobListStatusList	Array of SynchronizationJobStatusInfo		The status of the data synchronization tasks.
SynchronizationDirectionInfoList	Array of SynchronizationDirectionInfo		The details of data synchronization tasks in each direction.
Checkpoint	String	1610524452	The UNIX timestamp generated when the latest data record was synchronized. Note You can use a search engine to obtain a UNIX timestamp converter.
Status	String	InitializeFailed	The status of the data synchronization task in this direction. Valid values: NotStarted: The task is not started. Prechecking: The task is being prechecked. PrecheckFailed: The task failed to pass the precheck. Initializing: The task is performing initial synchronization. InitializeFailed: Initial synchronization failed. Synchronizing: The task is synchronizing data. Failed: The task failed to synchronize data. Suspending: The task is paused. Modifying: The objects in the task are being modified. Finished: The task is completed.
SynchronizationDirection	String	Forward	The synchronization direction. Valid values: Forward Reverse
SynchronizationJobId	String	dtsexjk1alb116****	The ID of the data synchronization instance.
TotalRecordCount	Long	2	The total number of data synchronization instances.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobStatusList
&SynchronizationJobIdListJsonStr=["dtsexjk1alb116****","dtskfq1149w254****"]
&<Common request parameters>

Sample responses

XML format

<DescribeSynchronizationJobStatusListResponse>
      <TotalRecordCount>2</TotalRecordCount>
      <PageRecordCount>2</PageRecordCount>
      <RequestId>1413460B-138A-48D1-836C-B24EDDC1****</RequestId>
      <PageNumber>1</PageNumber>
      <SynchronizationJobListStatusList>
            <SynchronizationJobId>dtsexjk1alb116****</SynchronizationJobId>
            <SynchronizationDirectionInfoList>
                  <Status>InitializeFailed</Status>
                  <SynchronizationDirection>Forward</SynchronizationDirection>
            </SynchronizationDirectionInfoList>
      </SynchronizationJobListStatusList>
      <SynchronizationJobListStatusList>
            <SynchronizationJobId>dtskfq1149w254****</SynchronizationJobId>
            <SynchronizationDirectionInfoList>
                  <Status>Failed</Status>
                  <Checkpoint>1610524457</Checkpoint>
                  <SynchronizationDirection>Forward</SynchronizationDirection>
            </SynchronizationDirectionInfoList>
      </SynchronizationJobListStatusList>
      <Success>true</Success>
</DescribeSynchronizationJobStatusListResponse>

JSON format

{
    "TotalRecordCount": 2,
    "PageRecordCount": 2,
    "RequestId": "1413460B-138A-48D1-836C-B24EDDC1****",
    "PageNumber": 1,
    "SynchronizationJobListStatusList": [
        {
            "SynchronizationJobId": "dtsexjk1alb116****",
            "SynchronizationDirectionInfoList": [
                {
                    "Status": "InitializeFailed",
                    "SynchronizationDirection": "Forward"
                }
            ]
        },
        {
            "SynchronizationJobId": "dtskfq1149w254****",
            "SynchronizationDirectionInfoList": [
                {
                    "Status": "Failed",
                    "Checkpoint": "1610524457",
                    "SynchronizationDirection": "Forward"
                }
            ]
        }
    ],
    "Success": true
}

Error codes

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