Help Center> Data Replication Service> API Reference> API> Real-Time Synchronization Management> Querying Task Statuses in Batches
View PDF

Querying Task Statuses in Batches

Function

URI

  • URI format

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

    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-status

Request

  • Parameter description
    Table 3 Parameter description

    Name

    Mandatory

    Type

    Description

    jobs

    Yes

    List<String>

    Specifies the list of IDs for querying task statuses in batches.

    Constraints:

    • The value cannot contain empty objects.
    • The value must comply with the UUID rule.
    • The task ID must be unique.
  • 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<QueryJobStatusRespV3>

    Indicates the response body for querying task details in batches.

    For details, see Table 5.

    count

    Integer

    Indicates the total number of records.
    Table 5 QueryJobStatusRespV3 field description

    Name

    Type

    Description

    id

    String

    Indicates the task ID.

    status

    String

    Indicates the task status.

    Valid value:

    - CREATING: The task is being created.

    - CREATE_FAILED: Creation failed

    - CONFIGURATION: The task is being configured.

    - STARTJOBING: The task is starting.

    - CREATING: The task is being created.

    - WAITING_FOR_START: The task is waiting to be started.

    - START_JOB_FAILED: The task fails to be started.

    - FULL_TRANSFER_STARTED: Full migration is in progress.

    - FULL_TRANSFER_FAILED: Full migration failed.

    - FULL_TRANSFER_COMPLETE: The full migration is complete.

    - INCRE_TRANSFER_STARTED: Incremental migration in progress

    - INCRE_TRANSFER_FAILED: Incremental migration failed.

    - RELEASE_RESOURCE_STARTED: The task is being stopped.

    - RELEASE_RESOURCE_FAILED: Stop task failed.

    - RELEASE_RESOURCE_COMPLETE: The task is stopped.

    - CHANGE_JOB_STARTED: The task is being changed.

    - CHANGE_JOB_FAILED: Change task failed.

    - CHILD_TRANSFER_STARTING: The subtask is being started.

    - CHILD_TRANSFER_STARTED: The subtask is being migrated.

    - CHILD_TRANSFER_COMPLETE: The subtask migration is complete.

    - CHILD_TRANSFER_FAILED: Migrate subtask failed.

    - RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.

    - RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is complete.

    error_code

    String

    Indicates the task error code.

    error_message

    String

    Indicates the error message.
  • Response example 
    {
"jobs": [
{
"status": "INCRE_TRANSFER_STARTED"
},
{
"status": "INCRE_TRANSFER_FAILED"
}
],
"count": 2
}

Abnormal Response

For details, see Abnormal Request Results.