DescribeShardTaskInfo - PolarDB - Alibaba Cloud Documentation Center

Queries the details of the shard change tool by calling DescribeShardTaskInfo.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

drds:DescribeShardTaskInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
DrdsInstanceId	string	Yes	The instance ID.	drds*********
DbName	string	Yes	The database name.	jjjjjj_ppppp
SourceTableName	string	Yes	The source table name.	a1
TargetTableName	string	Yes	The target table name.	a2

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful.	true
RequestId	string	The unique request ID. If you encounter an issue, provide this request ID for troubleshooting.	5D64DE5944A1E541E0CB908A
Data	object	The returned data.
Status	string	The status.	增量追平
Stage	string	The current stage.	2
Progress	string	The progress.	70
Expired	string	The expiration time.	0
TargetTableName	string	The target table name.	a2
SourceTableName	string	The source table name.	a1
Full	object	The full migration information.
StartTime	string	Indicates the start time when the tasks are performed.	2019-09-16 15:11:53
Progress	integer	Indicates the progress of the tasks.	100
Tps	integer	Indicates the number of transactions processed by the database per second.	0
Total	integer	Indicates the number of tasks.	2
Expired	integer	Indicates the number of remaining days before the tasks expire.	0
FullCheck	object	The full check information.
StartTime	string	Indicates the start time when the tasks are performed.	2019-09-16 15:12:53
Progress	integer	Indicates the progress of the tasks.	0
Tps	integer	Indicates the number of transactions processed by the database per second.	0
Total	integer	Indicates the number of tasks.	0
Expired	integer	Indicates the number of remaining days before the tasks expire.	0
FullRevise	object	The full revision information.
StartTime	string	Indicates the start time when the tasks are performed.	2019-09-16 15:12:53
Progress	integer	Indicates the progress of the tasks.	0
Tps	integer	Indicates the number of transactions processed by the database per second.	0
Total	integer	Indicates the number of tasks.	0
Expired	integer	Indicates the number of remaining days before the tasks expire.	0
Review	object	The review information.
StartTime	string	Indicates the start time when the tasks are performed.	2019-09-16 15:12:53
Progress	integer	Indicates the progress of the tasks.	0
Tps	integer	Indicates the number of transactions processed by the database per second.	10
Total	integer	Indicates the number of tasks.	5
Expired	integer	Indicates the number of remaining days before the tasks expire.	0
Increment	object	The incremental migration information.
Delay	integer	Indicates the latency of the incremental data synchronization.	1568617906
StartTime	string	Indicates the start time when the incremental data synchronization is performed.	2019-09-16 15:12:53
Tps	integer	Indicates the number of transactions processed by the database per second.	10

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "5D64DE5944A1E541E0CB908A",
  "Data": {
    "Status": "增量追平",
    "Stage": "2",
    "Progress": "70",
    "Expired": "0",
    "TargetTableName": "a2",
    "SourceTableName": "a1",
    "Full": {
      "StartTime": "2019-09-16 15:11:53",
      "Progress": 100,
      "Tps": 0,
      "Total": 2,
      "Expired": 0
    },
    "FullCheck": {
      "StartTime": "2019-09-16 15:12:53",
      "Progress": 0,
      "Tps": 0,
      "Total": 0,
      "Expired": 0
    },
    "FullRevise": {
      "StartTime": "2019-09-16 15:12:53",
      "Progress": 0,
      "Tps": 0,
      "Total": 0,
      "Expired": 0
    },
    "Review": {
      "StartTime": "2019-09-16 15:12:53",
      "Progress": 0,
      "Tps": 10,
      "Total": 5,
      "Expired": 0
    },
    "Increment": {
      "Delay": 1568617906,
      "StartTime": "2019-09-16 15:12:53",
      "Tps": 10
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.