- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- API参考
- SDK参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
查看专业版事件流作业同步情况
功能介绍
查看专业版事件流作业同步情况
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/eventrouter/jobs/{job_id}/syncDetail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户资源空间ID |
|
job_id |
是 |
String |
作业ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
是 |
Integer |
偏移量 最小0 最大10000 |
|
limit |
是 |
Integer |
每页展示数量 最小是10 最大是1000 |
|
conditions |
否 |
Array of Condition objects |
条件 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
请求ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
metadata |
MQSyncDetailMetadata object |
元数据 |
|
total |
Integer |
总数 |
|
size |
Integer |
数量 |
|
type |
String |
类型 |
|
items_kafka |
Array of KafkaSyncDetaiData objects |
kafka类型的返回值，取items，不要_kafka |
|
items_rocketmq |
Array of RocketMQSyncDetaiData objects |
rocketmq型的返回值，取items，不要_rocketmq |
|
items_redis |
Array of RedisSyncDetaiData objects |
redis型的返回值，取items，不要_redis |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
sync_remain_total |
Integer |
剩余同步总数量 |
|
source_key_num |
Integer |
dcs源端key数量 |
|
sink_key_num |
Integer |
dcs目标端key数量 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
topic |
String |
主题 |
|
number |
Integer |
数量 |
|
sync_remain_num |
Integer |
剩余同步数量 |
|
offset_details |
Array of OffsetDetail objects |
偏移量详情 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
topic |
String |
主题 |
|
number |
Integer |
数量 |
|
sync_remain_num |
Integer |
剩余同步数量 |
|
offset_details |
Array of RocketMQOffsetDetail objects |
偏移量详情 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
queue |
RocketMQQueueInfo object |
队列 |
|
offset |
RocketMQOffsetInfo object |
偏移量 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
rocketmq_topic |
String |
rocketmq的主题 |
|
rocketmq_broker |
String |
rocketmq的代理 |
|
rocketmq_queue |
Integer |
rocketmq的队列 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
rocketmq_offset |
Integer |
rocketmq的偏移量 |
|
max_offset |
Integer |
rocketmq的最大偏移量 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
sourceAddr |
String |
源地址 ip+port描述同步地址信息 |
|
sinkAddr |
String |
目标地址 ip+port描述同步地址信息 |
|
taskProgress |
String |
作业进度 值在[0,1]区间，1表示进度100% |
|
syncPhase |
String |
同步阶段 存在“全量”和“全量+增量”两种模式，当前只提供“全量+增量”模式 (full、incremental) |
|
sourceOffset |
Integer |
源Offset 源地址数据同步量 |
|
sinkOffset |
Integer |
目标Offset 目标地址数据同步量 |
|
taskStatus |
String |
作业状态 created已创建、syncing 同步中、failed 作业失败、stoped 作业停止 finish 作业完成 |
请求示例
查看jobid=123的事件流作业同步情况
POST https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/123/syncDetail
{
"offset" : 0,
"limit" : 1000
}响应示例
状态码：200
请求成功
{
"metadata" : {
"sync_remain_total" : 0,
"source_key_num" : 4,
"sink_key_num" : 1
},
"total" : 1,
"size" : 1,
"type" : "DCS"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
错误码
请参见错误码。
