Queries the information about the objects to be migrated or synchronized in a Data Transmission Service (DTS) task.
Debugging
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. |
JobCode | String | Yes | 02 | The phase of the data migration task. Valid values:
|
SynchronizationDirection | String | Yes | Forward | The synchronization direction of the data synchronization task. Valid values:
Note
|
RegionId | String | No | cn-hangzhou | The region ID of the DTS instance. For more information, see Supported regions. |
DtsInstanceId | String | No | dtsl3m1213ye7l**** | The ID of the data migration or data synchronization instance. |
StructType | String | No | before | The type of schema definition. Valid values:
|
Response parameters
Parameter |
Type |
Example |
Description |
HttpStatusCode | Integer | 200 | The HTTP status code. |
Code | String | 200 | The error code returned if the request failed. |
RequestId | String | 9033138C-5AB3-5EB7-BA78-43131F19297C | The request ID. |
Success | Boolean | true | Indicates whether the request was successful. Valid values:
|
JobId | String | l3m1213ye7l**** | The ID of the data migration or data synchronization task. |
ProgressSummaryDetails | Array of ProgressSummaryDetail | The returned information about the objects in an array. Note The array is 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 object. Valid values: Table, Constraint, Index, View, Materialize View, Type, Synonym, Trigger, Function, Procedure, Package, Default, Rule, PlanGuide, and Sequence. |
TotalCount | Long | 100 | The total number of objects. |
State | Integer | 0 | The state of data migration or data synchronization. Valid values:
|
Examples
Sample requests
http(s)://dts.aliyuncs.com/?Action=SummaryJobDetail
&DtsJobId=l3m1213ye7l****
&JobCode=02
&SynchronizationDirection=Forward
&RegionId=cn-hangzhou
&DtsInstanceId=dtsl3m1213ye7l****
&StructType=before
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<SummaryJobDetailResponse>
<HttpStatusCode>200</HttpStatusCode>
<Code>200</Code>
<RequestId>9033138C-5AB3-5EB7-BA78-43131F19297C</RequestId>
<Success>true</Success>
<JobId>l3m1213ye7l****</JobId>
<ProgressSummaryDetails>
<Key>Table</Key>
<TotalCount>100</TotalCount>
<State>0</State>
</ProgressSummaryDetails>
</SummaryJobDetailResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"Code" : "200",
"RequestId" : "9033138C-5AB3-5EB7-BA78-43131F19297C",
"Success" : true,
"JobId" : "l3m1213ye7l****",
"ProgressSummaryDetails" : [ {
"Key" : "Table",
"TotalCount" : 100,
"State" : 0
} ]
}
Error codes
HTTP status code |
Error code |
Error message |
Description |
400 | Throttling.User | Request was denied due to user flow control. | The number of requests exceeded the limit, and the request was rejected. Try again later. |
500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | The response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support. |
403 | InvalidSecurityToken.Expired | Specified SecurityToken is expired. | The signature expired. Use a new signature. |
For a list of error codes, see Service error codes.