Help Center/ ModelArts/ API Reference/ Historical APIs/ Data Management (Old Version)/ Querying the Status of a Dataset Synchronization Task
Updated on 2024-05-30 GMT+08:00

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 API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/datasets/{dataset_id}/sync-data/status

Table 1 Path Parameters

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

Table 2 Response body parameters

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:

  • QUEUING: queuing

  • STARTING: execution started

  • RUNNING: running

  • COMPLETED: completed

  • FAILED: failed

  • NOT_EXIST: not found

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.