Queries information about a tool used to perform conversion and sharding.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeShardTaskInfo |
The operation that you want to perform. Set the value to DescribeShardTaskInfo. |
DbName | String | Yes | jjjjjj_ppppp |
The name of the database. |
DrdsInstanceId | String | Yes | drds********* |
The ID of the PolarDB-X 1.0 instance. |
SourceTableName | String | Yes | a1 |
The name of the table that you want to convert or shard. |
TargetTableName | String | Yes | a2 |
The name of the table that is generated after you convert or shard the table. |
RegionId | String | No | cn-hangzhou |
The ID of the region. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Struct |
Indicates the data that is returned. |
|
Expired | String | 0 |
Indicates the number of remaining days before the tasks to shard tables or convert tables expire. |
Full | Struct |
Indicates information about full migration tasks. |
|
Expired | Integer | 0 |
Indicates the number of remaining days before the tasks expire. |
Progress | Integer | 100 |
Indicates the progress of the tasks. |
StartTime | String | 2019-09-16 15:11:53 |
Indicates the start time when the tasks are performed. |
Total | Integer | 2 |
Indicates the number of tasks. |
Tps | Integer | 0 |
Indicates the number of transactions processed by the database per second. |
FullCheck | Struct |
Indicates information about full check tasks. |
|
Expired | Integer | 0 |
Indicates the number of remaining days before the tasks expire. |
Progress | Integer | 0 |
Indicates the progress of the tasks. |
StartTime | String | 2019-09-16 15:12:53 |
Indicates the start time when the tasks are performed. |
Total | Integer | 0 |
Indicates the number of tasks. |
Tps | Integer | 0 |
Indicates the number of transactions processed by the database per second. |
FullRevise | Struct |
Indicates information about full correction tasks. |
|
Expired | Integer | 0 |
Indicates the number of remaining days before the tasks expire. |
Progress | Integer | 0 |
Indicates the progress of the tasks. |
StartTime | String | 2019-09-16 15:12:53 |
Indicates the start time when the tasks are performed. |
Total | Integer | 0 |
Indicates the number of tasks. |
Tps | Integer | 0 |
Indicates the number of transactions processed by the database per second. |
Increment | Struct |
Indicates information about incremental data synchronization. |
|
Delay | Integer | 1568617906 |
Indicates the latency of the incremental data synchronization. |
StartTime | String | 2019-09-16 15:12:53 |
Indicates the start time when the incremental data synchronization is performed. |
Tps | Integer | 10 |
Indicates the number of transactions processed by the database per second. |
Progress | String | 70 |
Indicates the incremental data synchronization progress. |
Review | Struct |
Indicates check tasks. |
|
Expired | Integer | 0 |
Indicates the number of remaining days before the tasks expire. |
Progress | Integer | 0 |
Indicates the progress of the tasks. |
StartTime | String | 2019-09-16 15:12:53 |
Indicates the start time when the tasks are performed. |
Total | Integer | 5 |
Indicates the number of tasks. |
Tps | Integer | 10 |
Indicates the number of transactions processed by the database per second. |
SourceTableName | String | a1 |
Indicates the name of the table that you convert or shard. |
Stage | String | 2 |
Indicates the current stage of the task. |
Status | String | Incremental synchronization |
Indicates the state of the tasks to shard tables or convert tables. |
TargetTableName | String | a2 |
Indicates the name of the table after you convert or shard the table. |
RequestId | String | 5D64DE5944A1E541E0CB908A |
Indicates the unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure. |
Success | Boolean | true |
Indicates whether the request is successful. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeShardTaskInfo
&DbName=jjjjjj_ppppp
&DrdsInstanceId=drds*********
&SourceTableName=a1
&TargetTableName=a2
&<Common request parameters>
Sample success responses
XML
format
<RequestId>5D64DE5944A1E541E0CB908A</RequestId>
<Data>
<Status>Incremental synchronization</Status>
<SourceTableName>a1</SourceTableName>
<Progress>70</Progress>
<Stage>2</Stage>
<Expired>0</Expired>
<TargetTableName>a2</TargetTableName>
<Full>
<Progress>100</Progress>
<Tps>0</Tps>
<Total>2</Total>
<StartTime>2019-09-16 15:11:53</StartTime>
<Expired>0</Expired>
</Full>
<FullCheck>
<Progress>0</Progress>
<Tps>0</Tps>
<Total>0</Total>
<StartTime>2019-09-16 15:12:53</StartTime>
<Expired>0</Expired>
</FullCheck>
<FullRevise>
<Progress>0</Progress>
<Tps>0</Tps>
<Total>0</Total>
<StartTime>2019-09-16 15:12:53</StartTime>
<Expired>0</Expired>
</FullRevise>
<Review>
<Progress>0</Progress>
<Tps>10</Tps>
<Total>5</Total>
<StartTime>2019-09-16 15:12:53</StartTime>
<Expired>0</Expired>
</Review>
<Increment>
<Tps>10</Tps>
<StartTime>2019-09-16 15:12:53</StartTime>
<Delay>1568617906</Delay>
</Increment>
</Data>
<Success>true</Success>
JSON
format
{"RequestId":"5D64DE5944A1E541E0CB908A","Data":{"Status":"Incremental synchronization","SourceTableName":"a1","Progress":"70","Stage":"2","Expired":"0","TargetTableName":"a2","Full":{"Progress":"100","Tps":"0","Total":"2","StartTime":"2019-09-16 15:11:53","Expired":"0"},"FullCheck":{"Progress":"0","Tps":"0","Total":"0","StartTime":"2019-09-16 15:12:53","Expired":"0"},"FullRevise":{"Progress":"0","Tps":"0","Total":"0","StartTime":"2019-09-16 15:12:53","Expired":"0"},"Review":{"Progress":"0","Tps":"10","Total":"5","StartTime":"2019-09-16 15:12:53","Expired":"0"},"Increment":{"Tps":"10","StartTime":"2019-09-16 15:12:53","Delay":"1568617906"}},"Success":"true"}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
500 | InternalError | The request processing has failed due to some unknown error. | The error message returned because an internal error has occurred. |
For a list of error codes, visit the API Error Center.