Data Transmission Service:DescribePreCheckStatus

Request parameters

Response parameters

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribePreCheckStatus
&DtsJobId=i03e3zty16i****
&JobCode=01
&StructType=before
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePreCheckStatusResponse>
    <State>Finished</State>
    <Success>true</Success>
    <PageRecordCount>20</PageRecordCount>
    <Total>0</Total>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>C096FA97-B6BA-4575-899D-61E12B59****</RequestId>
    <JobName>Precheck</JobName>
    <JobId> b4my3zg929a****</JobId>
    <ErrorItem>0</ErrorItem>
    <ErrorAnalysisItem>0</ErrorAnalysisItem>
    <TotalRecordCount>100</TotalRecordCount>
    <Code>01</Code>
    <PageNumber>1</PageNumber>
    <JobProgress>
        <Skip>false</Skip>
        <FinishTime>2022-03-16T08:01:34.000+00:00</FinishTime>
        <IgnoreFlag>N</IgnoreFlag>
        <DelaySeconds>0</DelaySeconds>
        <DdlSql>CREATE TABLE `dtstestdata`.`order` (\n`orderid`  int(11)     COMMENT ''   NOT NULL   , \n`username`  char(32)  CHARSET `utf8` COLLATE `utf8_general_ci`    COMMENT ''   NULL   , \n`ordertime`  datetime     COMMENT ''   NULL   , \n`commodity`  varchar(32)  CHARSET `utf8` COLLATE `utf8_general_ci`    COMMENT ''   NULL   , \n`phonenumber`  int(11)     COMMENT ''   NULL   , \n`address`  text  CHARSET `utf8mb4` COLLATE `utf8mb4_general_ci`    COMMENT ''   NULL   \n, PRIMARY KEY (`orderid`)) engine=InnoDB DEFAULT CHARSET=`gbk` DEFAULT COLLATE `gbk_chinese_ci` ROW_FORMAT= Dynamic comment = '' ;\n</DdlSql>
        <State>Success</State>
        <BootTime>2022-03-16T08:01:31.000+00:00</BootTime>
        <Item>CHECK_CONN_DEST</Item>
        <Sub>[]</Sub>
        <Total>1</Total>
        <TargetNames>order</TargetNames>
        <CanSkip>true</CanSkip>
        <Names>CHECK_CONN_DEST_DETAIL</Names>
        <ErrDetail>CHECK__ERROR_SAME_OBJ_DETAIL</ErrDetail>
        <DiffRow>1</DiffRow>
        <JobId>fj1c33ro168****</JobId>
        <SourceSchema>dtstestdata</SourceSchema>
        <DestSchema>dtstestdata_new</DestSchema>
        <ParentObj>demo</ParentObj>
        <ErrMsg>CHECK__ERROR_SAME_OBJ</ErrMsg>
        <OrderNum>10</OrderNum>
        <RepairMethod>CHECK__ERROR_SAME_OBJ_REPAIR</RepairMethod>
        <Id>5632</Id>
        <Current>0</Current>
    </JobProgress>
    <AnalysisJobProgress>
        <Skip>false</Skip>
        <FinishTime>2022-03-16T08:01:31.000+00:00</FinishTime>
        <IgnoreFlag>N</IgnoreFlag>
        <DelaySeconds>0</DelaySeconds>
        <DdlSql>CREATE TABLE ****</DdlSql>
        <State>Success</State>
        <BootTime>2022-03-16T08:01:31.000+00:00</BootTime>
        <Item>ANALYSIS_MYSQL_4_ITEM</Item>
        <Sub>[]</Sub>
        <Total>1</Total>
        <TargetNames>testTable</TargetNames>
        <CanSkip>true</CanSkip>
        <Names>ANALYSIS_MYSQL_4_DETAIL</Names>
        <ErrDetail>ANALYSIS_MYSQL</ErrDetail>
        <DiffRow>1</DiffRow>
        <JobId>11234234xc</JobId>
        <SourceSchema>dtstestdata</SourceSchema>
        <DestSchema>dest</DestSchema>
        <ParentObj>demo</ParentObj>
        <ErrMsg>ANALYSIS_</ErrMsg>
        <OrderNum>10</OrderNum>
        <RepairMethod>ANALYSIS_</RepairMethod>
        <Id>123123</Id>
        <Current>0</Current>
    </AnalysisJobProgress>
    <SubDistributedJobStatus>
        <JobName>dts.step.struct.load</JobName>
        <State>Finished</State>
        <JobId>n0gm1682j6563np</JobId>
        <ErrorItem>0</ErrorItem>
        <Code>02</Code>
        <Total>11</Total>
        <JobProgress>
            <Skip>true</Skip>
            <FinishTime>2022-03-31T03:36:11.000+00:00</FinishTime>
            <IgnoreFlag>N</IgnoreFlag>
            <DelaySeconds>0</DelaySeconds>
            <DdlSql>None</DdlSql>
            <State>Finished</State>
            <BootTime>2022-03-30T03:36:11.000+00:00</BootTime>
            <Item>login_common_time</Item>
            <Sub>[]</Sub>
            <Total>11</Total>
            <TargetNames>order</TargetNames>
            <CanSkip>false</CanSkip>
            <Names>metricRuleTargets-20180308houe</Names>
            <ErrDetail>CHECK__ERROR_SAME_OBJ_DETAIL</ErrDetail>
            <JobId>l3m1213ye7l****</JobId>
            <SourceSchema>databasetest</SourceSchema>
            <DestSchema>databasetest</DestSchema>
            <ParentObj>None</ParentObj>
            <ErrMsg>ODPS project does not exist odps.`huijin</ErrMsg>
            <OrderNum>1</OrderNum>
            <RepairMethod>CHECK__ERROR_SAME_OBJ_REPAIR	
</RepairMethod>
            <Id>3890****</Id>
            <Current>0</Current>
        </JobProgress>
    </SubDistributedJobStatus>
    <FullNetCheckJobStatus>
        <JobName>dts.step.fullnetcheck</JobName>
        <State>Success</State>
        <JobId>l3m1213ye7l****</JobId>
        <ErrorItem>0</ErrorItem>
        <Code>01</Code>
        <Total>11</Total>
        <HostRegion>cn-hangzhou</HostRegion>
        <SrcRegion>cn-hangzhou</SrcRegion>
        <DestRegion>cn-hangzhou</DestRegion>
        <SrcRegionCidr>100.104.XX.XXX/XX</SrcRegionCidr>
        <DestRegionCidr>100.104.XX.XXX/XX</DestRegionCidr>
        <SourceEndpointType>CEN</SourceEndpointType>
        <DestinationEndpointType>CEN</DestinationEndpointType>
        <JobProgress>
            <Skip>false</Skip>
            <FinishTime>2022-03-31T03:36:11.000+00:00</FinishTime>
            <IgnoreFlag>N</IgnoreFlag>
            <DelaySeconds>0</DelaySeconds>
            <DdlSql>CREATE TABLE ****</DdlSql>
            <State>Success</State>
            <BootTime>2022-03-30T03:36:11.000+00:00</BootTime>
            <Item>CHECK_CONN_SRC</Item>
            <Sub>[]</Sub>
            <Total>11</Total>
            <TargetNames>order</TargetNames>
            <CanSkip>false</CanSkip>
            <Names>CHECK_CONN_SRC_DETAIL</Names>
            <DiffRow>1</DiffRow>
            <JobId>l3m1213ye7l****</JobId>
            <SourceSchema>dtstestdata</SourceSchema>
            <DestSchema>dest</DestSchema>
            <ParentObj>demo</ParentObj>
            <OrderNum>1</OrderNum>
            <RepairMethod>CHECK__ERROR_SAME_OBJ_REPAIR</RepairMethod>
            <Id>922305811766881****</Id>
            <Current>0</Current>
        </JobProgress>
    </FullNetCheckJobStatus>
    <NetworkDiagnosisResult>
        <ModelVersion>network-v0.2</ModelVersion>
        <Diagnosis>
            <EndpointType>source</EndpointType>
            <Code>dts.kunlun.diagnosis.network.express_doc</Code>
            <CnDocUrl>https://***.ali***.com/document_detail/470447.html</CnDocUrl>
            <InternationalDocUrl>https://www.ali***.com/help/en/data-transmission-service/latest/how-to-solve-an-error-when-accessing-a-database-instance-to-dts-using-vpn</InternationalDocUrl>
        </Diagnosis>
    </NetworkDiagnosisResult>
</DescribePreCheckStatusResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "State" : "Finished",
  "Success" : true,
  "PageRecordCount" : 20,
  "Total" : 0,
  "HttpStatusCode" : 200,
  "RequestId" : "C096FA97-B6BA-4575-899D-61E12B59****",
  "JobName": "Precheck",
  "JobId" : " b4my3zg929a****",
  "ErrorItem" : 0,
  "ErrorAnalysisItem" : 0,
  "TotalRecordCount" : 100,
  "Code" : "01",
  "PageNumber" : 1,
  "JobProgress" : [ {
    "Skip" : false,
    "FinishTime" : "2022-03-16T08:01:34.000+00:00",
    "IgnoreFlag" : "N",
    "DelaySeconds" : 0,
    "DdlSql" : "CREATE TABLE `dtstestdata`.`order` (\\n`orderid`  int(11)     COMMENT ''   NOT NULL   , \\n`username`  char(32)  CHARSET `utf8` COLLATE `utf8_general_ci`    COMMENT ''   NULL   , \\n`ordertime`  datetime     COMMENT ''   NULL   , \\n`commodity`  varchar(32)  CHARSET `utf8` COLLATE `utf8_general_ci`    COMMENT ''   NULL   , \\n`phonenumber`  int(11)     COMMENT ''   NULL   , \\n`address`  text  CHARSET `utf8mb4` COLLATE `utf8mb4_general_ci`    COMMENT ''   NULL   \\n, PRIMARY KEY (`orderid`)) engine=InnoDB DEFAULT CHARSET=`gbk` DEFAULT COLLATE `gbk_chinese_ci` ROW_FORMAT= Dynamic comment = '' ;\\n",
    "State" : "Success",
    "BootTime" : "2022-03-16T08:01:31.000+00:00",
    "Item" : "CHECK_CONN_DEST",
    "Sub" : "[]",
    "Total" : 1,
    "TargetNames" : "order",
    "CanSkip" : true,
    "Names" : "CHECK_CONN_DEST_DETAIL",
    "ErrDetail" : "CHECK__ERROR_SAME_OBJ_DETAIL",
    "DiffRow" : 1,
    "JobId" : "fj1c33ro168****",
    "SourceSchema" : "dtstestdata",
    "DestSchema" : "dtstestdata_new",
    "ParentObj" : "demo",
    "ErrMsg" : "CHECK__ERROR_SAME_OBJ",
    "OrderNum" : 10,
    "RepairMethod" : "CHECK__ERROR_SAME_OBJ_REPAIR",
    "Id" : "5632",
    "Current" : "0"
  } ],
  "AnalysisJobProgress" : [ {
    "Skip" : false,
    "FinishTime" : "2022-03-16T08:01:31.000+00:00",
    "IgnoreFlag" : "N",
    "DelaySeconds" : 0,
    "DdlSql" : "CREATE TABLE ****",
    "State" : "Success",
    "BootTime" : "2022-03-16T08:01:31.000+00:00",
    "Item" : "ANALYSIS_MYSQL_4_ITEM",
    "Sub" : "[]",
    "Total" : 1,
    "TargetNames" : "testTable",
    "CanSkip" : true,
    "Names" : "ANALYSIS_MYSQL_4_DETAIL",
    "ErrDetail" : "ANALYSIS_MYSQL",
    "DiffRow" : 1,
    "JobId" : "11234234xc",
    "SourceSchema" : "dtstestdata",
    "DestSchema" : "dest",
    "ParentObj" : "demo",
    "ErrMsg" : "ANALYSIS_",
    "OrderNum" : 10,
    "RepairMethod" : "ANALYSIS_",
    "Id" : "123123",
    "Current" : "0"
  } ],
  "SubDistributedJobStatus" : [ {
    "JobName" : "dts.step.struct.load",
    "State" : "Finished",
    "JobId" : "n0gm1682j6563np",
    "ErrorItem" : 0,
    "Code" : "02",
    "Total" : 11,
    "JobProgress" : [ {
      "Skip" : true,
      "FinishTime" : "2022-03-31T03:36:11.000+00:00",
      "IgnoreFlag" : "N",
      "DelaySeconds" : 0,
      "DdlSql" : "None",
      "State" : "Finished",
      "BootTime" : "2022-03-30T03:36:11.000+00:00",
      "Item" : "login_common_time",
      "Sub" : "[]",
      "Total" : 11,
      "TargetNames" : "order",
      "CanSkip" : false,
      "Names" : "metricRuleTargets-20180308houe",
      "ErrDetail" : "CHECK__ERROR_SAME_OBJ_DETAIL",
      "JobId" : "l3m1213ye7l****",
      "SourceSchema" : "databasetest",
      "DestSchema" : "databasetest",
      "ParentObj" : "None",
      "ErrMsg" : "ODPS project does not exist odps.`huijin",
      "OrderNum" : 1,
      "RepairMethod" : "CHECK__ERROR_SAME_OBJ_REPAIR\t\n",
      "Id" : "3890****",
      "Current" : "0"
    } ]
  } ],
  "FullNetCheckJobStatus" : [ {
    "JobName" : "dts.step.fullnetcheck",
    "State" : "Success",
    "JobId" : "l3m1213ye7l****",
    "ErrorItem" : 0,
    "Code" : "01",
    "Total" : 11,
    "HostRegion" : "cn-hangzhou",
    "SrcRegion" : "cn-hangzhou",
    "DestRegion" : "cn-hangzhou",
    "SrcRegionCidr" : "100.104.XX.XXX/XX",
    "DestRegionCidr" : "100.104.XX.XXX/XX",
    "SourceEndpointType" : "CEN",
    "DestinationEndpointType" : "CEN",
    "JobProgress" : [ {
      "Skip" : false,
      "FinishTime" : "2022-03-31T03:36:11.000+00:00",
      "IgnoreFlag" : "N",
      "DelaySeconds" : 0,
      "DdlSql" : "CREATE TABLE ****",
      "State" : "Success",
      "BootTime" : "2022-03-30T03:36:11.000+00:00",
      "Item" : "CHECK_CONN_SRC",
      "Sub" : "[]",
      "Total" : 11,
      "TargetNames" : "order",
      "CanSkip" : false,
      "Names" : "CHECK_CONN_SRC_DETAIL",
      "DiffRow" : 1,
      "JobId" : "l3m1213ye7l****",
      "SourceSchema" : "dtstestdata",
      "DestSchema" : "dest",
      "ParentObj" : "demo",
      "OrderNum" : 1,
      "RepairMethod" : "CHECK__ERROR_SAME_OBJ_REPAIR",
      "Id" : "922305811766881****",
      "Current" : "0"
    } ]
  } ],
  "NetworkDiagnosisResult" : {
    "ModelVersion" : "network-v0.2",
    "Diagnosis" : [ {
      "EndpointType" : "source",
      "Code" : "dts.kunlun.diagnosis.network.express_doc",
      "CnDocUrl" : "https://***.ali***.com/document_detail/470447.html",
      "InternationalDocUrl" : "https://www.ali***.com/help/en/data-transmission-service/latest/how-to-solve-an-error-when-accessing-a-database-instance-to-dts-using-vpn"
    } ]
  }
}

Error codes

For a list of error codes, see Service error codes.