DescribeProjectStepMetric_云数据库 OceanBase 版_API文档

2019-09-01

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

oceanbase:DescribeProjectStepMetric	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
ProjectIdstring	数据迁移或数据同步任务的 ID。示例值:np_dr****参考取值来源: ListProjects CreateProject StopProjectsByLabel StartProjectsByLabel DescribeProjectProgress
StepNamestring	任务运行步骤的名称，包括 `FULL_TRANSFER`、`INCR_TRANSFER`、`FULL_VERIFIER` 和 `REVERSE_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枚举值:AVGNONE
BeginTimestampinteger<int64>	开始时间，单位为秒级时间戳。开始时间和结束时间的间隔不低于 1 小时。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1689244696
EndTimestampinteger<int64>	结束时间，单位为秒级时间戳。结束时间不能晚于当前时间。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1689254646
MaxPointNuminteger<int32>	最大查询点数。取值范围： 5~72460，建议值：时间段（单位分钟）/maxPointNum > 5。示例值:6取值 >= 5

返回参数

字段名称	字段详情
Successboolean	是否调用成功。示例值:true
ErrorDetailobject	错误详情。
Codestring	错误码（旧）。示例值:INNER_ERROR
Messagestring	错误描述（旧）。示例值:A system error occurred.
Advicestring	建议（旧）。示例值:Contact the administrator.
RequestIdstring	请求 ID。示例值:EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumberinteger<int32>	页序号，分页查询时生效。示例值:1
PageSizeinteger<int32>	页大小，分页查询时生效。示例值:10
TotalCountinteger<int64>	总数，分页查询时生效。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:1
Coststring	请求耗时，单位为秒。示例值:1
Dataobject	任务步骤的相关信息。

返回示例

变更历史

暂无变更历史

相关示例