Query Pre-check Results
Last Updated:2021-05-11
Interface Description
Pre-check before you start tasks, including connectivity, object existence, binlog format, etc.
Request URI
GET /v{version}/task/{dtsId}/precheck
Parameter name | Parameter type | Required | Description | Example value | Parameter position |
---|---|---|---|---|---|
version | String | Yes | API version number | "1" | Path |
dtsId | String | Yes | Task ID | "dtsmxxxyyy" | Path |
Request Body Parameters
No
Response Header Parameters
No other special header fields are available, except for common header fields.
Response Body Parameters
Instructions for Data Structure of Response Body Field
Parameter name | Parameter type | Required | Description | Example value |
---|---|---|---|---|
success | boolean | Yes | Whether it is successful or not | true |
result | PreCheckResultItem[] | Yes | The set of pre-check results |
Instructions for Data Structure of PreCheckResultItem Field
Parameter name | Parameter type | Required | Description | Example value |
---|---|---|---|---|
name | String | Yes | Name | srcOracleConnect |
subscription | String | Yes | Description | Check whether the data transmission server can connect to the source database. |
message | String | Yes | Prompt | |
status | String | Yes | Status | pass |
Request Example
GET /v1/task/{dtsId}/precheck
<Common request header>
Response Example
HTTP/1.1 200 OK
<Common response header>
{
"result" : [ {
"name" : "srcOracleConnect",
"subscription" : "Check whether the data transmission server can connect to the source database",
"message" : "message",
"status" : "pass"
}, {
"name" : "srcOracleConnect",
"subscription" : "Check whether the data transmission server can connect to the source database",
"message" : "message",
"status" : "pass"
} ],
"success" : true
}
Error Code
See universal error code.