Query Replication Task Precheck Status

Queries the precheck status and check item results of a specified replication task.

Request URL: /openapi/v1/replication/precheck/status

Request Method: GET

Request Parameters

Parameter	Type	Required	Description	Example
replicationId	String	Yes	Replication task ID.	rp-div0qqpbffio

Response Parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request was successful.	true
requestId	String	Request ID.	Tv8j8OCQ-JPQIeDXnIMNi2TEdLNx0HDG
data	Object	Precheck status details. See data Fields.	See the example below
message	String	Message returned when the request fails.	replication rp-xxx not found

data Fields

Parameter	Type	Description	Example
replicationId	String	Replication task ID.	rp-div0qqpbffio
precheckStatus	String	Overall precheck status. Values: success, warning, failure.	failure
items	Array	Check item list. See items Fields.	See the example below

items Fields

Parameter	Type	Description	Example
itemId	String	Check item ID.	srcDataSourceCheck
itemName	String	Check item name.	Source datasource connection check
itemDescription	String	Check item description.	Check the status of the gateway of the source datasource, database connectable, and verify the username and password
status	String	Check item status. Values: success, warning, failure.	failure
message	String	Check item message. Usually empty when the item passes.	Failed to connect datasource...

Successful Invocation Example

{
  "success": true,
  "requestId": "Tv8j8OCQ-JPQIeDXnIMNi2TEdLNx0HDG",
  "data": {
    "replicationId": "rp-div0qqpbffio",
    "precheckStatus": "failure",
    "items": [
      {
        "itemId": "replBidirectionLoopExistCheck",
        "itemName": "Cyclic replication check",
        "itemDescription": "Check for replication loops",
        "status": "success",
        "message": ""
      },
      {
        "itemId": "srcDataSourceCheck",
        "itemName": "Source datasource connection check",
        "itemDescription": "Check the status of the gateway of the source datasource, database connectable, and verify the username and password",
        "status": "failure",
        "message": "Failed to connect datasource hzyh-ce-gaussdb: root@123.60.66.55:8000:0 Caused by: Connection timed out"
      }
    ]
  }
}