Queries the number of migrated or synchronized objects in a Data Transmission Service (DTS) task.

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 SummaryJobDetail

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

DtsJobId String Yes l3m1213ye7l****

The ID of the data migration or data synchronization task.

Note You must specify at least one of the DtsJobId and DtsInstanceId parameters.
JobCode String Yes 02

The phase of a data migration task.

  • 02: indicates that the task is in the schema migration phase.
  • 03: indicates that the task is in the incremental migration phase.
SynchronizationDirection String Yes Forward

The synchronization direction of a data synchronization task.

  • Forward: indicates that data is synchronized from the source database to the destination database.
  • Reverse: indicates that data is synchronized form the destination database to the source database.
Note
  • Default value: Forward.
  • You can set this parameter to Reverse to delete the reverse synchronization task only when the topology is two-way synchronization.
RegionId String No cn-hangzhou

The region ID of the DTS instance. For more information, see List of supported regions.

DtsInstanceId String No dtsl3m1213ye7l****

The ID of the data migration or data synchronization instance.

Note You must specify at least one of the DtsJobId and DtsInstanceId parameters.

Response parameters

Parameter Type Example Description
Code String 200

The error code. This parameter will be removed in the future.

HttpStatusCode Integer 200

The HTTP status code.

JobId String l3m1213ye7l****

The ID of the data migration or data synchronization task.

ProgressSummaryDetails Array of ProgressSummaryDetail

The returned information about the migrated objects in arrays.

Note The arrays are in the following format: [{"key":"Function","state":5,"totalCount":22},{"key":"Procedure","state":5,"totalCount":26},{"key":"Table","state":0,"totalCount":68},{"key":"View","state":5,"totalCount":100}].
Key String Table

The type of the migration object. Valid values: Table, Constraint, Index, View, Materialize View, Type, Synonym, Trigger, Function, Procedure, Package, Default, Rule, PlanGuide, and Sequence.

State Integer 0

The status of the data migration task. Valid values:

  • 0: indicates that the task is completed.
  • 1: indicates that the task is waiting to start.
  • 2: indicates that the task is being initialized.
  • 3: indicates that the task is in progress.
  • 4: indicates that an error occurred.
  • 5: indicates that the task failed.
TotalCount Long 100

The total number of synchronized objects.

RequestId String 65EE90A6-9062-51B0-9997-75F7E574****

The ID of the request.

Success Boolean true

Indicates whether the call was successful. Valid values:

  • true
  • false

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=SummaryJobDetail
&DtsJobId=l3m1213ye7l****
&JobCode=02
&SynchronizationDirection=Forward
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<SummaryJobDetailResponse>
      <requestId>65EE90A6-9062-51B0-9997-75F7E574****</requestId>
      <success>true</success>
      <progressSummaryDetails>
            <key>Function</key>
            <state>5</state>
            <totalCount>22</totalCount>
      </progressSummaryDetails>
      <progressSummaryDetails>
            <key>Procedure</key>
            <state>5</state>
            <totalCount>26</totalCount>
      </progressSummaryDetails>
      <progressSummaryDetails>
            <key>Table</key>
            <state>0</state>
            <totalCount>68</totalCount>
      </progressSummaryDetails>
      <progressSummaryDetails>
            <key>View</key>
            <state>5</state>
            <totalCount>100</totalCount>
      </progressSummaryDetails>
      <httpStatusCode>200</httpStatusCode>
</SummaryJobDetailResponse>

JSON format

{
    "requestId": "65EE90A6-9062-51B0-9997-75F7E574****",
    "success": true,
    "progressSummaryDetails": [
        {
            "key": "Function",
            "state": 5,
            "totalCount": 22
        },
        {
            "key": "Procedure",
            "state": 5,
            "totalCount": 26
        },
        {
            "key": "Table",
            "state": 0,
            "totalCount": 68
        },
        {
            "key": "View",
            "state": 5,
            "totalCount": 100
        }
    ],
    "httpStatusCode": 200
}

Error codes

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