This API is used to query the status of a dataset synchronization task.
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
GET /v2/{project_id}/datasets/{dataset_id}/sync-data/status
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dataset_id |
Yes |
String |
Dataset ID. |
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. |
None
Status code: 200
Parameter |
Type |
Description |
---|---|---|
add_sample_count |
Long |
Number of added samples. |
create_time |
Long |
Task creation time. |
dataset_id |
String |
Dataset ID. |
deleted_sample_count |
Long |
Number of deleted samples. |
duration_time |
Long |
Task running time. |
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
status |
String |
Status of a task. Options:
|
task_id |
String |
Synchronization task ID. |
total_sample_count |
Long |
Total number of samples. |
Obtaining the Status of a Dataset Synchronization
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/sync-data/status
Status code: 200
OK
{ "status" : "COMPLETED", "dataset_id" : "gfghHSokody6AJigS5A" }
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
See Error Codes.