Help Center/ EventGrid/ API Reference/ APIs/ Professional Event Stream Job Management/ Querying the Synchronization Status of a Professional Event Job

Updated on 2025-05-06 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Synchronization Status of a Professional Event Job

Function

This API is used to query the synchronization status of a professional event job.

URI

POST /v1/{project_id}/eventrouter/jobs/{job_id}/syncDetail

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.
job_id	Yes	String	Job ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	Offset. The value ranges from 0 to 10000.
limit	Yes	Integer	The number of records displayed on a page. The value ranges from 10 to 1000.
conditions	No	Array of Condition objects	Condition.

**Table 4** Condition
Parameter	Mandatory	Type	Description
key	Yes	String	Query condition key. Its value can only be topic.
operate	Yes	String	Query operation. Only EQUAL LIKE is supported.
value	Yes	Object	Value of the query condition, which can be a topic name.

Response Parameters

Status code: 200

**Table 5** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 6** Response body parameters
Parameter	Type	Description
metadata	MQSyncDetailMetadata object	Metadata.
total	Integer	Total number.
size	Integer	Quantity.
type	String	Type.
items_kafka	Array of KafkaSyncDetaiData objects	Return value of the Kafka type. The value is items instead of _kafka.
items_rocketmq	Array of RocketMQSyncDetaiData objects	Return value of the RocketMQ type. The value is items instead of _rocketmq.
items_redis	Array of RedisSyncDetaiData objects	Return value of the Redis type. The value is items instead of _redis.

**Table 7** MQSyncDetailMetadata
Parameter	Type	Description
sync_remain_total	Integer	The total number of remaining events to be synchronized.
source_key_num	Integer	Number of DCS source keys.
sink_key_num	Integer	Number of DCS target keys.

**Table 8** KafkaSyncDetaiData
Parameter	Type	Description
topic	String	Topic.
number	Integer	Quantity.
sync_remain_num	Integer	The number of remaining events to be synchronized.
offset_details	Array of OffsetDetail objects	Offset details.

**Table 9** OffsetDetail
Parameter	Type	Description
partition	KafkaPartition object	Partition.
offset	KafkaOffset object	Offset.

**Table 10** KafkaPartition
Parameter	Type	Description
cluter	String	Cluster.
topic	String	Topic.
partition	Integer	Partition.

**Table 11** KafkaOffset
Parameter	Type	Description
offset	Integer	Offset.
max_offset	Integer	Maximum offset.

**Table 12** RocketMQSyncDetaiData
Parameter	Type	Description
topic	String	Topic.
number	Integer	Quantity.
sync_remain_num	Integer	The number of remaining events to be synchronized.
offset_details	Array of RocketMQOffsetDetail objects	Offset details.

**Table 13** RocketMQOffsetDetail
Parameter	Type	Description
queue	RocketMQQueueInfo object	Queue.
offset	RocketMQOffsetInfo object	Offset.

**Table 14** RocketMQQueueInfo
Parameter	Type	Description
rocketmq_topic	String	RocketMQ topic.
rocketmq_broker	String	RocketMQ broker.
rocketmq_queue	Integer	RocketMQ queue.

**Table 15** RocketMQOffsetInfo
Parameter	Type	Description
rocketmq_offset	Integer	RocketMQ offset.
max_offset	Integer	Maximum offset of RocketMQ.

**Table 16** RedisSyncDetaiData
Parameter	Type	Description
sourceAddr	String	Source IP address + port, which describes the source address information.
sinkAddr	String	Target IP address + port: which describes the target address information.
taskProgress	String	Job progress. The value is within the range [0,1]. 1 indicates that the progress is 100%.
syncPhase	String	Synchronization phase. Options: full, full+incremental. Currently, only the full+incremental mode is supported.
sourceOffset	Integer	Source offset, which indicates the number of synchronized events in source.
sinkOffset	Integer	Target offset, which indicates the number of synchronized events in target.
taskStatus	String	Job status. Options: created, syncing, failed, stopped, finish.

Example Requests

Check the synchronization status of the professional event stream job whose ID is 123.

POST https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/123/syncDetail

{
  "offset" : 0,
  "limit" : 1000
}

Example Responses

Status code: 200

Request succeeded.

{
  "metadata" : {
    "sync_remain_total" : 0,
    "source_key_num" : 4,
    "sink_key_num" : 1
  },
  "total" : 1,
  "size" : 1,
  "type" : "DCS"
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Professional Event Stream Job Management

Previous topic: Verifying Professional Event Stream Jobs

Next topic: Professional Event Stream Cluster Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot