DescribeRplInspectionTask - PolarDB - Alibaba Cloud Documentation Center

Queries the details of the replication lag inspection task for an instance.

Operation description

During the data synchronization phase, proactively initiates a diagnostic task for the replication task to check for exceptions such as latency, interruption, or data inconsistency.

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

polardbx:DescribeRplInspectionTask

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the instance resides.	cn-hangzhou
FailPageNumber	integer	No	The current page number.	1
FailPageSize	integer	No	The number of records per page.	10
SuccessPageNumber	integer	No	The requested page number.	1
SuccessPageSize	integer	No	The number of records per page.	15
SlinkTaskId	string	No	The switchover task ID.	etx-szr2rr6i*****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Message	string	The error message of the task.	*****
Data	object	The task details.
InspectionTaskList	array<object>	The machine task information.
	object	The machine task information.
CreateTime	integer	The timestamp when the task was created.	2025-09-25T02:36:20.000+0000
Description	string	The description of the inspection task.	For database: wms ,Found SIMPLE sequences in 1.0. PolarDB-X 2.0 does not support SIMPLE sequence any more， please use show sequence to check them.
Id	integer	The task ID.	10142
SlinkTaskId	string	slinktaskid。	etx-hzrez23btmb6aq
Stage	string	The stage name.	CONNECTIVITY
Status	string	The task status.	SUCCEEDED
UpdateTime	integer	The timestamp of the most recent task update.	2025-09-23T03:25:21.000+0000
SlinkStage	string	The slink status.	PRE_CHECK
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Message": "*****",
  "Data": {
    "InspectionTaskList": [
      {
        "CreateTime": 0,
        "Description": "For database: wms ,Found SIMPLE sequences in 1.0. PolarDB-X 2.0 does not support SIMPLE sequence any more， please use show sequence to check them.",
        "Id": 10142,
        "SlinkTaskId": "etx-hzrez23btmb6aq",
        "Stage": "CONNECTIVITY",
        "Status": "SUCCEEDED",
        "UpdateTime": 0
      }
    ],
    "SlinkStage": "PRE_CHECK"
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.