更新时间:2026-07-29 GMT+08:00

查询监控数据 - ShowMonitorData

功能介绍

获取任务监控数据。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/jobs/{job_id}/monitor-data

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及

job_id

String

参数解释

任务ID,用于唯一标识一个数据复制任务,在查询、修改、删除等操作中作为任务的识别凭证。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

X-Auth-Token

String

参数解释

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制:

不涉及。

取值范围:

  • en-us:英语
  • zh-cn:中文

默认取值:

en-us

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

bandwidth

String

参数解释

EIP带宽,用于评估公网传输速率是否满足迁移需求。单位:MB/s。

约束限制

不涉及。

取值范围

不涉及。

is_src_normal

Boolean

参数解释

源库连接状态是否正常。

约束限制

不涉及。

取值范围

  • true:源库连接正常
  • false:源库连接异常

is_dst_normal

Boolean

参数解释

目标库连接状态是否正常。

约束限制

不涉及。

取值范围

  • true:目标库连接正常
  • false:目标库连接异常

src_offset

String

参数解释

源库offset位点,用于判断源库数据同步进度。

约束限制

不涉及。

取值范围

不涉及。

node_offset

String

参数解释

迁移实例offset位点,用于判断迁移实例数据同步进度。

约束限制

不涉及。

取值范围

不涉及。

dst_offset

String

参数解释

目标库offset位点,用于判断目标库数据同步进度。

约束限制

不涉及。

取值范围

不涉及。

src_delay

Integer

参数解释

源库时延,用于判断数据同步的实时性。

约束限制

不涉及。

取值范围

不涉及。

dst_delay

Integer

参数解释

目标库时延,用于判断数据同步的实时性。

约束限制

不涉及。

取值范围

不涉及。

src_rps

String

参数解释

源库RPS(Requests Per Second,每秒请求数),用于评估源库的数据变更速率。

约束限制

不涉及。

取值范围

不涉及。

src_io

String

参数解释

源库IO(Input/Output,每秒输入输出操作量),用于评估源库的磁盘读写负载。

约束限制

不涉及。

取值范围

不涉及。

dst_rps

String

参数解释

目标库RPS(Requests Per Second,每秒请求数),用于评估目标库的数据写入速率。

约束限制

不涉及。

取值范围

不涉及。

dst_io

String

参数解释

目标库IO(Input/Output,每秒输入输出操作量),用于评估目标库的磁盘读写负载。

约束限制

不涉及。

取值范围

不涉及。

trans_data

String

参数解释

已迁移的数据量,用于评估迁移进度。单位:MB。

约束限制

不涉及。

取值范围

不涉及。

trans_lines

String

参数解释

已迁移的数据行数,用于评估迁移进度。

约束限制

不涉及。

取值范围

不涉及。

used_volumes

String

参数解释

迁移实例磁盘使用量,用于监控迁移实例存储容量。单位:GB。

约束限制

不涉及。

取值范围

不涉及。

used_memory

String

参数解释

迁移实例内存使用量,用于监控迁移实例内存消耗。单位:MB。

约束限制

不涉及。

取值范围

不涉及。

used_cpu_percent

String

参数解释

迁移实例CPU使用百分比,用于监控迁移实例计算负载。

约束限制

不涉及。

取值范围

不涉及。

node_volume_size

Integer

参数解释

迁移实例磁盘总大小,与used_volumes配合评估磁盘使用率。单位:GB。

约束限制

不涉及。

取值范围

不涉及。

node_memory_size

Integer

参数解释

迁移实例内存总大小,与used_memory配合评估内存使用率。单位:MB。

约束限制

不涉及。

取值范围

不涉及。

update_time

String

参数解释

监控数据的更新时间,UTC格式,如2023-07-19T03:09:25Z。

约束限制

不涉及。

取值范围

不涉及。

apply_rate

Integer

参数解释

同步速度,用于评估数据回放速率。单位:byte/s。

约束限制

不涉及。

取值范围

不涉及。

请求示例

查询任务监控数据:

https://{endpoint}/v5/04f9aca88c00d3202fd4c01ed679daf0/jobs/ee5ed538-90c6-4f70-bd2e-ac084abjb502/monitor-data

响应示例

状态码:200

OK

{
  "bandwidth" : "37",
  "is_src_normal" : true,
  "is_dst_normal" : true,
  "src_offset" : "mysql-bin.000646:196",
  "node_offset" : "mysql-bin.000646:196",
  "dst_offset" : "mysql-bin.000646:196",
  "src_delay" : 0,
  "dst_delay" : 0,
  "src_rps" : "0",
  "src_io" : "0.0",
  "dst_rps" : "0",
  "dst_io" : "0.0",
  "trans_data" : "0",
  "trans_lines" : "29",
  "used_volumes" : "4",
  "used_memory" : "2124",
  "used_cpu_percent" : "1.4",
  "node_volume_size" : 500,
  "node_memory_size" : 8192,
  "update_time" : "2023-07-19T03:09:25Z",
  "apply_rate" : 0
}

状态码

状态码

描述

200

OK

其他状态请参见状态码

错误码

请参见错误码