DescribeProjectStepMetric|V4.3.1|OceanBase Migration Service| docs|Distributed Database

DescribeProjectStepMetric

Last Updated：2025-10-21 10:56:45 Updated

This topic describes the DescribeProjectStepMetric API provided by OceanBase Migration Service (OMS).

Purpose

You can call this operation to query metrics of steps in a data migration, synchronization, or verification task.

Call description

Limitations

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

Request path

POST /api/v2?Action=DescribeProjectStepMetric

Request parameters

Parameter	Type	Description
projectId	string	The task ID.
stepName	string	The name of the step. Valid values: `FULL_TRANSFER`, `INCR_TRANSFER`, `FULL_VERIFIER`, `REVERSE_INCR_TRANSFER`, and `INCR_VERIFIER`.
metricType	string	The metric that you want to query. The metric corresponds to the step of task execution. Metrics of the `FULL_TRANSFER` step are RPS, IOPS, SOURCE_READ_TIME, SOURCE_SLICE_TIME, and SINK_EXECUTE_TIME. Metrics of the `INCR_TRANSFER` step are DELAY, IOPS, RPS, SINK_COMMIT_TIME, and SINK_EXECUTE_TIME. Metrics of the `FULL_VERIFIER` step are FULL_VERIFY_SOURCE_RPS, FULL_VERIFY_SOURCE_READ_IOPS, FULL_VERIFY_DEST_RPS, and FULL_VERIFY_DEST_READ_IOPS. Metrics of the `REVERSE_INCR_TRANSFER` step are RPS, IOPS, DELAY, SINK_EXECUTE_TIME, and SINK_COMMIT_TIME. Metrics of the `INCR_VERIFIER` step are INCR_VERIFY_SRC_REVIEW_RPS, INCR_VERIFY_DST_REVIEW_RPS, INCR_VERIFY_DST_REVIEW_IOPS, INCR_VERIFY_SRC_REVIEW_IOPS, INCR_VERIFY_DEST_STORE_IOPS, INCR_VERIFY_DEST_STORE_TPS, INCR_VERIFY_SRC_STORE_IOPS, and INCR_VERIFY_SRC_STORE_TPS.
aggregator	string	The aggregate operator. Valid values: `AVG` (line chart of average data) and `NONE` (line chart of instantaneous data). Default value: `NONE`.
beginTimestamp	integer	The start time. The value is a second-level timestamp. The interval between the start time and the end time must not be shorter than one hour.
endTimestamp	integer	The end time. The value is a second-level timestamp. The end time cannot be later than the current time.
maxPointNum	integer	The maximum number of query points.

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 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 task. For more information, see the "Parameters in data" section of this topic.

Parameters in data

Parameter	Type	Description
referenceValue	integer	The reference value.
metrics	array	The line chart of metric data.
├─ name	string	The name of the metric.
├─ tags	map	The tag of the metric.
├─ dataPoints	array	The list of metric data.
aggregator	string	The aggregate operator. Valid values: `AVG` (line chart of average data) and `NONE` (line chart of instantaneous data).

Examples

Request example

{
    "projectId":"np_4w3r****",
    "stepName":"FULL_VERIFIER",
    "metricType":"FULL_VERIFY_DEST_READ_IOPS",
    "aggregator":"NONE",
    "beginTimestamp ":"1689244429",
    "endTimestamp":"1689248029",
    "maxPointNum":"84"
}

Response example

{
    "success":true,
    "errorDetail":null,
    "code":null,
    "message":null,
    "advice":null,
    "requestId":"a7b57****",
    "pageNumber":null,
    "pageSize":null,
    "totalCount":null,
    "cost":"27 ms",
    "data":{
        "referenceValue":null,
        "metrics":[
            {
                "name":null,
                "tags":null,
                "dataPoints":[
                    {
                        "timestamp":1689244596,
                        "value":0
                    },
                    {
                        "timestamp":1689244646,
                        "value":0
                    },
                    {
                        "timestamp":1689244696,
                        "value":0
                    }
                ]
            }
        ],
        "aggregator":"NONE"
    }
}

Enterprise Edition

Community Edition