---
title: "查询任务步骤的指标 | OceanBase 文档中心"
description: 查询任务步骤的指标 本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）社区版提供的 OpenAPI：查询任务步骤的指标 DescribeProjectStepMetric。 功能说明 本接口用于查询数据迁移或数据同步任务的运行步骤的指标。 调用说明 接口约束 …
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*L03BS6f-o40AAAAAAAAAAAAADiGDAQ/original) 迁移服务 OMSV 4.2.8 社区版

# 查询任务步骤的指标

更新时间：2026-04-14 15:40:47

[编辑](https://github.com/oceanbase/oms-doc/edit/V4.2.8/zh-CN/1200.reference-guide/100.api-reference/1100.describe-project-step-metric.md)  

本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）社区版提供的 OpenAPI：查询任务步骤的指标 DescribeProjectStepMetric。

## 功能说明

本接口用于查询数据迁移或数据同步任务的运行步骤的指标。

## 调用说明

### 接口约束

本接口适用于 OMS 社区版 V4.1.1-CE 及之后版本。

### 请求路径

`POST /api/v2?Action=DescribeProjectStepMetric`

### 请求参数

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| projectId | string | 任务的 ID。 |
| stepName | string | 任务运行步骤的名称，包括 `FULL_TRANSFER`、`INCR_TRANSFER`、`FULL_VERIFIER` 和 `REVERSE_INCR_TRANSFER`。 |
| metricType | string | 任务运行步骤对应的指标。   - `FULL_TRANSFER` 对应的指标包括 RPS、IOPS、SOURCE_READ_TIME、SOURCE_SLICE_TIME 和 SINK_EXECUTE_TIME。 - `INCR_TRANSFER` 对应的指标包括 DELAY、IOPS、RPS、SINK_COMMIT_TIME 和 SINK_EXECUTE_TIME。 - `FULL_VERIFIER` 对应的指标包括 FULL_VERIFY_SOURCE_RPS、FULL_VERIFY_SOURCE_READ_IOPS、FULL_VERIFY_DEST_RPS 和 FULL_VERIFY_DEST_READ_IOPS。 - `REVERSE_INCR_TRANSFER` 对应的指标包括 RPS、IOPS、DELAY、SINK_EXECUTE_TIME 和 SINK_COMMIT_TIME。 |
| aggregator | string | 聚合算子，包括 `AVG`（平均数据折线图）和 `NONE`（瞬时数据折线图）。默认值为 `NONE`。 |
| beginTimestamp | integer | 开始时间，单位为秒级时间戳。开始时间和结束时间的间隔不低于 1 小时。 |
| endTimestamp | integer | 结束时间，单位为秒级时间戳。结束时间不能晚于当前时间。 |
| maxPointNum | integer | 最大查询点数。 |

### 返回结果

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| success | boolean | 是否调用成功。 |
| errorDetail | object | 错误详情。 |
| code | string | 错误码。 |
| message | string | 描述信息。 |
| advice | string | 建议。 |
| requestId | string | 请求 ID。 |
| pageNumber | integer | 页序号，分页查询时生效。 |
| pageSize | integer | 页大小，分页查询时生效。 |
| totalCount | integer | 总数，分页查询时生效。 |
| cost | string | 请求耗时，单位为秒。 |
| data | string | 任务步骤的相关信息，具体包含的信息请参见《data 数据结构》。 |

- **data 数据结构**

  | 参数 | 类型 | 描述 |
  | --- | --- | --- |
  | referenceValue | integer | 基准值。 |
  | metrics | array | 指标数据的折线图。 |
  | ├─ name | string | 指标的名称。 |
  | ├─ tags | map | 指标的标签。 |
  | ├─ dataPoints | array | 指标数据列表。 |
  | aggregator | string | 聚合算子，包括 `AVG`（平均数据折线图）和 `NONE`（瞬时数据折线图）。 |

## 示例

### 请求示例

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

```

### 返回示例

```JSON
{
    "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"
    }
}

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线