本接口用于查询数据迁移或数据同步任务的运行步骤的指标。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| oceanbase:DescribeProjectStepMetric | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectId | string | 是 | 数据迁移或数据同步任务的 ID。 | np_dr**** |
| StepName | string | 是 | 任务运行步骤的名称，包括 | FULL_TRANSFER |
| MetricType | string | 是 | 任务运行步骤对应的指标。
| RPS |
| Aggregator | string | 是 | 聚合算子，包括 | AVG |
| BeginTimestamp | long | 是 | 开始时间，单位为秒级时间戳。开始时间和结束时间的间隔不低于 1 小时。 | 1689244696 |
| EndTimestamp | long | 是 | 结束时间，单位为秒级时间戳。结束时间不能晚于当前时间。 | 1689254646 |
| MaxPointNum | integer | 否 | 最大查询点数。取值范围： 5~72460，建议值：时间段（单位分钟）/maxPointNum > 5。 | 6 |
返回参数
示例
正常返回示例
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 内部配置变更，不影响调用 | 查看变更详情 |
