Obtains a split change task list.

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 DescribeShardTaskList

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

DbName String Yes Jjjjj_ppppp

The name of the DRDS database.

DrdsInstanceId String Yes drdsusrzmd******

The ID of the DRDS instance.

Query String Yes a1

Filter Bar

TaskType String Yes SINGLE_TO_SHARD

Task Type

CurrentPage String Optional 1

The page number of the returned page.

PageSize String Optional 10

The number of entries to return on each page.

RegionId String No cn-hangzhou

RegionId

Response parameters

Prameter Type Sample response Description
List

Returns a collection of objects.

Delay Integer 0

Latency

Expired String 0

Expiration

Expired Long 0

Expiration

Progress Integer 0

Progress

SourceTableName String a1

SOURCE table name

Stage Integer 1

Phase

TargetTableName String a2

Destination table name

PageNumber Integer 1

The total number of pages.

PageSize Integer 10

The number of entries to return on each page.

RequestId String 890BB376-5746-4145-A088-A455F8******

The unique ID of the request. If any problem occurs, provide this request ID for troubleshooting.

Success Boolean true

Indicates whether the API request is successful.

Total Interger 1

The total number of entries returned.

Examples

Sample request


http(s)://[Endpoint]/? Action=DescribeShardTaskList
& <Common request parameters>

Sample success responses

XML format

<DescribeShardTaskListResponse>
	  <code>200</code>
	  <data>
		    <PageSize>10</PageSize>
		    <RequestId>890BB376-5746-4145-A088-A455F8******</RequestId>
		    <PageNumber>1</PageNumber>
		    <Total>1</Total>
		    <List>
			      <SourceTableName>a1</SourceTableName>
			      <Progress>0</Progress>
			      <Stage>1</Stage>
			      <Expired>0</Expired>
			      <TargetTableName>a2</TargetTableName>
			      <Delay>0</Delay>
		    </List>
		    <Success>true</Success>
	  </data>
	  <requestId>890BB376-5746-4145-A088-A455F8******</requestId>
	  <successResponse>true</successResponse>
</DescribeShardTaskListResponse>

JSON format

{
	"successResponse":true,
	"requestId":"890BB376-5746-4145-A088-A455F8******",
	"data":{
		"PageNumber":1,
		"PageSize":10,
		"RequestId":"890BB376-5746-4145-A088-A455F8******",
		"Success":true,
		"List":[
			{
				"Delay":0,
				"Expired":0,
				"SourceTableName":"a1",
				"TargetTableName":"a2",
				"Stage":1,
				"Progress":0
			}
		],
		"Total":1
	},
	"code":"200"
}

Error codes

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