DescribeProjectSteps|V4.2.0|OceanBase Migration Service| docs|Distributed Database

DescribeProjectSteps

Last Updated：2023-11-30 06:45:08 Updated

This topic describes the DescribeProjectSteps API provided by OceanBase Migration Service (OMS) Community Edition.

Purpose

You can call this operation to query details about steps in a data migration or synchronization project.

Call description

Limitations

This operation is applicable to OMS Community Edition V4.1.1 and later versions.

Request path

POST /api/v2?Action=DescribeProjectSteps

Request parameters

Parameter	Type	Description
id	string	The ID of the data migration or synchronization project.

Return result

Parameter	Type	Description
success	boolean	Indicates whether the call is successful.
errorDetail	object	The error details.
code	string	The error code.
message	string	The error description.
advice	string	The suggestions about how to resolve the error.
requestId	string	The request ID.
pageNumber	integer	The number of the page to return.
pageSize	integer	The number of entries to return on each page.
totalCount	integer	The total number of entries returned.
cost	string	The time spent in processing the request, in seconds.
data	string	The information about steps in the project. For more information, see the "Parameters in data" section of this topic.

Parameters in data

Parameter	Type	Description
order	integer	The execution sequence of the step.
name	string	The name of the step.
description	string	The description of the step.
status	string	The execution status of the step.
extraInfo	object	The additional information. For more information, see the "Parameters in extraInfo" section of this topic.
startTime	string	The start time presented in the UTC+0 time zone.
finishTime	string	The end time presented in the UTC+0 time zone.
progress	integer	The execution progress of the step.
stepInfo	object	The execution details of each step. For more information, see the "Parameters in stepInfo" section of this topic.

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 parameter.
failedTime	string	The time when the error occurred.

Parameters in stepInfo

Parameters in stepInfo vary based on the step.

TRANSFER_APP_SWITCH (forward switchover)

Parameter	Type	Description
checkpointSampleTimestamp	long	The checkpoint sampling time. The value is a Unix timestamp in seconds.

INCR_TRANSFER (incremental synchronization)

Parameter	Type	Description
incrTimestampCheckpoint	long	The checkpoint time. The value is a Unix timestamp in seconds.
checkpointSampleTimestamp	long	The checkpoint sampling time. The value is a Unix timestamp in seconds.
enableIncrStatistics	boolean	Specifies whether to enable DML/DDL statistics collection.

FULL_VERIFIER (full verification) and FULL_TRANSFER (full migration)

Parameter	Type	Description
processedRecords	long	The number of migrated rows.
capacity	long	The estimated total number of rows.
srcRps	long	The read records per second (RPS) of the source data source.
srcRt	string	The read response time (RT) of the source data source. Unit: milliseconds/record.
srcIops	long	The read traffic of the source data source. Unit: bytes/second.
dstRps	long	The read/write RPS of the destination data source.
dstRt	long	The read/write RT of the destination data source. Unit: milliseconds/record.
dstIops	long	The read/write traffic of the destination data source. Unit: bytes/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": "Pull incremental logs synchronously",
            "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 synchronization",
            "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