DescribeProjectStepMetric - 查询项目步骤的指标 - 云数据库 OceanBase

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProjectId	string	是	项目的 ID。	np_dr****
StepName	string	是	项目运行步骤的名称，包括 `FULL_TRANSFER`、`INCR_TRANSFER`、`FULL_VERIFIER` 和 `REVERSE_INCR_TRANSFER`。	FULL_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。	RPS
Aggregator	string	是	聚合算子，包括 `AVG`（平均数据折线图）和 `NONE`（瞬时数据折线图）。默认值为 `NONE`。	AVG
BeginTimestamp	long	是	开始时间，单位为秒级时间戳。开始时间和结束时间的间隔不低于 1 小时。	1689244696
EndTimestamp	long	是	结束时间，单位为秒级时间戳。结束时间不能晚于当前时间。	1689254646
MaxPointNum	integer	否	最大查询点数。取值范围： 5~72460，建议值：时间段（单位分钟）/maxPointNum > 5。	6

返回参数

名称	类型	描述	示例值
	object	返回结果。
Success	boolean	是否调用成功。	true
ErrorDetail	object	错误详情。
Code	string	错误码（新）。	CM-RESOAT1111
Level	string	包括 FATAL、ERROR、WARNING 和 CRITICAL。	ERROR
Message	string	错误描述（新）。	A system error occurred.
ExtraContext	object	用于填充 Message 中的占位符。
	any	用于填充 Message 中的占位符。	null
MessageMcmsKey	string	错误信息的 Key。	null
MessageMcmsContext	object	用于填充 MessageMcmsKey 中的占位符。
	string	用于填充 MessageMcmsKey 中的占位符。	null
Reason	string	错误原因。	null
ReasonMcmsKey	string	错误原因的 Key。	null
ReasonMcmsContext	object	错误原因的上下文。
	string	错误原因的上下文。	null
Proposal	string	建议（新）。	null
ProposalMcmsKey	string	建议内容的 Key。	null
ProposalMcmsContext	object	建议内容的上下文。
	string	建议内容的上下文。	null
UpstreamErrorDetail	any	上游错误详情，用于处理 HTTP 请求。	null
Code	string	错误码（旧）。	INNER_ERROR
Message	string	错误描述（旧）。	A system error occurred.
Advice	string	建议（旧）。	Contact the administrator.
RequestId	string	请求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumber	integer	页序号，分页查询时生效。	1
PageSize	integer	页大小，分页查询时生效。	10
TotalCount	long	总数，分页查询时生效。	1
Cost	string	请求耗时，单位为秒。	1
Data	object	项目步骤的相关信息。
ReferenceValue	long	基准值。	null
Metrics	array<object>	指标数据的折线图。
Metric	object
Name	string	指标的名称。	metric_name
Tags	object	指标的标签集合。
	string	指标的标签。	metric_tag
DataPoints	array<object>	指标数据列表。
DataPoint	object	指标数据列表。
Timestamp	long	毫秒级时间戳。	1689244696
Value	double	时间对应的值	0
Aggregator	string	聚合算子，包括 `AVG`（平均数据折线图）和 `NONE`（瞬时数据折线图）。	AVG

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111",
    "Level": "ERROR",
    "Message": "A system error occurred.\n",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "null",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.\n",
  "Advice": "Contact the administrator.",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "Cost": "1",
  "Data": {
    "ReferenceValue": 0,
    "Metrics": [
      {
        "Name": "metric_name",
        "Tags": {
          "key": "metric_tag"
        },
        "DataPoints": [
          {
            "Timestamp": 1689244696,
            "Value": 0
          }
        ]
      }
    ],
    "Aggregator": "AVG"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-07	API 内部配置变更，不影响调用	查看变更详情