CreateRplInspectionTask - PolarDB - Alibaba Cloud Documentation Center

Operation description

During the data synchronization phase, proactively initiates a diagnostic task for the replication task to check for issues such as latency, replication 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:CreateRplInspectionTask

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SlinkTaskId	string	Yes	The switchover task ID.	etx-szr2rr6i*****
RegionId	string	Yes	The region ID. > You can call the DescribeRegions operation to query the regions supported by PolarDB-X, including region IDs.	cn-hangzhou
SrcUserName	string	No	The username used to connect to the source instance (source database).	bbt_ump
SrcPassword	string	No	The password of the source ApsaraDB RDS instance. > You can call the DescribeDBInstances operation to query the details of all instances in the specified region, including the password.	******
DstResId	string	No	The destination task ID.	pxc-zkrc1****l54rc
DstDb	string	No	The ID of the ApsaraDB RDS instance to which the migration object belongs in the target instance. > You can invoke the DescribeDBInstances operation to query the details of all ApsaraDB RDS instances in the specified region, including instance IDs.	transfer_test3
DstUserName	string	No	The username used to connect to the target instance.	bbt_item
DstPassword	string	No	The password of the privileged user for the destination ApsaraDB RDS instance. > * The password must be 8 to 32 characters in length. * The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. * Special characters include ! @ # $ & % ^ * ( ) _ + - =	******

Response elements

Element	Type	Description	Example
	object
Message	string	The error message of the task. > This parameter is returned only when the task status is stop.	success
RequestId	string	The request ID.	9B2F3840-5C98-475C-B269-2D5C3A31797C
Success	boolean	Indicates whether the request was successful.	true
Data	object	The task details.
SlinkTaskId	string	The slink task ID.	etx-szr2rr6i*****

Examples

Success response

JSON format

{
  "Message": "success",
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Success": true,
  "Data": {
    "SlinkTaskId": "etx-szr2rr6i*****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.