Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying Tasks of a Tenant

Function

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

Debugging

You can debug the API in API Explorer to support automatic authentication. API Explorer can automatically generate and debug example SDK code.

URI

POST /v3/{project_id}/jobs

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

The content type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

X-Language

No

String

Request language type

Default value: en-us

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

cur_page

Yes

Integer

Current page. Set the value to 0 to obtain all items. If per_page is set to 0, cur_page can only be set to 0 or 1.

Default value: 1

per_page

Yes

Integer

Number of records on each page. If this parameter is set to 0, cur_page can only be set to 0 or 1.

  • Default value: 10
  • Minimum value: 0
  • Maximum value: 100

db_use_type

Yes

String

Migration scenario. The value can be migration (real-time migration), sync (real-time synchronization), or cloudDataGuard (real-time disaster recovery).

Values:

  • migration
  • sync
  • cloudDataGuard

engine_type

No

String

Engine type of a DRS task.

Default value: mysql

Values:

  • mysql: migration and synchronization from MySQL to MySQL
  • mongodb: migration from MongoDB to DDS
  • cloudDataGuard-mysql: DR from MySQL to MySQL
  • gaussdbv5: GaussDB synchronization
  • mysql-to-kafka: synchronization from MySQL to Kafka
  • taurus-to-kafka: synchronization from TaurusDB to Kafka
  • gaussdbv5ha-to-kafka: synchronization from GaussDB Centralized to Kafka
  • postgresql: synchronization from PostgreSQL to PostgreSQL
  • oracle-to-gaussdbv5: synchronization from Oracle to GaussDB Distributed
  • oracle-to-gaussdbv5ha: synchronization from Oracle to GaussDB Centralized
  • gaussdbv5-to-oracle: synchronization from GaussDB Distributed to Oracle
  • gaussdbv5ha-to-oracle: synchronization from GaussDB Centralized to Oracle
  • gaussdbv5-to-kafka: synchronization from GaussDB Distributed to Kafka

For details, see Engine Types.

enterprise_project_id

No

String

Enterprise project. If no value is specified, this parameter is set to null. This parameter cannot be left blank. When enterprise project is enabled, this parameter can be set.

name

No

String

Name or ID. You can enter a maximum of 100 task IDs separated by commas (,).

net_type

No

String

Network type. Values:

  • vpn
  • vpc
  • eip

service_name

No

String

Service name.

status

No

String

Task status.

  • CREATING: The task is being created.
  • CREATE_FAILED: The task fails 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 fails to be started.
  • PAUSING: The task is paused.
  • FULL_TRANSFER_STARTED: Full migration or synchronization starts. Initialization is in progress in the DR scenario.
  • FULL_TRANSFER_FAILED: Full migration or synchronization fails. Initialization fails in the DR scenario.
  • FULL_TRANSFER_COMPLETE: Full migration or synchronization is complete. Initialization is complete in the DR scenario.
  • INCRE_TRANSFER_STARTED: Incremental migration or synchronization starts. The DR task is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration or synchronization fails. A DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task fails to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • REBUILD_NODE_STARTED: The task is being recovered.
  • REBUILD_NODE_FAILED: The task fails to be recovered.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task fails to be changed.
  • DELETED: The task is deleted.
  • 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: The subtask fails to be migrated.
  • RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.
  • RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped.
  • NODE_UPGRADE_START: The upgrade starts.
  • NODE_UPGRADE_COMPLETE: The upgrade is complete.
  • NODE_UPGRADE_FAILED: The upgrade fails.

Enumerated values:

  • CREATING
  • CREATE_FAILED
  • CONFIGURATION
  • STARTJOBING
  • WAITING_FOR_START
  • START_JOB_FAILED
  • PAUSING
  • FULL_TRANSFER_STARTED
  • FULL_TRANSFER_FAILED
  • FULL_TRANSFER_COMPLETE
  • INCRE_TRANSFER_STARTED
  • INCRE_TRANSFER_FAILED
  • RELEASE_RESOURCE_STARTED
  • RELEASE_RESOURCE_FAILED
  • RELEASE_RESOURCE_COMPLETE
  • REBUILD_NODE_STARTED
  • REBUILD_NODE_FAILED
  • CHANGE_JOB_STARTED
  • CHANGE_JOB_FAILED
  • DELETED
  • CHILD_TRANSFER_STARTING
  • CHILD_TRANSFER_STARTED
  • CHILD_TRANSFER_COMPLETE
  • CHILD_TRANSFER_FAILED
  • RELEASE_CHILD_TRANSFER_STARTED
  • RELEASE_CHILD_TRANSFER_COMPLETE
  • NODE_UPGRADE_START
  • NODE_UPGRADE_COMPLETE
  • NODE_UPGRADE_FAILED

tags

No

Map<String,String>

Tags.

For details, see Table 7.

instance_ids

No

Array of strings

List of database instance IDs. The default value is null, indicating that database instance IDs are not used for task filtering.

instance_ip

No

String

IP address of the database instance bound to the DRS. The default value is "", indicating that the IP address of the database instance bound to the DRS is not used for task filtering.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_record

Integer

Total number of tasks

jobs

Array of objects

Task details.

For details, see Table 5.

Table 5 Data structure description of field jobs

Parameter

Type

Description

id

String

Task ID.

name

String

Task name.

status

String

Task status.

  • CREATING: The task is being created.
  • CREATE_FAILED: The task fails 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 fails to be started.
  • PAUSING: The task is paused.
  • FULL_TRANSFER_STARTED: Full migration or synchronization starts. Initialization is in progress in the DR scenario.
  • FULL_TRANSFER_FAILED: Full migration or synchronization fails. Initialization fails in the DR scenario.
  • FULL_TRANSFER_COMPLETE: Full migration or synchronization is complete. Initialization is complete in the DR scenario.
  • INCRE_TRANSFER_STARTED: Incremental migration or synchronization starts. The DR task is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration or synchronization fails. A DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task fails to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • REBUILD_NODE_STARTED: The task is being recovered.
  • REBUILD_NODE_FAILED: The task fails to be recovered.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task fails to be changed.
  • DELETED: The task is deleted.
  • 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: The subtask fails to be migrated.
  • RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.
  • RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped.
  • NODE_UPGRADE_START: The upgrade starts.
  • NODE_UPGRADE_COMPLETE: The upgrade is complete.
  • NODE_UPGRADE_FAILED: The upgrade fails.

Enumerated values:

  • CREATING
  • CREATE_FAILED
  • CONFIGURATION
  • STARTJOBING
  • WAITING_FOR_START
  • START_JOB_FAILED
  • PAUSING
  • FULL_TRANSFER_STARTED
  • FULL_TRANSFER_FAILED
  • FULL_TRANSFER_COMPLETE
  • INCRE_TRANSFER_STARTED
  • INCRE_TRANSFER_FAILED
  • RELEASE_RESOURCE_STARTED
  • RELEASE_RESOURCE_FAILED
  • RELEASE_RESOURCE_COMPLETE
  • REBUILD_NODE_STARTED
  • REBUILD_NODE_FAILED
  • CHANGE_JOB_STARTED
  • CHANGE_JOB_FAILED
  • DELETED
  • CHILD_TRANSFER_STARTING
  • CHILD_TRANSFER_STARTED
  • CHILD_TRANSFER_COMPLETE
  • CHILD_TRANSFER_FAILED
  • RELEASE_CHILD_TRANSFER_STARTED
  • RELEASE_CHILD_TRANSFER_COMPLETE
  • NODE_UPGRADE_START
  • NODE_UPGRADE_COMPLETE
  • NODE_UPGRADE_FAILED

description

String

Task description.

create_time

String

Time when a task is created

engine_type

String

Engine type of a DRS task. Values:

  • mysql: migration and synchronization from MySQL to MySQL
  • mongodb: migration from MongoDB to DDS
  • cloudDataGuard-mysql: DR from MySQL to MySQL
  • gaussdbv5: GaussDB synchronization
  • mysql-to-kafka: synchronization from MySQL to Kafka
  • taurus-to-kafka: synchronization from TaurusDB to Kafka
  • gaussdbv5ha-to-kafka: synchronization from GaussDB Centralized to Kafka
  • postgresql: synchronization from PostgreSQL to PostgreSQL
  • oracle-to-gaussdbv5: synchronization from Oracle to GaussDB Distributed
  • oracle-to-gaussdbv5ha: synchronization from Oracle to GaussDB Centralized
  • gaussdbv5-to-oracle: synchronization from GaussDB Distributed to Oracle
  • gaussdbv5ha-to-oracle: synchronization from GaussDB Centralized to Oracle
  • gaussdbv5-to-kafka: synchronization from GaussDB Distributed to Kafka

For details, see Engine Types.

net_type

String

Network type. Values:

  • vpn
  • vpc
  • eip

billing_tag

Boolean

Billing tag.

job_direction

String

Task direction. Values:

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

db_use_type

String

Task scenario. Values:

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

task_type

String

Task mode. Values:

  • FULL_TRANS: full migration
  • FULL_INCR_TRANS: full+incremental migration
  • INCR_TRANS: incremental migration

children

Array of objects

Subtask information body.

For details, see Table 6.

node_newFramework

Boolean

Whether the framework is a new framework.

job_action

Object

The matrix of task operation commands.

For details, see Table 7.

Table 6 Data structure description of field children

Parameter

Type

Description

billing_tag

Boolean

Billing tag.

create_time

String

Time when a task is created

db_use_type

String

Replication scenario. Values:

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

description

String

Task description.

engine_type

String

Engine type of a DRS task. Values:

  • mysql: migration and synchronization from MySQL to MySQL
  • mongodb: migration from MongoDB to DDS
  • cloudDataGuard-mysql: DR from MySQL to MySQL
  • gaussdbv5: GaussDB synchronization
  • mysql-to-kafka: synchronization from MySQL to Kafka
  • taurus-to-kafka: synchronization from TaurusDB to Kafka
  • gaussdbv5ha-to-kafka: synchronization from GaussDB Centralized to Kafka
  • postgresql: synchronization from PostgreSQL to PostgreSQL
  • oracle-to-gaussdbv5: synchronization from Oracle to GaussDB Distributed
  • oracle-to-gaussdbv5ha: synchronization from Oracle to GaussDB Centralized
  • gaussdbv5-to-oracle: synchronization from GaussDB Distributed to Oracle
  • gaussdbv5ha-to-oracle: synchronization from GaussDB Centralized to Oracle
  • gaussdbv5-to-kafka: synchronization from GaussDB Distributed to Kafka

For details, see Engine Types.

error_msg

String

Task failure cause.

id

String

Task ID.

job_direction

String

Migration direction. Values:

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

name

String

Task name.

net_type

String

Network type. Values:

  • vpc
  • vpn
  • eip

node_newFramework

Boolean

New framework

status

String

Task status.

  • CREATING: The task is being created.
  • CREATE_FAILED: The task fails 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 fails to be started.
  • PAUSING: The task is paused.
  • FULL_TRANSFER_STARTED: Full migration or synchronization starts. Initialization is in progress in the DR scenario.
  • FULL_TRANSFER_FAILED: Full migration or synchronization fails. Initialization fails in the DR scenario.
  • FULL_TRANSFER_COMPLETE: Full migration or synchronization is complete. Initialization is complete in the DR scenario.
  • INCRE_TRANSFER_STARTED: Incremental migration or synchronization starts. The DR task is in progress.
  • INCRE_TRANSFER_FAILED: Incremental migration or synchronization fails. A DR exception occurs.
  • RELEASE_RESOURCE_STARTED: The task is being stopped.
  • RELEASE_RESOURCE_FAILED: The task fails to be stopped.
  • RELEASE_RESOURCE_COMPLETE: The task is stopped.
  • REBUILD_NODE_STARTED: The task is being recovered.
  • REBUILD_NODE_FAILED: The task fails to be recovered.
  • CHANGE_JOB_STARTED: The task is being changed.
  • CHANGE_JOB_FAILED: The task fails to be changed.
  • DELETED: The task is deleted.
  • 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: The subtask fails to be migrated.
  • RELEASE_CHILD_TRANSFER_STARTED: The subtask is being stopped.
  • RELEASE_CHILD_TRANSFER_COMPLETE: The subtask is stopped.
  • NODE_UPGRADE_START: The upgrade starts.
  • NODE_UPGRADE_COMPLETE: The upgrade is complete.
  • NODE_UPGRADE_FAILED: The upgrade fails.

Enumerated values:

  • CREATING
  • CREATE_FAILED
  • CONFIGURATION
  • STARTJOBING
  • WAITING_FOR_START
  • START_JOB_FAILED
  • PAUSING
  • FULL_TRANSFER_STARTED
  • FULL_TRANSFER_FAILED
  • FULL_TRANSFER_COMPLETE
  • INCRE_TRANSFER_STARTED
  • INCRE_TRANSFER_FAILED
  • RELEASE_RESOURCE_STARTED
  • RELEASE_RESOURCE_FAILED
  • RELEASE_RESOURCE_COMPLETE
  • REBUILD_NODE_STARTED
  • REBUILD_NODE_FAILED
  • CHANGE_JOB_STARTED
  • CHANGE_JOB_FAILED
  • DELETED
  • CHILD_TRANSFER_STARTING
  • CHILD_TRANSFER_STARTED
  • CHILD_TRANSFER_COMPLETE
  • CHILD_TRANSFER_FAILED
  • RELEASE_CHILD_TRANSFER_STARTED
  • RELEASE_CHILD_TRANSFER_COMPLETE
  • NODE_UPGRADE_START
  • NODE_UPGRADE_COMPLETE
  • NODE_UPGRADE_FAILED

task_type

String

Task mode. Values:

  • FULL_TRANS: full migration
  • FULL_INCR_TRANS: full+incremental migration
  • INCR_TRANS: incremental migration

job_action

Object

The matrix of task operation commands.

For details, see Table 7.

Table 7 Data structure description of field job_action

Parameter

Type

Description

available_actions

Array of strings

The collection of operation commands that can be executed for a task.

Values:

  • CREATE: indicates the operation command for creating a task.
  • CHOOSE_OBJECT: indicates the operation command for selecting an object.
  • PRE_CHECK: indicates the operation command for 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 data capture for a task from Oracle to GaussDB distributed.
  • STOP_CAPTURE: indicates the operation command for stopping data capture for a task from Oracle to GaussDB distributed.
  • CONTINUE_APPLY: indicates the operation command for starting data replay for a task from Oracle to GaussDB distributed.
  • STOP_APPLY: indicates the operation command for stopping data replay for a task from Oracle to GaussDB distributed.
  • 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

The collection of operation commands that cannot be executed for a task.

Values:

  • CREATE: indicates the operation command for creating a task.
  • CHOOSE_OBJECT: indicates the operation command for selecting an object.
  • PRE_CHECK: indicates the operation command for 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 data capture for a task from Oracle to GaussDB distributed.
  • STOP_CAPTURE: indicates the operation command for stopping data capture for a task from Oracle to GaussDB distributed.
  • CONTINUE_APPLY: indicates the operation command for starting data replay for a task from Oracle to GaussDB distributed.
  • STOP_APPLY: indicates the operation command for stopping data replay for a task from Oracle to GaussDB distributed.
  • 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

The current operation. Values:

  • SWITCH_OVER: indicates that a DR switchover is in progress.
  • STOP_JOB: indicates that a task is being paused.

Example Request

  • Example of querying the real-time synchronization task list:
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs
    
    {
      "cur_page" : 1,
      "db_use_type" : "sync",
      "engine_type" : "",
      "name" : "",
      "net_type" : "",
      "per_page" : 5,
      "status" : ""
    }
  • Example of querying the real-time migration task list:
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs
    
    {
      "cur_page" : 1,
      "db_use_type" : "migration",
      "engine_type" : "",
      "name" : "",
      "net_type" : "",
      "per_page" : 5,
      "status" : ""
    }
  • Example of querying the real-time synchronization tasks based on the database instance ID:
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs 
      
     { 
       "cur_page" : 1, 
       "db_use_type" : "sync", 
       "engine_type" : "", 
       "enterprise_project_id" : "", 
       "name" : "", 
       "net_type" : "", 
       "per_page" : 5, 
       "instance_ids" : [ "id1", "id2" ], 
       "status" : "" 
     }
  • Example of querying the real-time synchronization tasks based on the database instance IP address:
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs 
      
     { 
       "cur_page" : 1, 
       "db_use_type" : "sync", 
       "engine_type" : "", 
       "enterprise_project_id" : "", 
       "name" : "", 
       "net_type" : "", 
       "per_page" : 5, 
       "instance_ip" : "127.0.0.1", 
       "status" : "" 
     }
  • Querying the real-time synchronization task list using multiple task IDs
    https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs 
      
    {
      "cur_page": 1,
      "db_use_type": "sync",
      "engine_type": "",
      "name": "bee869bc-15c0-4b3b-a34b-bf0d5efjb201,c2a61a77-6e55-4cd8-8be1-a562cc6jb201",
      "net_type": "",
      "per_page": 100,
      "status": ""
    }

Example Response

Status code: 200

OK

  • Example response for querying the real-time migration tasks:
    {
      "jobs" : [ {
        "id" : "24834eb6-be30-464e-a299-f7aa730jb101",
        "name" : "DRS-3999-lws",
        "status" : "INCRE_TRANSFER_FAILED",
        "description" : "",
        "create_time" : "2020-12-21 10:57:49",
        "error_msg" : "service LOGMANAGER failed, cause by: Unable to connect to DBMS: url=jdbc:mysql://172.22.74.56:3306?useUnicode=true&allowLoadLocalInfile=false&characterEncoding=UTF-8&connectTimeout=5000&useSSL=false&allowPublicKeyRetrieval=true&verifyServerCertificate=false&serverTimezone=UTC user=root",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
        "job_action":{
            "available_actions": [
                "CREATE",
                "CHOOSE_OBJECT",
                "PRE_CHECK",
                "CHANGE_MODE",
                "FREE_RESOURCE",
                "MODIFY_DB_CONFIG",
                "RESET_DB_PWD",
                "MODIFY_CONFIGURATION",
                "PAUSE",
                "RETRY",
                "RESET",
             ],
             "unavailable_actions": [
                 "START",
                 "CHANGE",
                 "DELETE",
                 "QUERY_PRE_CHECK",
                 "SWITCH_OVER",
                 "MODIFY_SPECIFICATION_ID",
                 "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",
                 "CHANGE_FLAVOR",
                 "CLONE"
             ]
        }    
      }, {
        "id" : "140b5236-88ad-43c8-811c-1268453jb101",
        "name" : "DRS-0042-linxiaolu",
        "status" : "CONFIGURATION",
        "description" : "",
        "create_time" : "2020-12-19 16:23:24",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
        "job_action": {
            "available_actions": [
                "CREATE",
                "START",
                "CHANGE",
                "CHOOSE_OBJECT",
                "PRE_CHECK",
                "CHANGE_MODE",
                "FREE_RESOURCE",
                "MODIFY_DB_CONFIG",
                "API_CONFIGURATION_ACTION"
            ],
            "unavailable_actions": [
                "RETRY",
                "RESET",
                "DELETE",
                "QUERY_PRE_CHECK",
                "SWITCH_OVER",
                "MODIFY_SPECIFICATION_ID",
                "RESET_DB_PWD",
                "MODIFY_CONFIGURATION",
                "PAUSE",
                "JUMP_RETRY",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "CONTINUE_JOB",
                "STOP_JOB",
                "CONTINUE_CAPTURE",
                "STOP_CAPTURE",
                "CONTINUE_APPLY",
                "STOP_APPLY",
                "PAY_ORDER",
                "UNSUBSCRIBE",
                "TO_PERIOD",
                "TO_RENEW",
                "ORDER_INFO",
                "CHANGE_FLAVOR",
                 "CLONE"
             ]
         }
      }, {
        "id" : "7f8e6f74-72d2-4ddd-bb8f-6c41397jb101",
        "name" : "DRS-0796",
        "status" : "RELEASE_RESOURCE_COMPLETE",
        "description" : "",
        "create_time" : "2020-12-18 10:48:11",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "non-dbs",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
        "job_action": {
            "available_actions": [
                "CREATE",
                "DELETE",
                "PRE_CHECK",
                "CHANGE_MODE",
                "MODIFY_DB_CONFIG",
                "CLONE"
            ],
            "unavailable_actions": [
                "FREE_RESOURCE",
                "START",
                "CHANGE",
                "CHOOSE_OBJECT",
                "RETRY",
                "RESET",
                "QUERY_PRE_CHECK",
                "SWITCH_OVER",
                "MODIFY_SPECIFICATION_ID",
                "RESET_DB_PWD",
                "MODIFY_CONFIGURATION",
                "PAUSE",
                "JUMP_RETRY",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "CONTINUE_JOB",
                "STOP_JOB",
                "CONTINUE_CAPTURE",
                "STOP_CAPTURE",
                "CONTINUE_APPLY",
                "STOP_APPLY",
                "PAY_ORDER",
                "UNSUBSCRIBE",
                "TO_PERIOD",
                "TO_RENEW",
                "ORDER_INFO",
                "CHANGE_FLAVOR"
             ]
         }
      }, {
        "id" : "14d88eeb-ee7e-4d30-a46e-a5ec8eajb101",
        "name" : "masj-mysql_migration_down-1",
        "status" : "INCRE_TRANSFER_STARTED",
    "description": "[using] api test 2\n1. This API is used to configure the source and destination database information. Before selecting a table, you must perform this operation. \n2. If the description of a task in the configuration is successfully modified, 202 success is returned. \n3. If the description of a task in an incremental migration fails to be modified, 202 failed DRS.M01504\nAnother operation is being performed on the migration task or the migration task is abnormal. Try again later./",
        "create_time" : "2020-12-15 15:43:02",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : true,
        "job_direction" : "down",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
        "job_action":{
            "available_actions": [
                 "CREATE",
                 "CHOOSE_OBJECT",
                 "PRE_CHECK",
                 "CHANGE_MODE",
                 "FREE_RESOURCE",
                 "MODIFY_DB_CONFIG",
                 "RESET_DB_PWD",
                 "MODIFY_CONFIGURATION",
                 "PAUSE",
             ],
            "unavailable_actions": [
                 "START",
                 "RETRY",
                 "RESET",
                 "CHANGE",
                 "DELETE",
                 "QUERY_PRE_CHECK",
                 "SWITCH_OVER",
                 "MODIFY_SPECIFICATION_ID",
                 "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",
                 "CHANGE_FLAVOR",
                 "CLONE"
             ]
        }    
      }, {
        "id" : "d54691d2-f105-434d-a75d-809b017jb101",
        "name" : "masj-2-mysql_migration_down",
        "status" : "CONFIGURATION",
    "description": "[using] api test 2\n1. This API is used to configure the source and destination database information. Before selecting a table, you must perform this operation. \n2. If the description of a task in the configuration is successfully modified, 202 success is returned. \n3. If the description of a task in an incremental migration fails to be modified, 202 failed DRS.M01504\nAnother operation is being performed on the migration task or the migration task is abnormal. Try again later./",
        "create_time" : "2020-12-14 21:39:07",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "down",
        "db_use_type" : "migration",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
        "job_action": {
            "available_actions": [
                "CREATE",
                "START",
                "CHANGE",
                "CHOOSE_OBJECT",
                "PRE_CHECK",
                "CHANGE_MODE",
                "FREE_RESOURCE",
                "MODIFY_DB_CONFIG",
                "API_CONFIGURATION_ACTION"
            ],
            "unavailable_actions": [
                "RETRY",
                "RESET",
                "DELETE",
                "QUERY_PRE_CHECK",
                "SWITCH_OVER",
                "MODIFY_SPECIFICATION_ID",
                "RESET_DB_PWD",
                "MODIFY_CONFIGURATION",
                "PAUSE",
                "JUMP_RETRY",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "CONTINUE_JOB",
                "STOP_JOB",
                "CONTINUE_CAPTURE",
                "STOP_CAPTURE",
                "CONTINUE_APPLY",
                "STOP_APPLY",
                "PAY_ORDER",
                "UNSUBSCRIBE",
                "TO_PERIOD",
                "TO_RENEW",
                "ORDER_INFO",
                "CHANGE_FLAVOR",
                 "CLONE"
             ]
         }
      } ],
      "total_record" : 7
    }
  • Example response for querying the real-time synchronization tasks:
    {
      "jobs" : [ {
        "id" : "7994aac9-0a15-4fdb-bcc5-667f088jb20b",
        "name" : "DRS-8200",
        "status" : "CREATE_FAILED",
        "description" : "",
        "create_time" : "2020-12-21 18:02:36",
        "error_msg" : "system error!",
        "engine_type" : "oracle-to-mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
        "job_action": {
            "available_actions": [
                "CREATE",
                "DELETE",
                "START",
                "CHANGE",
                "CHOOSE_OBJECT",
                "PRE_CHECK",
                "CHANGE_MODE",
                "MODIFY_DB_CONFIG",
                "API_CONFIGURATION_ACTION"
            ],
            "unavailable_actions": [
                "FREE_RESOURCE",
                "RETRY",
                "RESET",
                "QUERY_PRE_CHECK",
                "SWITCH_OVER",
                "MODIFY_SPECIFICATION_ID",
                "RESET_DB_PWD",
                "MODIFY_CONFIGURATION",
                "PAUSE",
                "JUMP_RETRY",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "CONTINUE_JOB",
                "STOP_JOB",
                "CONTINUE_CAPTURE",
                "STOP_CAPTURE",
                "CONTINUE_APPLY",
                "STOP_APPLY",
                "PAY_ORDER",
                "UNSUBSCRIBE",
                "TO_PERIOD",
                "TO_RENEW",
                "ORDER_INFO",
                "CHANGE_FLAVOR",
                 "CLONE"
             ]
         }
      }, {
        "id" : "f463331d-e079-4689-bbef-4553202jb20b",
        "name" : "DRS-1285",
        "status" : "CONFIGURATION",
        "description" : "",
        "create_time" : "2020-12-21 17:19:38",
        "engine_type" : "oracle-to-mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
        "job_action": {
            "available_actions": [
                "CREATE",
                "START",
                "CHANGE",
                "CHOOSE_OBJECT",
                "PRE_CHECK",
                "CHANGE_MODE",
                "FREE_RESOURCE",
                "MODIFY_DB_CONFIG",
                "API_CONFIGURATION_ACTION"
            ],
            "unavailable_actions": [
                "RETRY",
                "RESET",
                "DELETE",
                "QUERY_PRE_CHECK",
                "SWITCH_OVER",
                "MODIFY_SPECIFICATION_ID",
                "RESET_DB_PWD",
                "MODIFY_CONFIGURATION",
                "PAUSE",
                "JUMP_RETRY",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "CONTINUE_JOB",
                "STOP_JOB",
                "CONTINUE_CAPTURE",
                "STOP_CAPTURE",
                "CONTINUE_APPLY",
                "STOP_APPLY",
                "PAY_ORDER",
                "UNSUBSCRIBE",
                "TO_PERIOD",
                "TO_RENEW",
                "ORDER_INFO",
                "CHANGE_FLAVOR",
                 "CLONE"
             ]
         }
      }, {
        "id" : "7f13c511-c35b-4f82-92ae-83bcbf0jb201",
        "name" : "DRS-9383",
        "status" : "CONFIGURATION",
        "description" : "",
        "create_time" : "2020-12-21 17:18:44",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
        "job_action": {
            "available_actions": [
                "CREATE",
                "START",
                "CHANGE",
                "CHOOSE_OBJECT",
                "PRE_CHECK",
                "CHANGE_MODE",
                "FREE_RESOURCE",
                "MODIFY_DB_CONFIG",
                "API_CONFIGURATION_ACTION"
            ],
            "unavailable_actions": [
                "RETRY",
                "RESET",
                "DELETE",
                "QUERY_PRE_CHECK",
                "SWITCH_OVER",
                "MODIFY_SPECIFICATION_ID",
                "RESET_DB_PWD",
                "MODIFY_CONFIGURATION",
                "PAUSE",
                "JUMP_RETRY",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "CONTINUE_JOB",
                "STOP_JOB",
                "CONTINUE_CAPTURE",
                "STOP_CAPTURE",
                "CONTINUE_APPLY",
                "STOP_APPLY",
                "PAY_ORDER",
                "UNSUBSCRIBE",
                "TO_PERIOD",
                "TO_RENEW",
                "ORDER_INFO",
                "CHANGE_FLAVOR",
                 "CLONE"
             ]
         }
      }, {
        "id" : "7686e879-46a4-4d6b-bda9-5540424jb201",
        "name" : "DRS-9272",
        "status" : "CONFIGURATION",
        "description" : "",
        "create_time" : "2020-12-21 16:53:36",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
        "job_action": {
            "available_actions": [
                "CREATE",
                "START",
                "CHANGE",
                "CHOOSE_OBJECT",
                "PRE_CHECK",
                "CHANGE_MODE",
                "FREE_RESOURCE",
                "MODIFY_DB_CONFIG",
                "API_CONFIGURATION_ACTION"
            ],
            "unavailable_actions": [
                "RETRY",
                "RESET",
                "DELETE",
                "QUERY_PRE_CHECK",
                "SWITCH_OVER",
                "MODIFY_SPECIFICATION_ID",
                "RESET_DB_PWD",
                "MODIFY_CONFIGURATION",
                "PAUSE",
                "JUMP_RETRY",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "CONTINUE_JOB",
                "STOP_JOB",
                "CONTINUE_CAPTURE",
                "STOP_CAPTURE",
                "CONTINUE_APPLY",
                "STOP_APPLY",
                "PAY_ORDER",
                "UNSUBSCRIBE",
                "TO_PERIOD",
                "TO_RENEW",
                "ORDER_INFO",
                "CHANGE_FLAVOR",
                 "CLONE"
             ]
         }
      }, {
        "id" : "5b2c2ec8-430e-4de0-937b-9d9547ajb201",
        "name" : "DRS-2899",
        "status" : "RELEASE_RESOURCE_COMPLETE",
        "description" : "",
        "create_time" : "2020-12-21 16:24:24",
        "engine_type" : "mysql",
        "net_type" : "eip",
        "billing_tag" : false,
        "job_direction" : "up",
        "db_use_type" : "sync",
        "task_type" : "FULL_INCR_TRANS",
        "node_newFramework" : false
        "job_action": {
            "available_actions": [
                "CREATE",
                "DELETE",
                "PRE_CHECK",
                "CHANGE_MODE",
                "MODIFY_DB_CONFIG",
                "CLONE"
            ],
            "unavailable_actions": [
                "FREE_RESOURCE",
                "START",
                "CHANGE",
                "CHOOSE_OBJECT",
                "RETRY",
                "RESET",
                "QUERY_PRE_CHECK",
                "SWITCH_OVER",
                "MODIFY_SPECIFICATION_ID",
                "RESET_DB_PWD",
                "MODIFY_CONFIGURATION",
                "PAUSE",
                "JUMP_RETRY",
                "START_INCR",
                "MODIFY_TASK_NUMBER",
                "CONTINUE_JOB",
                "STOP_JOB",
                "CONTINUE_CAPTURE",
                "STOP_CAPTURE",
                "CONTINUE_APPLY",
                "STOP_APPLY",
                "PAY_ORDER",
                "UNSUBSCRIBE",
                "TO_PERIOD",
                "TO_RENEW",
                "ORDER_INFO",
                "CHANGE_FLAVOR"
             ]
         }
      } ],
      "total_record" : 18
    }

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback