DescribeProjectSteps|V4.2.4|OceanBase Migration Service|OMS docs|Distributed Database

DescribeProjectSteps

Last Updated：2025-05-12 01:56:25 Updated

This topic describes the DescribeProjectSteps operation provided by OceanBase Migration Service (OMS).

Purpose

This operation is used to query the details of the steps of a data migration or synchronization task.

Call description

Limitations

This operation is available in OMS V4.1.0 and later.

Request path

POST /api/v2?Action=DescribeProjectSteps

Request parameters

Parameter	Type	Description
id	String	The ID of the data migration or synchronization task.

Response parameters

Parameter	Type	Description
success	Boolean	Indicates whether the call is successful.
errorDetail	Object	The error details.
code	String	The error code.
message	String	The description.
advice	String	The suggestions.
requestId	String	The request ID.
pageNumber	Integer	The page number, which takes effect in a pagination query.
pageSize	Integer	The page size, which takes effect in a pagination query.
totalCount	Integer	The total number of pages returned, which takes effect in a pagination query.
cost	String	The time spent in processing the request, in seconds.
data	String	The information about the steps of the task. For more information, see Parameters in data.

Parameters in data

Parameter	Type	Description
order	Integer	The sequence number of the step.
name	String	The name of the step.
description	String	The description of the step.
status	String	The status of the step.
extraInfo	Object	The additional information. For more information, see Parameters in extraInfo.
startTime	String	The start time of the step, in the UTC+0 time zone.
finishTime	String	The end time of the step, in the UTC+0 time zone.
progress	Integer	The progress of the step.
stepInfo	Object	The details of the step. For more information, see Parameters in stepInfo.

Parameters in extraInfo

Parameter	Type	Description
errorDetails	Array	The error details.
errorCode	String	The error code.
errorMsg	String	The error message.
errorParam	map	The error-related parameters.
failedTime	String	The time when the error occurred.

Parameters in stepInfo

Different parameters are nested under stepInfo for different steps.

TRANSFER_APP_SWITCH (forward switchover)

Parameter	Type	Description
checkpointSampleTimestamp	Long	The checkpoint collection timestamp. The value is a Unix timestamp in seconds.

INCR_TRANSFER (incremental synchronization)

Parameter	Type	Description
incrTimestampCheckpoint	Long	The checkpoint timestamp. The value is a Unix timestamp in seconds.
checkpointSampleTimestamp	Long	The checkpoint collection timestamp. The value is a Unix timestamp in seconds.
enableIncrStatistics	Boolean	Indicates whether DDL/DML statistics collection is enabled.

FULL_VERIFIER (full verification) and FULL_TRANSFER (full migration)

Parameter	Type	Description
processedRecords	Long	The ratio of migrated rows to total rows.
capacity	Long	The estimated total number of rows.
srcRps	Long	The read requests per second (RPS) of the source data source.
srcRt	String	The read response time (RT) per record of the source data source, in milliseconds.
srcIops	Long	The read throughput of the source data source, in bytes per second.
dstRps	Long	The read/write RPS of the destination data source.
dstRt	Long	The read/write RT per record of the destination data source, in milliseconds.
dstIops	Long	The read/write throughput of the destination data source, in bytes per second.
srcRpsRef	Long	The read RPS baseline of the source data source.
dstRpsRef	Long	The read/write RPS baseline of the destination data source.
dstRtRef	Long	The read/write RT baseline of the destination data source.

Examples

Sample request

{
    "id":"np_4w3r***"
}

Sample response

{
    "success": true,
    "errorDetail": null,
    "code": null,
    "message": null,
    "advice": null,
    "requestId": "3b1ad52a-****-****-bcf7-937e819",
    "pageNumber": null,
    "pageSize": null,
    "totalCount": null,
    "cost": "4 ms",
    "data": [
        {
            "order": 1,
            "name": "TRANSFER_PRECHECK",
            "description": "Precheck",
            "status": "FINISHED",
            "extraInfo": {
                "errorDetails": null,
                "errorCode": null,
                "errorMsg": null,
                "errorParam": null,
                "failedTime": null
            },
            "startTime": "2023-07-17T23:01:25",
            "finishTime": "2023-07-17T23:01:35",
            "progress": 100,
            "stepInfo": null
        },
        {
            "order": 2,
            "name": "STRUCT_TRANSFER",
            "description": "Schema migration",
            "status": "FINISHED",
            "extraInfo": {
                "errorDetails": null,
                "errorCode": null,
                "errorMsg": null,
                "errorParam": null,
                "failedTime": null
            },
            "startTime": "2023-07-17T23:03:02",
            "finishTime": "2023-07-17T23:05:20",
            "progress": 100,
            "stepInfo": null
        },
        {
            "order": 3,
            "name": "TRANSFER_INCR_LOG_PULL",
            "description": "Synchronously pull incremental logs",
            "status": "FINISHED",
            "extraInfo": {
                "errorDetails": null,
                "errorCode": null,
                "errorMsg": null,
                "errorParam": null,
                "failedTime": null
            },
            "startTime": "2023-07-17T23:05:25",
            "finishTime": "2023-07-17T23:06:03",
            "progress": 100,
            "stepInfo": null
        },
        {
            "order": 4,
            "name": "FULL_TRANSFER",
            "description": "Full migration",
            "status": "FINISHED",
            "extraInfo": {
                "errorDetails": null,
                "errorCode": null,
                "errorMsg": null,
                "errorParam": null,
                "failedTime": null
            },
            "startTime": "2023-07-17T23:07:15",
            "finishTime": "2023-07-17T23:07:35",
            "progress": 100,
            "stepInfo": {
                "processedRecords": 92198,
                "capacity": 92198,
                "srcRps": 140,
                "srcRt": 7,
                "srcIops": 40945,
                "dstRps": 140,
                "dstRt": 7,
                "dstIops": 40945,
                "srcRpsRef": 8000,
                "srcRtRef": 1,
                "dstRpsRef": 8000,
                "dstRtRef": 1,
                "srcIopsRef": 8388608
            }
        },
        {
            "order": 5,
            "name": "INDEX_TRANSFER",
            "description": "Index migration",
            "status": "FINISHED",
            "extraInfo": {
                "errorDetails": null,
                "errorCode": null,
                "errorMsg": null,
                "errorParam": null,
                "failedTime": null
            },
            "startTime": "2023-07-17T23:07:30",
            "finishTime": "2023-07-17T23:07:40",
            "progress": 100,
            "stepInfo": null
        },
        {
            "order": 6,
            "name": "INCR_TRANSFER",
            "description": "Incremental synchronization",
            "status": "MONITORING",
            "extraInfo": {
                "errorDetails": null,
                "errorCode": null,
                "errorMsg": null,
                "errorParam": null,
                "failedTime": null
            },
            "startTime": "2023-07-17T23:08:57",
            "finishTime": "2023-07-17T23:14:34",
            "progress": 100,
            "stepInfo": {
                "incrTimestampCheckpoint": 1689832976,
                "checkpointSampleTimestamp": 1689832977,
                "enableIncrStatistics": true
            }
        },
        {
            "order": 7,
            "name": "FULL_VERIFIER",
            "description": "Full verification",
            "status": "INIT",
            "extraInfo": {
                "errorDetails": null,
                "errorCode": null,
                "errorMsg": null,
                "errorParam": null,
                "failedTime": null
            },
            "startTime": null,
            "finishTime": null,
            "progress": 0,
            "stepInfo": {
                "processedRecords": null,
                "capacity": null,
                "srcRps": null,
                "srcRt": null,
                "srcIops": null,
                "dstRps": null,
                "dstRt": null,
                "dstIops": null,
                "srcRpsRef": null,
                "srcRtRef": null,
                "dstRpsRef": null,
                "dstRtRef": null,
                "srcIopsRef": null
            }
        },
        {
            "order": 8,
            "name": "TRANSFER_APP_SWITCH",
            "description": "Forward switchover",
            "status": "INIT",
            "extraInfo": {
                "errorDetails": null,
                "errorCode": null,
                "errorMsg": null,
                "errorParam": null,
                "failedTime": null
            },
            "startTime": null,
            "finishTime": null,
            "progress": 0,
            "stepInfo": {
                "checkpointSampleTimestamp": null
            }
        },
        {
            "order": 9,
            "name": "REVERSE_INCR_TRANSFER",
            "description": "Reverse incremental migration",
            "status": "INIT",
            "extraInfo": {
                "errorDetails": null,
                "errorCode": null,
                "errorMsg": null,
                "errorParam": null,
                "failedTime": null
            },
            "startTime": null,
            "finishTime": null,
            "progress": 0,
            "stepInfo": null
        }
    ]
}

Enterprise Edition

Community Edition