Help Center/ Data Replication Service/ API Reference/ APIs V5.0/ Task Management/ Querying Tasks
Updated on 2026-09-07 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Tasks

Function

This API is used to query tenant tasks by enterprise project, engine type, network type, task status, task name, or task ID.

Constraints

  • This API is available only for migration and synchronization from MySQL to MySQL, migration from Redis to GeminiDB Redis, migration from Redis Cluster to GeminiDB Redis, and synchronization from Oracle to GaussDB Distributed.
  • This API can be used only in certain regions. For details, see Endpoints.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v5/{project_id}/jobs

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

job_type

Yes

String

Definition

DRS task type, which is used to distinguish different data replication scenarios.

Constraints

N/A

Range

  • migration: real-time migration
  • sync: real-time synchronization
  • cloudDataGuard: real-time disaster recovery

Default Value

N/A

name

No

String

Definition

Task ID or name, which is used to filter query results by task ID or name.

Constraints

You can enter a maximum of 10 task IDs separated by commas (,).

Range

N/A

Default Value

N/A

status

No

String

Definition

Current status of the task, which is used to filter query results by task status.

Constraints

N/A

Range

  • CREATING: The task is being created.
  • CREATE_FAILED: The task failed to be created.
  • CONFIGURATION: The task is being configured.
  • STARTJOBING: The task is being started.
  • WAITING_FOR_START: The task is waiting to be started.
  • START_JOB_FAILED: The task failed to be started.
  • FULL_TRANSFER_STARTED: Full migration or synchronization starts. For DR scenarios, initialization is in progress.
  • FULL_TRANSFER_FAILED: Full migration or synchronization failed. For DR scenarios, initialization failed.
  • FULL_TRANSFER_COMPLETE: Full migration or synchronization is complete. For DR scenarios, initialization is complete.
  • INCRE_TRANSFER_STARTED: Incremental migration or synchronization starts. For DR scenarios, disaster recovery is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration or synchronization failed. For DR scenarios, a DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task failed to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task failed to be changed.
  • CHILD_TRANSFER_STARTING: The subtask is being started.
  • CHILD_TRANSFER_STARTED: The subtask is in progress.
  • CHILD_TRANSFER_COMPLETE: The subtask is complete.
  • CHILD_TRANSFER_FAILED: The subtask failed.
  • RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.
  • RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped.

    You can query an abnormal status separately or query all abnormal tasks in the following statuses: CREATE_FAILED, START_JOB_FAILED, FULL_TRANSFER_FAILED, INCRE_TRANSFER_FAILED, RELEASE_RESOURCE_FAILED, CHANGE_JOB_FAILED, and CHILD_TRANSFER_FAILED.

Default Value

N/A

engine_type

No

String

Definition

DRS task engine type, which is used to filter query results by engine type.

Constraints

N/A

Range

  • oracle-to-gaussdbv5: real-time synchronization from Oracle to GaussDB Distributed
  • mysql-to-mysql: real-time migration and synchronization from MySQL to MySQL
  • redis-to-gaussredis: real-time migration from Redis to GeminiDB Redis
  • rediscluster-to-gaussredis: real-time migration from Redis Cluster to GeminiDB Redis

Default Value

N/A

net_type

No

String

Definition

Type of the network used by the task, which is used to filter query results by network type.

Constraints

N/A

Range

  • eip: public network
  • vpc: VPC network. The VPC network cannot be selected in DR scenarios.
  • vpn: VPN or Direct Connect

Default Value

N/A

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter query results by enterprise project.

Constraints

N/A

Range

N/A

Default Value

Empty string "": indicates that tasks in all enterprise projects are queried.

offset

No

Integer

Definition

Offset, which is used for pagination query. The records after this offset will be queried.

Constraints

N/A

Range

N/A

Default Value

0

limit

No

Integer

Definition

Maximum number of records that can be returned. This parameter is used to specify the number of records returned on each page during pagination query.

Constraints

N/A

Range

N/A

Default Value

N/A

sort_key

No

String

Definition

Keyword for sorting the returned results, which specifies the sorting basis of the task list.

Constraints

N/A

Range

  • name: sorting by task name
  • status: sorting by task status
  • create_time: sorting by creation time
  • net_type: sorting by network type
  • job_direction: sorting by task direction
  • pay_mode: sorting by billing mode

Default Value

create_time

sort_dir

No

String

Definition

Sorting order, which specifies whether the returned results are sorted in ascending or descending order.

Constraints

N/A

Range

  • desc: descending order
  • asc: ascending order

Default Value

desc

instance_ids

No

Array of strings

Definition

DB instance ID list, which is used to filter query results by DB instance.

Constraints

  • A maximum of 10 instance IDs are supported.

Range

N/A

Default Value

null: DB instance IDs are not used for filtering.

instance_ip

No

String

Definition

IP address of the DB instance bound to DRS, which is used to filter query results by DB instance IP address.

Constraints

N/A

Range

N/A

Default Value

Empty string (""): indicates that the IP address of the DB instance bound to DRS is not used for filtering.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us: English
  • zh-cn: Chinese

Default Value

en-us

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Definition

Total number of records in the list, which is irrelevant to pagination.

Constraints

N/A

Range

N/A

jobs

Array of objects

Definition

Task information list. For details, see Table 5.

Constraints

N/A

Range

N/A
Table 5 Data structure description of field jobs

Parameter

Type

Description

id

String

Definition

Task ID, which uniquely identifies a data replication task.

Constraints

N/A

Range

N/A

name

String

Definition

Task name, which identifies a data replication task.

Constraints

N/A

Range

N/A

status

String

Definition

Task status.

Constraints

N/A

Range

  • CREATING: The task is being created.
  • CREATE_FAILED: The task failed to be created.
  • CONFIGURATION: The task is being configured.
  • STARTJOBING: The task is being started.
  • WAITING_FOR_START: The task is waiting to be started.
  • START_JOB_FAILED: The task failed to be started.
  • FULL_TRANSFER_STARTED: Full migration is in progress. For DR scenarios, initialization is in progress.
  • FULL_TRANSFER_FAILED: Full migration failed. For DR scenarios, initialization failed.
  • FULL_TRANSFER_COMPLETE: Full migration is complete. For DR scenarios, initialization is complete.
  • INCRE_TRANSFER_STARTED: Incremental migration is in progress. For DR scenarios, disaster recovery is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration failed. For DR scenarios, a DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task failed to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task failed to be changed.
  • CHILD_TRANSFER_STARTING: The subtask is being started.
  • CHILD_TRANSFER_STARTED: The subtask is in progress.
  • CHILD_TRANSFER_COMPLETE: The subtask is complete.
  • CHILD_TRANSFER_FAILED: The subtask failed.
  • RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.
  • RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped.

description

String

Definition

Task description.

Constraints

N/A

Range

N/A

create_time

String

Definition

Time when the task was created, which indicates the timestamp when the task was created for the first time.

Constraints

N/A

Range

N/A

engine_type

String

Definition

Engine type of the DRS task.

Constraints

N/A

Range

  • oracle-to-gaussdbv5: real-time synchronization from Oracle to GaussDB Distributed
  • mysql-to-mysql: real-time migration and synchronization from MySQL to MySQL
  • redis-to-gaussredis: real-time migration from Redis to GeminiDB Redis
  • rediscluster-to-gaussredis: real-time migration from Redis Cluster to GeminiDB Redis

net_type

String

Definition

Type of the network used by the task.

Constraints

The VPC network cannot be selected in the DR scenario.

Range

  • eip: public network
  • vpc: VPC network
  • vpn: VPN or Direct Connect

charging_mode

String

Definition

Billing mode of the task.

Constraints

N/A

Range

  • period: yearly/monthly billing
  • on_demand: pay-per-use billing

billing_tag

Boolean

Definition

Billing mode tag of the task, which indicates whether the task is being billed.

Constraints

N/A

Range

  • true: being billed
  • false: not being billed

job_direction

String

Definition

Migration direction of the task.

Constraints

N/A

Range

  • up: to-the-cloud scenarios and DR scenarios where the current cloud is the standby
  • down: out-of-cloud scenarios and DR scenarios where the current cloud is the active
  • non-dbs: between self-built databases

job_type

String

Definition

DRS task type, which is used to distinguish different data replication scenarios.

Constraints

N/A

Range

  • migration: real-time migration
  • sync: real-time synchronization
  • cloudDataGuard: real-time disaster recovery

task_type

String

Definition

Task migration mode, which specifies the execution mode of the data replication task.

Constraints

N/A

Range

  • FULL_TRANS: Full migration. Only historical data is migrated.
  • FULL_INCR_TRANS: Full+incremental migration. Historical data is migrated first, and then incremental data is continuously synchronized.
  • INCR_TRANS: Incremental migration. Only data changes are synchronized.

enterprise_project_id

String

Definition

Enterprise project ID, which is used to filter query results by enterprise project.

Constraints

N/A

Range

N/A

job_mode

String

Definition

Task mode, which specifies the execution mode of the data replication task.

Constraints

N/A

Range

  • single: single task
  • sync_child: synchronization subtask
  • multi_to_single: many-to-one task

job_mode_role

String

Definition

Task role, which specifies the role of the data replication task in a multi-task scenario.

Constraints

N/A

Range

  • parent: parent task
  • child: subtask
  • master: primary task
  • slave: standby task

is_multi_az

Boolean

Definition

Whether the task is a primary/standby task deployed across AZs.

Constraints

N/A

Range

  • true: cross-AZ primary/standby task
  • false: non-cross-AZ task

node_role

String

Definition

Task node role, which identifies the role of the task in cluster deployment.

Constraints

N/A

Range

N/A

node_new_framework

Boolean

Definition

Whether the task is executed using the new framework.

Constraints

N/A

Range

  • true: new framework
  • false: old framework

job_action

Object

Definition

Task operation command set, which contains the operation commands that can be executed, cannot be executed, and are being executed for the task.

For details, see Table 7.

children

Array of objects

Definition

Subtask list information body, which contains details about all subtasks of the current task.

For details, see Table 6.
Table 6 Data structure description of field children

Parameter

Type

Description

id

String

Definition

Task ID, which identifies a data replication task.

Constraints

N/A

Range

N/A

name

String

Definition

Task name, which identifies a data replication task.

Constraints

N/A

Range

N/A

status

String

Definition

Task status.

Constraints

N/A

Range

  • CREATING: The task is being created.
  • CREATE_FAILED: The task failed to be created.
  • CONFIGURATION: The task is being configured.
  • STARTJOBING: The task is being started.
  • WAITING_FOR_START: The task is waiting to be started.
  • START_JOB_FAILED: The task failed to be started.
  • FULL_TRANSFER_STARTED: Full migration is in progress. For DR scenarios, initialization is in progress.
  • FULL_TRANSFER_FAILED: Full migration failed. For DR scenarios, initialization failed.
  • FULL_TRANSFER_COMPLETE: Full migration is complete. For DR scenarios, initialization is complete.
  • INCRE_TRANSFER_STARTED: Incremental migration is in progress. For DR scenarios, disaster recovery is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration failed. For DR scenarios, a DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task failed to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task failed to be changed.
  • CHILD_TRANSFER_STARTING: The subtask is being started.
  • CHILD_TRANSFER_STARTED: The subtask is in progress.
  • CHILD_TRANSFER_COMPLETE: The subtask is complete.
  • CHILD_TRANSFER_FAILED: The subtask failed.
  • RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.
  • RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped.

description

String

Definition

Task description.

Constraints

N/A

Range

N/A

create_time

String

Definition

Time when a task was created.

Constraints

N/A

Range

N/A

engine_type

String

Definition

Engine type of the DRS task.

Constraints

N/A

Range

  • oracle-to-gaussdbv5: real-time synchronization from Oracle to GaussDB Distributed
  • mysql-to-mysql: real-time migration and synchronization from MySQL to MySQL
  • redis-to-gaussredis: real-time migration from Redis to GeminiDB Redis
  • rediscluster-to-gaussredis: real-time migration from Redis Cluster to GeminiDB Redis

net_type

String

Definition

Type of the network used by the task.

Constraints

The VPC network cannot be selected in the DR scenario.

Range

  • eip: public network
  • vpc: VPC network
  • vpn: VPN or Direct Connect

charging_mode

String

Definition

Billing mode of the task.

Constraints

N/A

Range

  • period: yearly/monthly billing
  • on_demand: pay-per-use billing

billing_tag

Boolean

Definition

Billing mode tag of the task, which indicates whether the task is being billed.

Constraints

N/A

Range

  • true: being billed
  • false: not being billed

job_direction

String

Definition

Migration direction of the task.

Constraints

N/A

Range

  • up: to-the-cloud scenarios and DR scenarios where the current cloud is the standby
  • down: out-of-cloud scenarios and DR scenarios where the current cloud is the active
  • non-dbs: between self-built databases

job_type

String

Definition

DRS task type, which is used to distinguish different data replication scenarios.

Constraints

N/A

Range

  • migration: real-time migration
  • sync: real-time synchronization
  • cloudDataGuard: real-time disaster recovery

task_type

String

Definition

Task migration mode, which specifies the execution mode of the data replication task.

Constraints

N/A

Range

  • FULL_TRANS: Full migration. Only historical data is migrated.
  • FULL_INCR_TRANS: Full+incremental migration. Historical data is migrated first, and then incremental data is continuously synchronized.
  • INCR_TRANS: Incremental migration. Only data changes are synchronized.

enterprise_project_id

String

Definition

Enterprise project ID, which is used to filter query results by enterprise project.

Constraints

N/A

Range

N/A

job_mode

String

Definition

Task mode, which specifies the execution mode of the data replication task.

Constraints

N/A

Range

  • single: single task
  • sync_child: synchronization subtask
  • multi_to_single: many-to-one task

job_mode_role

String

Definition

Task role, which specifies the role of the data replication task in a multi-task scenario.

Constraints

N/A

Range

  • parent: parent task
  • child: subtask
  • master: primary task
  • slave: standby task

is_multi_az

Boolean

Definition

Whether the task is a primary/standby task deployed across AZs.

Constraints

N/A

Range

  • true: cross-AZ primary/standby task
  • false: non-cross-AZ task

node_role

String

Definition

Task node role, which identifies the role of the task in cluster deployment.

Constraints

N/A

Range

N/A

node_new_framework

Boolean

Definition

Whether the task is executed using the new framework.

Constraints

N/A

Range

  • true: new framework
  • false: old framework

job_action

Object

Definition

Task operation command set, which contains the operation commands that can be executed, cannot be executed, and are being executed for the task.

For details, see Table 7.
Table 7 Data structure description of field job_action

Parameter

Type

Description

available_actions

Array of strings

Definition

The set of operation commands that can be executed for the task.

Constraints

N/A

Range

  • CREATE: indicates the operation command for creating a task.
  • CHOOSE_OBJECT: indicates the operation command for selecting objects during the incremental task editing.
  • PRE_CHECK: indicates the operation command for performing a pre-check.
  • CHANGE_MODE: indicates the operation command for changing the task mode.
  • FREE_RESOURCE: indicates the operation command for releasing resources.
  • MODIFY_DB_CONFIG: indicates the operation command for modifying database configurations.
  • RESET_DB_PWD: indicates the operation command for resetting the password of the source or destination database.
  • MODIFY_CONFIGURATION: indicates the operation command for modifying task configurations.
  • PAUSE: indicates the operation command for pausing a task.
  • START: indicates the operation command for starting a task.
  • CHANGE: indicates the operation command for modifying a task.
  • RETRY: indicates the operation command for retrying a task.
  • RESET: indicates the operation command for resetting a task.
  • DELETE: indicates the operation command for deleting a task.
  • QUERY_PRE_CHECK: indicates the operation command for performing a pre-check.
  • SWITCH_OVER: indicates the operation command for performing a DR switchover.
  • START_INCR: indicates the operation command for starting an incremental Cassandra task.
  • MODIFY_TASK_NUMBER: indicates the operation command for modifying the number of Cassandra threads.
  • CONTINUE_JOB: indicates the operation command for resuming a failed or stopped task from Oracle to GaussDB Distributed.
  • STOP_JOB: indicates the operation command for stopping a task from Oracle to GaussDB Distributed.
  • CONTINUE_CAPTURE: indicates the operation command for starting workload capture.
  • STOP_CAPTURE: indicates the operation command for stopping workload capture.
  • CONTINUE_APPLY: indicates the operation command for starting workload replay.
  • STOP_APPLY: indicates the operation command for stopping workload replay.
  • PAY_ORDER: indicates the operation command for paying a yearly/monthly order.
  • UNSUBSCRIBE: indicates the operation command for unsubscribing from a yearly/monthly subscription.
  • TO_PERIOD: indicates the operation command for changing the billing mode from pay-per-use to yearly/monthly.
  • TO_RENEW: indicates the operation command for renewing a yearly/monthly subscription.
  • ORDER_INFO: indicates the operation command for querying order details.
  • CHANGE_FLAVOR: indicates the operation command for changing task specifications.
  • CLONE: indicates the operation command for cloning a task.

unavailable_actions

Array of strings

Definition

The set of operation commands that cannot be executed for the task.

Constraints

N/A

Range

  • CREATE: indicates the operation command for creating a task.
  • CHOOSE_OBJECT: indicates the operation command for selecting objects during the incremental task editing.
  • PRE_CHECK: indicates the operation command for performing a pre-check.
  • CHANGE_MODE: indicates the operation command for changing the task mode.
  • FREE_RESOURCE: indicates the operation command for releasing resources.
  • MODIFY_DB_CONFIG: indicates the operation command for modifying database configurations.
  • RESET_DB_PWD: indicates the operation command for resetting the password of the source or destination database.
  • MODIFY_CONFIGURATION: indicates the operation command for modifying task configurations.
  • PAUSE: indicates the operation command for pausing a task.
  • START: indicates the operation command for starting a task.
  • CHANGE: indicates the operation command for modifying a task.
  • RETRY: indicates the operation command for retrying a task.
  • RESET: indicates the operation command for resetting a task.
  • DELETE: indicates the operation command for deleting a task.
  • QUERY_PRE_CHECK: indicates the operation command for performing a pre-check.
  • SWITCH_OVER: indicates the operation command for performing a DR switchover.
  • START_INCR: indicates the operation command for starting an incremental Cassandra task.
  • MODIFY_TASK_NUMBER: indicates the operation command for modifying the number of Cassandra threads.
  • CONTINUE_JOB: indicates the operation command for resuming a failed or stopped task from Oracle to GaussDB Distributed.
  • STOP_JOB: indicates the operation command for stopping a task from Oracle to GaussDB Distributed.
  • CONTINUE_CAPTURE: indicates the operation command for starting workload capture.
  • STOP_CAPTURE: indicates the operation command for stopping workload capture.
  • CONTINUE_APPLY: indicates the operation command for starting workload replay.
  • STOP_APPLY: indicates the operation command for stopping workload replay.
  • PAY_ORDER: indicates the operation command for paying a yearly/monthly order.
  • UNSUBSCRIBE: indicates the operation command for unsubscribing from a yearly/monthly subscription.
  • TO_PERIOD: indicates the operation command for changing the billing mode from pay-per-use to yearly/monthly.
  • TO_RENEW: indicates the operation command for renewing a yearly/monthly subscription.
  • ORDER_INFO: indicates the operation command for querying order details.
  • CHANGE_FLAVOR: indicates the operation command for changing task specifications.
  • CLONE: indicates the operation command for cloning a task.

current_action

String

Definition

Operation command that is being executed for the task.

Constraints

N/A

Range

  • API_CONFIGURATION_ACTION: indicates the operation command for calling an open API of a task.
  • CHANGE: indicates the operation command for modifying a task.
  • CHANGE_MODE: indicates the operation command for changing the task mode.
  • CHOOSE_OBJECT: indicates the operation command for selecting an object.
  • CLONE: indicates the operation command for cloning a task.
  • CONTINUE_APPLY: indicates the operation command for starting workload replay. This parameter is available for synchronization from Oracle to GaussDB Distributed.
  • CONTINUE_CAPTURE: indicates the operation command for starting workload capture. This parameter is available for synchronization from Oracle to GaussDB Distributed.
  • CONTINUE_JOB: indicates the operation command for resuming a failed or stopped task. This parameter is available for synchronization from Oracle to GaussDB Distributed.
  • CREATE: indicates the operation command for creating a task.
  • DELETE: indicates the operation command for deleting a task.
  • FREE_RESOURCE: indicates the operation command for releasing resources.
  • JUMP_RETRY: indicates the operation command for skipping a resumable task.
  • MODIFY_CONFIGURATION: indicates the operation command for modifying task configurations.
  • MODIFY_DB_CONFIG: indicates the operation command for modifying database configurations.
  • MODIFY_TASK_NUMBER: indicates the operation command for modifying the number of threads.
  • NODE_FLAVOR_MODIFY: indicates the operation command for changing node specifications.
  • ORDER_INFO: indicates the operation command for querying order details.
  • PAUSE: indicates the operation command for pausing a task.
  • PAY_ORDER: indicates the operation command for paying a yearly/monthly order.
  • PRE_CHECK: indicates the operation command for performing a pre-check.
  • QUERY_PRE_CHECK: indicates the operation command for querying the precheck result.
  • RESET: indicates the operation command for resetting a task.
  • RESET_DB_PWD: indicates the operation command for resetting the password of the source or destination database.
  • RETRY: indicates the operation command for retrying a task.
  • START: indicates the operation command for starting a task.
  • START_INCR: indicates the operation command for starting an incremental task.
  • STOP_APPLY: indicates the operation command for stopping workload replay. This parameter is available for synchronization from Oracle to GaussDB Distributed.
  • STOP_CAPTURE: indicates the operation command for stopping workload capture. This parameter is available for synchronization from Oracle to GaussDB Distributed.
  • STOP_JOB: indicates the operation command for stopping a task. This parameter is available for synchronization from Oracle to GaussDB Distributed.
  • SWITCH_OVER: indicates the operation command for performing a DR switchover.
  • TO_PERIOD: indicates the operation command for changing the billing mode to yearly/monthly.
  • TO_RENEW: indicates the operation command for renewing a yearly/monthly task.
  • UNSUBSCRIBE: indicates the operation command for unsubscribing from a yearly/monthly task.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code returned when an error occurs during task execution.

Constraints

  • Minimum length: 12 characters
  • Maximum length: 12 characters

Range

The format is DRS.XXXXXX.

error_msg

String

Definition

Detailed error description returned when a task fails to be executed.

Constraints

  • Minimum length: 1 character
  • Maximum length: 512 characters

Range

N/A

Example Request

  • Querying the real-time DR task list 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs?job_type=cloudDataGuard&offset=0&limit=10&sort_key=create_time&sort_dir=desc
  • Querying the real-time migration task list 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs?job_type=migration&offset=0&limit=10&sort_key=create_time&sort_dir=desc
  • Querying the real-time synchronization task list 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs?job_type=sync&offset=0&limit=10&sort_key=create_time&sort_dir=desc
  • Querying the real-time DR task list based on the database IP address 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs?job_type=cloudDataGuard&offset=0&limit=10&sort_key=create_time&sort_dir=desc&instance_ip=127.0.0.1
  • Querying the real-time DR task list based on the database ID 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs?job_type=cloudDataGuard&offset=0&limit=10&sort_key=create_time&sort_dir=desc&instance_ids=id1&instance_ids=id2
  • Querying the real-time synchronization task list using multiple task IDs 
    https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs?name=bee869bc-15c0-4b3b-a34b-bf0d5efjb201,c2a61a77-6e55-4cd8-8be1-a562cc6jb201&job_type=sync

Example Response

Status code: 200

OK

{
  "jobs" : [ {
    "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r",
    "name" : "DRS-1234",
    "status" : "CONFIGURATION",
    "create_time" : "2022-11-07T16:15:18Z",
    "engine_type" : "oracle-to-gaussdbv5",
    "job_direction" : "up",
    "task_type" : "FULL_INCR_TRANS",
    "job_action" : {
      "available_actions" : [ "FREE_RESOURCE", "PRE_CHECK", "MODIFY_CONFIGURATION", "CHANGE" ],
      "unavailable_actions" : [ "CREATE", "START", "CHOOSE_OBJECT", "RETRY", "RESET", "DELETE", "QUERY_PRE_CHECK", "CHANGE_MODE", "MODIFY_DB_CONFIG", "SWITCH_OVER", "RESET_DB_PWD", "PAUSE", "JUMP_RETRY", "START_INCR", "MODIFY_TASK_NUMBER", "CONTINUE_JOB", "STOP_JOB", "CONTINUE_CAPTURE", "STOP_CAPTURE", "CONTINUE_APPLY", "API_CONFIGURATION_ACTION", "STOP_APPLY", "PAY_ORDER", "UNSUBSCRIBE", "TO_PERIOD", "TO_RENEW", "ORDER_INFO", "CLONE" ],
      "current_action" : null
    }
  } ],
  "total_count" : 1
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Task Management