Help Center> Data Replication Service> API Reference> API> Real-Time Synchronization Management> Querying the Full Task Progress and Incremental Task Delay

Querying the Full Task Progress and Incremental Task Delay

Function

URI

  • URI format

    PATH:/v3/{project_id}/jobs/batch-progress

    Method: POST

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region. For details, see Obtaining a Project ID.

  • Header description
    Table 2 Header description

    Name

    Mandatory

    Description

    X-Auth-Token

    Yes

    Specifies the user token obtained from IAM. For details, see Authentication.

    X-Language

    Yes

    Specifies the request language type. The value is case-insensitive, such as en-us.

    Content-Type

    Yes

    Specifies the content type. The value is application/json.

  • Request example
    /v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-progress

Request

  • Parameter description
    Table 3 Parameter description

    Name

    Mandatory

    Type

    Description

    req

    Yes

    List<String>

    Specifies the list of requests for full task progress and incremental task delay.

    Constraints:

    • The value cannot contain empty objects.
    • The value must comply with the UUID rule.
    • Request example
      {
      "jobs": [
      "9a470239-2308-4bb5-a6bc-1040402fjb21",
      "dc67695a-ee3e-49b8-a022-a099bd81jb21"
      ]
      }

Normal Response

  • Parameter description
    Table 4 Parameter description

    Name

    Type

    Description

    results

    List<QueryProgressRespV3>

    Indicates the response body set for querying the full task progress and incremental task delay in batches.

    For details, see Table 5.

    count

    Integer

    Indicates the total number of records.

    Table 5 QueryProgressRespV3 field description

    Name

    Type

    Description

    job_id

    String

    Indicates the task ID.

    progress

    String

    Indicates the migration comparison progress in percentage.

    incre_trans_delay

    String

    Indicates the incremental migration delay.

    task_mode

    String

    Indicates the migration type.

    transfer_status

    String

    Indicates the migration status.

    process_time

    String

    Indicates the migration time.

    remaining_time

    String

    Indicates the estimated remaining time.

    progress_map

    Map<String, ProgressInfoV3>

    Indicates the migration progress and delay (v3).

    error_code

    String

    Indicates the error code.

    error_msg

    String

    Indicates the error message.

    Table 6 ProgressInfoV3 field description

    Name

    Type

    Description

    completed

    String

    Indicates the progress.

    remaining_time

    String

    Indicates the estimated remaining time.

  • Response example
    {
      "results": [
        {
          "job_id": "a3d5f4a8-dc97-4581-8071-e4977309jb21",
          "progress": "0",
          "incre_trans_delay": "1",
          "task_mode": "FULL_INCR_TRANS",
          "transfer_status": "INCRE_TRANSFER_STARTED",
          "process_time": "0",
          "remaining_time": "0"
        }
      ]
    }

Abnormal Response

For details, see Abnormal Request Results.