Querying the Status of a Dataset Synchronization Task
Function
This API is used to query the status of a dataset synchronization task.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
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. |
Request Parameters
None
Response Parameters
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. |
Example Requests
Obtaining the Dataset Synchronization Status
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/sync-data/status
Example Responses
Status code: 200
OK
{
"status" : "COMPLETED",
"dataset_id" : "gfghHSokody6AJigS5A"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
