文档

DescribeProjectStepMetric - 查询项目步骤的指标

更新时间:

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
ProjectIdstring

项目的 ID。

np_dr****
StepNamestring

项目运行步骤的名称,包括 FULL_TRANSFERINCR_TRANSFERFULL_VERIFIERREVERSE_INCR_TRANSFER

FULL_TRANSFER
MetricTypestring

项目运行步骤对应的指标。

  • 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
Aggregatorstring

聚合算子,包括 AVG(平均数据折线图)和 NONE(瞬时数据折线图)。默认值为 NONE

AVG
BeginTimestamplong

开始时间,单位为秒级时间戳。开始时间和结束时间的间隔不低于 1 小时。

1689244696
EndTimestamplong

结束时间,单位为秒级时间戳。结束时间不能晚于当前时间。

1689254646
MaxPointNuminteger

最大查询点数。取值范围: 5~72460,建议值:时间段(单位分钟)/maxPointNum > 5。

6

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

是否调用成功。

true
ErrorDetailobject

错误详情。

Codestring

错误码(新)。

CM-RESOAT1111
Levelstring

包括 FATAL、ERROR、WARNING 和 CRITICAL。

ERROR
Messagestring

错误描述(新)。

A system error occurred.
ExtraContextobject

用于填充 Message 中的占位符。

any

用于填充 Message 中的占位符。

null
MessageMcmsKeystring

错误信息的 Key。

null
MessageMcmsContextobject

用于填充 MessageMcmsKey 中的占位符。

string

用于填充 MessageMcmsKey 中的占位符。

null
Reasonstring

错误原因。

null
ReasonMcmsKeystring

错误原因的 Key。

null
ReasonMcmsContextobject

错误原因的上下文。

string

错误原因的上下文。

null
Proposalstring

建议(新)。

null
ProposalMcmsKeystring

建议内容的 Key。

null
ProposalMcmsContextobject

建议内容的上下文。

string

建议内容的上下文。

null
UpstreamErrorDetailany

上游错误详情,用于处理 HTTP 请求。

null
Codestring

错误码(旧)。

INNER_ERROR
Messagestring

错误描述(旧)。

A system error occurred.
Advicestring

建议(旧)。

Contact the administrator.
RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumberinteger

页序号,分页查询时生效。

1
PageSizeinteger

页大小,分页查询时生效。

10
TotalCountlong

总数,分页查询时生效。

1
Coststring

请求耗时,单位为秒。

1
Dataobject

项目步骤的相关信息。

ReferenceValuelong

基准值。

null
Metricsobject []

指标数据的折线图。

Namestring

指标的名称。

metric_name
Tagsobject

指标的标签集合。

string

指标的标签。

metric_tag
DataPointsobject []

指标数据列表。

Timestamplong

毫秒级时间戳。

1689244696
Valuedouble

时间对应的值

0
Aggregatorstring

聚合算子,包括 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-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)