OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Migration Service

V4.3.1Enterprise Edition

  • OMS Documentation
  • OMS Introduction
    • Overview of OMS
    • Terms
    • OMS HA
    • Principles of Store
    • Principles of Full-Import and Incr-Sync
    • Data verification principles
    • Architecture
      • Overview
      • Hierarchical functional system
      • Basic components
    • OMS Oracle full migration design and impact
    • Limitations
  • Quick Start
    • Data migration process
    • Data synchronization process
  • Deploy OMS
    • Deployment types
    • System and network requirements
    • Memory and disk requirements
    • Environment preparations
    • Deploy OMS on a single node
    • Deploy OMS on multiple nodes in a single region
    • Deploy OMS on multiple nodes in multiple regions
    • Scale out
    • Scale down deployment
    • Check the deployment
    • Deploy a time-series database (Optional)
  • OMS console
    • Log in to the OMS console
    • Overview
    • User center
      • Configure user information
      • Change your login password
      • Log out
  • Data migration
    • Overview
    • Migrate data from a MySQL database to a MySQL-compatible tenant of OceanBase Database
    • Migrate data from a MySQL-compatible tenant of OceanBase Database to a MySQL database
    • Migrate data from an Oracle database to the MySQL compatible mode of OceanBase Database
    • Migrate data from the Oracle compatible mode of OceanBase Database to an Oracle database
    • Migrate data from an Oracle database to the Oracle compatible mode of OceanBase Database
    • Migrate data from a DB2 LUW database to an Oracle-compatible tenant of OceanBase Database
    • Migrate data from an Oracle-compatible tenant of OceanBase Database to a DB2 LUW database
    • Migrate data from a DB2 LUW database to a MySQL-compatible tenant of OceanBase Database
    • Migrate data from a MySQL-compatible tenant of OceanBase Database to a DB2 LUW database
    • Migrate data between OceanBase databases of the same tenant type
    • Configure a bidirectional synchronization task
    • Migrate data from a TiDB database to a MySQL-compatible tenant of OceanBase Database
    • Migrate data from a PostgreSQL database to the Oracle compatible mode of OceanBase Database
    • Migrate data from a PostgreSQL database to the MySQL compatible mode of OceanBase Database
    • Migrate data from a PolarDB-X 1.0 database to a MySQL-compatible tenant of OceanBase Database
    • Migrate incremental data from an Oracle-compatible tenant of OceanBase Database to a MySQL database
    • Manage data migration tasks
      • View details of a data migration task
      • Rename a data migration task
      • View and modify migration objects
      • Use tags to Manage data migration tasks
      • Perform batch operations on data migration tasks
      • Download and import settings of migration objects
      • View and modify migration parameters
      • Download a conflict log file
      • Start and pause a data migration task
      • End and delete a data migration task
    • Supported DDL operations and limits for synchronization
      • Synchronize DDL operations from a MySQL database to a MySQL-compatible tenant of OceanBase Database
        • Overview of DDL synchronization from MySQL to OceanBase Database's MySQL compatible mode
        • CREATE TABLE
          • Create a table
          • Create a column
          • Create indexes or constraints
          • Create partitions
        • Data type conversion
        • ALTER TABLE
          • Modify tables
          • Operations on columns
          • Operations on constraints and indexes
          • Partition operations
        • TRUNCATE TABLE
        • RENAME TABLE
        • DROP TABLE
        • CREATE INDEX
        • DROP INDEX
        • DDL incompatibilities between a MySQL database and a MySQL-compatible tenant of OceanBase Database
          • Overview
          • Incompatibilities of the CREATE TABLE statement
            • Incompatibilities of CREATE TABLE
            • Column types that are supported to create indexes or constraints
          • Incompatibilities of the ALTER TABLE statement
            • Incompatibilities of ALTER TABLE
            • Change the type of a constrained column
            • Change the type of an unconstrained column
            • Change the length of a constrained column
            • Change the length of an unconstrained column
            • Delete a constrained column
          • Incompatibilities of DROP INDEX operations
      • Synchronize DDL operations from the MySQL compatible mode of OceanBase Database to a MySQL database
      • DDL operations for synchronizing data from an Oracle database to an Oracle-compatible tenant of OceanBase Database
        • Overview of DDL synchronization from Oracle to OceanBase Database Oracle compatible mode
        • CREATE TABLE
          • Overview for CREATE TABLE
          • Create a relational table
            • Create a relational table
            • Define columns of a relational table
          • Virtual columns
          • Regular columns
          • Create partitions
            • Overview for creating partitions
            • Partitioning
            • Subpartitioning
            • Composite partitioning
            • User-defined partitioning
            • Subpartition templates
          • Constraints
            • Overview
            • Inline constraints
            • Out-of-line constraints
        • CREATE INDEX
          • Overview
          • Oracle compatible mode
        • ALTER TABLE
          • Overview
          • Modify, drop, and add table attributes
          • Column attribute management
            • Modify, drop, and add column attributes
            • Rename a column
            • Add columns and column attributes
            • Modify column attributes
            • Drop columns
          • Modify, drop, and add constraints
          • Partition management
            • Modify, drop, and add partitions
            • Drop a partition
            • Drop a subpartition
            • Add partitions and subpartitions
            • Modify partitions
            • Drop partition data
        • DROP TABLE
        • RENAME OBJECT
        • TRUNCATE TABLE
        • DROP INDEX
        • DDL incompatibilities between an Oracle database and an Oracle-compatible tenant of OceanBase Database
          • Overview
          • Incompatibilities of CREATE TABLE
          • Incompatibilities in table modification operations
            • Incompatibilities of ALTER TABLE
            • Change the type of a constrained column
            • Change the type of an unconstrained column
            • Change the length of a constrained column
            • Change the length of an unconstrained column
      • Synchronize DDL operations from the Oracle compatible mode of OceanBase Database to an Oracle database
      • Synchronize DDL operations from a DB2 LUW database to an Oracle-compatible tenant of OceanBase Database
      • Synchronize DDL operations from the Oracle compatible mode of OceanBase Database to a DB2 LUW database
      • Synchronize DDL operations from a DB2 LUW database to a MySQL-compatible tenant of OceanBase Database
      • Synchronize DDL operations from the MySQL compatible mode of OceanBase Database to a DB2 LUW database
      • Synchronize DDL operations between MySQL-compatible tenants of OceanBase Database
      • DDL synchronization between Oracle-compatible tenants of OceanBase Database
      • DDL operations for synchronizing data from a PostgreSQL database to the MySQL compatible mode of OceanBase Database
      • DDL synchronization from PostgreSQL to OceanBase Database in Oracle compatible mode
  • Data synchronization
    • Overview
    • Synchronize data from OceanBase Database to a Kafka instance
    • Synchronize data from OceanBase Database to a RocketMQ instance
    • Synchronize data from OceanBase Database to a DataHub instance
    • Synchronize data from an ODP logical table to a physical table in a MySQL-compatible tenant of OceanBase Database
    • Synchronize data from an ODP logical table to a DataHub instance
    • Synchronize data from an IDB logical table to a MySQL-compatible tenant of OceanBase Database
    • Synchronize data from an IDB logical table to a DataHub instance
    • Synchronize data from a MySQL database to a DataHub instance
    • Synchronize data from an Oracle database to a DataHub instance
    • Manage data synchronization tasks
      • View details of a data synchronization task
      • Change the name of a data synchronization task
      • View and modify synchronization objects
      • Use tags to Manage data synchronization tasks
      • Perform batch operations on data synchronization tasks
      • Download and import the settings of synchronization objects
      • View and modify the parameter configurations of a data synchronization task
      • Start and pause a data synchronization task
      • End and delete a data synchronization task
  • Data validation
    • Overview
    • Create a data validation task
    • Manage data validation tasks
      • View details of a data validation task
      • Change the name of a data validation task
      • View and modify validation objects
      • View and modify validation parameters
      • Manage data validation tasks by using tags
      • Import validation objects
      • Start, stop, and resume a data validation task
      • Clone a data validation task
      • Delete a data validation task
  • Create and manage data sources
    • Create data sources
      • Create an OceanBase data source
        • Create a physical OceanBase data source
        • Create an ODP data source
        • Create an IDB data source
        • Create a public cloud OceanBase data source
        • Create a standalone OceanBase data source
      • Create a MySQL data source
      • Create an Oracle data source
      • Create a TiDB data source
      • Create a Kafka data source
      • Create a RocketMQ data source
      • Create a DataHub data source
      • Create a DB2 LUW data source
      • Create a PostgreSQL data source
      • Create a PolarDB-X 1.0 data source
    • Manage data sources
      • View data source information
      • Copy a data source
      • Edit a data source
      • Delete a data source
    • Create a database user
    • User privileges
    • Enable binlogs for the MySQL database
    • Minimum privileges required when an Oracle database serves as the source
  • OPS & Monitoring
    • O&M overview
    • Go to the overview page
    • Server
      • View server information
      • Update the quota
      • View server logs
      • Manage resource groups
    • Components
      • Store
        • Add a Store component
        • View details of a Store component
        • Update the configurations of a Store component
        • Start and pause a Store component
        • Delete a Store component
      • Incr-Sync
        • View details of an Incr-Sync component
        • Start and pause an Incr-Sync component
        • Migrate an Incr-Sync component
        • Update the configurations of an Incr-Sync component
        • Batch O&M
        • Delete an Incr-Sync component
      • Full-Import
        • View details of a Full-Import component
        • Pause a Full-Import component
        • Rerun and resume a Full-Import component
        • Update the configurations of a Full-Import component
        • Delete a Full-Import component
      • Full-Verification
        • View details of a Full-Verification component
        • Pause a Full-Verification component
        • Rerun and resume a Full-Verification component
        • Update the configurations of a Full-Verification component
      • Incr-Verification
        • View details of the Incr-Verification component
        • Pause an Incr-Verification component
        • Rerun and resume an Incr-Verification component
        • Update an Incr-Verification component
      • Row-Verification
        • View details of a Row-Verification component
    • O&M Task
      • View O&M tasks
      • Skip a task or subtask
      • Retry a task or subtask
    • Parameter Template
      • Overview
      • Task Template
        • Create a task template
        • View and edit task templates
        • Copy and export a task template
        • Delete a task template
      • Component Template
        • Create a component template
        • View and edit component templates
        • Copy and export a component template
        • Delete a component template
      • Component parameters
        • Store component parameters
        • Incr-Sync component parameters
        • Full-Import component parameters
        • Full-Verification component parameters
        • Incr-Verification component parameters
        • Parameters of the Row-Verification component
        • CM component parameters
        • Supervisor component parameters
  • System management
    • Permission Management
      • Overview
      • Manage users
      • Manage departments
    • Alert center
      • View task alerts
      • View system alerts
      • Manage alert settings
    • Associate with OCP
    • System parameters
      • Modify system parameters
      • Modify HA configurations
      • oblogproxy parameters
    • Manage access keys
    • Operation audit
  • Troubleshooting Guide
    • Manage OMS services
    • OMS logs
    • Component O&M
      • O&M operations for the Supervisor component
      • CLI-based O&M for the Connector component
      • O&M operations for the Store component
    • Component tuning
      • Incr-Sync/Full-Import tuning
      • Oracle store tuning
    • Set throttling
    • Store performance diagnostics
  • Reference Guide
    • Features
      • Configure DDL/DML synchronization
      • DDL synchronization scope
      • Rename databases and tables
      • Use SQL conditions to filter data
      • Set the incremental synchronization start timestamp
      • Configure matching rules for migration or synchronization objects
      • Configure matching rules for validation objects
      • Wildcard patterns supported for matching rules
      • Hidden column mechanisms
      • Instructions on schema migration
      • Create and update a heartbeat table
      • Change a topic
      • Column filtering
      • Data formats
    • API Reference
      • Overview
      • CreateProject
      • StartProject
      • StopProject
      • ResumeProject
      • ReleaseProject
      • DeleteProject
      • ListProjects
      • DescribeProject
      • DescribeProjectSteps
      • DescribeProjectStepMetric
      • DescribeProjectProgress
      • DescribeProjectComponents
      • ListProjectFullVerifyResult
      • StartProjectsByLabel
      • StopProjectsByLabel
      • CreateMysqlDataSource
      • CreateOceanBaseDataSource
      • CreateOceanBaseODPDataSource
      • CreatePolarDBDataSource
      • ListDataSource
      • CreateLabel
      • ListAllLabels
      • DeleteDataSource
      • CreateProjectModifyRecords
      • ListProjectModifyRecords
      • StopProjectModifyRecords
      • RetryProjectModifyRecords
      • CancelProjectModifyRecord
      • SubmitPreCheck
      • GetPreCheckResult
      • UpdateProjectConfig
      • Download schema conversion information
      • DownloadConflictData
      • ListConflictData
      • ResetIncrStartTimestamp
      • AdvanceProject
      • DescribeRegions
    • Alert Reference
      • oms_host_down
      • oms_host_down_migrate_resource
      • oms_host_threshold
      • oms_migration_failed
      • oms_migration_delay
      • oms_sync_failed
      • oms_sync_status_inconsistent
      • oms_sync_delay
    • SSO
      • Integrate the OIDC protocol to OMS to implement SSO
      • Integrate the SAML 2.0 protocol to OMS to implement SSO
      • Access Microsoft Entra ID using OMS SAML 2.0
    • OMS error codes
    • SQL statements for querying table objects
    • Create a trigger
    • Change the log level for a PostgreSQL database instance
    • Online DDL tools
    • Supplemental logging in Oracle databases
  • Upgrade Guide
    • Overview
    • Upgrade OMS in single-node deployment mode
    • Upgrade OMS in multi-node deployment mode
    • FAQ
  • FAQ
    • General O&M
      • How do I modify the resource quotas of an OMS container?
      • How do I troubleshoot the OMS server down issue?
      • Deploy InfluxDB for OMS
      • Increase the disk space of the OMS host
    • Task diagnostics
      • How do I troubleshoot common problems with Oracle Store?
      • How do I perform performance tuning for Oracle Store?
      • What do I do when Oracle Store reports an error at the isUpdatePK stack?
      • What do I do when a store does not have data of the timestamp requested by the downstream?
      • What do I do when OceanBase Store failed to access an OceanBase cluster through RPC?
      • How do I use LogMiner to pull data from an Oracle database?
    • OPS & monitoring
      • What are the alert rules?
    • Data synchronization
      • FAQ about synchronization to a message queue
        • What are the strategies for ensuring the message order in incremental data synchronization to Kafka
    • Data migration
      • User privileges
        • What privileges do I need to grant to a user during data migration to or from an Oracle database?
      • Full migration
        • How do I query the ID of a checker?
        • How do I query log files of the Checker component of OMS?
        • How do I query the verification result files of the Checker component of OMS?
        • What do I do if the target table does not exist?
        • What can I do when the full migration failed due to LOB fields?
        • What do I do if garbled characters cannot be written into OceanBase Database V3.1.2?
      • Incremental synchronization
        • How do I skip DDL statements?
        • How do I migrate an Oracle database object whose name exceeds 30 bytes in length?
        • How do I update whitelists and blacklists?
        • What are the application scope and limits of ETL?
    • Installation and deployment
      • How do I upgrade Store?
  • Release Note
    • Release Note
      • Version number rules
      • V4.3
        • OMS V4.3.1
        • OMS V4.3.0
      • V4.2
        • OMS V4.2.5
        • OMS V4.2.4
        • OMS V4.2.3
        • OMS V4.2.2
        • OMS V4.2.1
        • OMS V4.2.0
      • V4.1
        • OMS V4.1.0
      • V4.0
        • OMS V4.0.2
        • OMS V4.0.1
      • V3.4
        • OMS V3.4.0
      • V3.3
        • OMS V3.3.1
        • OMS V3.3.0
      • V3.2
        • OMS V3.2.2
        • OMS V3.2.1
      • V3.1
        • OMS V3.1.0
      • V2.1
        • OMS V2.1.2
        • OMS V2.1.0

Download PDF

OMS Documentation Overview of OMS Terms OMS HA Principles of Store Principles of Full-Import and Incr-Sync Data verification principles Overview Hierarchical functional system Basic components OMS Oracle full migration design and impact Limitations Data migration process Data synchronization process Deployment types System and network requirements Memory and disk requirements Environment preparations Deploy OMS on a single node Deploy OMS on multiple nodes in a single region Deploy OMS on multiple nodes in multiple regions Scale out Scale down deployment Check the deployment Deploy a time-series database (Optional) Log in to the OMS console Overview Configure user information Change your login password Log out Overview Migrate data from a MySQL database to a MySQL-compatible tenant of OceanBase Database Migrate data from a MySQL-compatible tenant of OceanBase Database to a MySQL database Migrate data from an Oracle database to the MySQL compatible mode of OceanBase Database Migrate data from the Oracle compatible mode of OceanBase Database to an Oracle database Migrate data from an Oracle database to the Oracle compatible mode of OceanBase Database Migrate data from a DB2 LUW database to an Oracle-compatible tenant of OceanBase Database Migrate data from an Oracle-compatible tenant of OceanBase Database to a DB2 LUW database Migrate data from a DB2 LUW database to a MySQL-compatible tenant of OceanBase Database Migrate data from a MySQL-compatible tenant of OceanBase Database to a DB2 LUW database Migrate data between OceanBase databases of the same tenant type Configure a bidirectional synchronization task Migrate data from a TiDB database to a MySQL-compatible tenant of OceanBase Database Migrate data from a PostgreSQL database to the Oracle compatible mode of OceanBase Database Migrate data from a PostgreSQL database to the MySQL compatible mode of OceanBase Database Migrate data from a PolarDB-X 1.0 database to a MySQL-compatible tenant of OceanBase Database Migrate incremental data from an Oracle-compatible tenant of OceanBase Database to a MySQL database View details of a data migration task Rename a data migration task View and modify migration objects Use tags to Manage data migration tasks Perform batch operations on data migration tasks Download and import settings of migration objects View and modify migration parameters Download a conflict log file Start and pause a data migration task End and delete a data migration task Synchronize DDL operations from the MySQL compatible mode of OceanBase Database to a MySQL database Synchronize DDL operations from the Oracle compatible mode of OceanBase Database to an Oracle database Synchronize DDL operations from a DB2 LUW database to an Oracle-compatible tenant of OceanBase Database Synchronize DDL operations from the Oracle compatible mode of OceanBase Database to a DB2 LUW database Synchronize DDL operations from a DB2 LUW database to a MySQL-compatible tenant of OceanBase Database Synchronize DDL operations from the MySQL compatible mode of OceanBase Database to a DB2 LUW database Synchronize DDL operations between MySQL-compatible tenants of OceanBase Database DDL synchronization between Oracle-compatible tenants of OceanBase Database DDL operations for synchronizing data from a PostgreSQL database to the MySQL compatible mode of OceanBase Database DDL synchronization from PostgreSQL to OceanBase Database in Oracle compatible mode Overview Synchronize data from OceanBase Database to a Kafka instance Synchronize data from OceanBase Database to a RocketMQ instance Synchronize data from OceanBase Database to a DataHub instance Synchronize data from an ODP logical table to a physical table in a MySQL-compatible tenant of OceanBase Database Synchronize data from an ODP logical table to a DataHub instance Synchronize data from an IDB logical table to a MySQL-compatible tenant of OceanBase Database Synchronize data from an IDB logical table to a DataHub instance Synchronize data from a MySQL database to a DataHub instance Synchronize data from an Oracle database to a DataHub instance View details of a data synchronization task Change the name of a data synchronization task View and modify synchronization objects Use tags to Manage data synchronization tasks Perform batch operations on data synchronization tasks Download and import the settings of synchronization objects View and modify the parameter configurations of a data synchronization task Start and pause a data synchronization task End and delete a data synchronization task Overview Create a data validation task View details of a data validation task Change the name of a data validation task View and modify validation objects View and modify validation parameters Manage data validation tasks by using tags Import validation objects Start, stop, and resume a data validation task Clone a data validation task Delete a data validation task Create a MySQL data source Create an Oracle data source Create a TiDB data source
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Migration Service
  3. V4.3.1
iconOceanBase Migration Service
V 4.3.1Enterprise Edition
Enterprise Edition
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.5
  • V 4.2.4
  • V 4.2.3
  • V 4.0.2
  • V 3.4.0
Community Edition
  • V 4.2.12
  • V 4.2.11
  • V 4.2.10
  • V 4.2.9
  • V 4.2.8
  • V 4.2.7
  • V 4.2.6
  • V 4.2.5
  • V 4.2.4
  • V 4.2.3
  • V 4.2.1
  • V 4.2.0
  • V 4.0.0
  • V 3.3.1

ListProjects

Last Updated:2025-10-21 10:56:45  Updated
share
What is on this page
Purpose
Call description
Limitations
Request path
Request parameters
Response parameters
Examples
Request example
Response example
Appendix
Kafka
DataHub
RocketMQ
OceanBase
TiDB

folded

share

This topic describes the ListProjects operation provided by OceanBase Migration Service (OMS).

Purpose

You can call this operation to query a list of data migration, synchronization, or verification tasks in pagination mode.

Call description

Limitations

This operation is supported in OMS V4.1.0 and later.

Request path

POST /api/v2?Action=ListProjects

Request parameters

Parameter Type Description
searchKey string The name or ID of the data migration, synchronization, or verification task.
type string The type of the task. Valid values: MIGRATION, SYNC, and VERIFY.
status array The states of the data migration, synchronization, or verification tasks to query. Valid values: INIT, RUNNING, SUSPEND, FAILED, FINISHED, RELEASING, RELEASED, DELETED, RUNNING_MODIFYING, RUNNING_MERGING, and RUNNING_ALARMING.
labelIds array The tag IDs. You can specify a maximum of five tag IDs.
sourceEndpointTypes array The types of sources.
sinkEndpointTypes array The types of targets.
visibleSubProject boolean Specifies whether to show subtasks. Default value: false.
sortField string The sorting field. Valid values: gmtCreate and gmtModified. Default value: gmtCreate.
order string The sorting order. Valid values: asc and descend. Default value: descend.
pageNumber integer The current page number. Default value: 1.
pageSize integer The number of entries to return per page. Default value: 10. Maximum value: 150.

Response parameters

Parameter Type Description
success boolean Indicates whether the call is successful.
errorDetail object The error details.
code string The error code.
message string The error description.
advice string The suggestions.
requestId string The ID of the request.
pageNumber integer The number of the page returned, which takes effect in a pagination query.
pageSize integer The number of entries returned on each page, which takes effect in a pagination query.
totalCount integer The total number of pages returned, which takes effect in a pagination query.
cost string The time spent in processing the request, in seconds.
data object [] The information about the tasks. For more information, see the Parameters in data section.
  • Parameters in data

    Parameter Type Description
    id string The ID of the task.
    type string The type of the task. Valid values: MIGRATION, SYNC, and VERIFY.
    name string The name of the task, which cannot contain spaces.
    labels object [] The tags.
    ├─ id string The ID of the tag.
    ├─ name string The name of the tag.
    owner string The owner of the task.
    importance string The alert level of the task. Valid values: HIGH, MEDIUM, LOW, and IGNORE.
    status string The status of the task.
    gmtCreate string The time when the task was created, in the UTC+0 time zone.
    gmtModified string The time when the task was updated, in the UTC+0 time zone.
    gmtStart string The start time of the task.
    gmtFinish string The end time of the task.
    destConnId string The connection ID of the task.
    isMerging boolean Indicates whether the task is in the progress of a major compaction.
    isModifying boolean Indicates whether the task is being modified.
    isSubProject boolean Indicates whether the task is a subtask.
    sourceEndpointType string The type of the source. Valid values: MYSQL, OB_ORACLE, OB_MYSQL, ORACLE, TIDB, DB2_LUW, POSTGRESQL, IDB, and DBP_OP_ROUTE.
    sinkEndpointType string The type of the target. Valid values: MYSQL, OB_ORACLE, OB_MYSQL, ORACLE, DB2_LUW, KAFKA, DATAHUB, and ROCKETMQ.
    transferMapping object This parameter is deprecated. We recommend that you call the DescribeProject operation.
    ├─ mode string The mapping mode for the objects to be transferred. Valid values: SPECIFIC and WILDCARD, which indicate specifying specific objects and matching objects by using a rule, respectively.
    ├─ databases object [] The list of database objects. For more information, see the Parameters in databases/databasesBlack section.
    ├─ databasesBlack object [] The blocklist of database objects used for the WILDCARD mode. For more information, see the Parameters in databases/databasesBlack section.
    ├─ tableAndViewWhiteList array The wildcard-based allowlist of tables and views used for the WILDCARD mode.
    ├─ tableAndViewBlackList array The wildcard-based blocklist of tables and views used for the WILDCARD mode.
    commonTransferConfig object This parameter is deprecated. We recommend that you call the DescribeProject operation.
    ├─ tableCategory string The type of tables to be transferred. Valid values: ALL (all tables), WITH_UNIQUE_ROW_ID (tables with a unique row ID), and WITHOUT_UNIQUE_ROW_ID (tables without a unique row ID). Default value: ALL.
    ├─ activeActive boolean Indicates whether active-active disaster recovery is enabled (deprecated in OMS V4.3.1).
    ├─ mqSerializerType string The JSON data serialization type for delivering data to message queues. Valid values: DEFAULT, CANAL, DATAWORKS_V2, SHAREPLEX, DEFAULT_WITH_SCHEMA, DEBEZIUM, DEBEZIUMFLATTEN, and DEBEZIUMSMT.
    ├─ mqPartitionMode string The partition routing mode for delivering data to message queues. Valid values: ONE, HASH, and TABLE. ONE specifies to deliver data to a specified partition. HASH specifies to deliver data to HASH partitions based on the primary key column or sharding columns. TABLE specifies to deliver data to HASH partitions based on database and table names.
    ├─ mqPartition integer When the value of the partitionMode parameter is ONE, this parameter indicates the location of the partition to which data is delivered in the current topic.
    ├─ datahubTopicType string The type of the topic for delivering data to DataHub. Valid values: TUPLE and BLOB.
    ├─ rocketMqProducerGroup string The name of the producer group. This parameter takes effect when the type of the target is RocketMQ. The default value is OMS.
    ├─ rocketMqMsgTags string The tag of the message. This parameter takes effect when the type of the target is RocketMQ. For example, when the value is default, the _tag suffix is added to the value by default.
    ├─ rocketMqEnableMsgTrace boolean Indicates whether message tracing is enabled. This parameter takes effect when the type of the target is RocketMQ.
    ├─ rocketMqSendMsgTimeout long The message delivery timeout period. This parameter takes effect when the type of the target is RocketMQ.
    ├─ dataWorksBusinessName string The ID of the business system. #### This parameter is required only when the serialization type is DataWorks. The value must be 1 to 20 characters in length.
    ├─ sinkStoreFormat string The storage type for target table objects. Valid values: Default, Row Storage, Column Storage, and Hybrid Row-Column Storage.
    This parameter takes effect if the target is OceanBase Database V4.3.0 or later and you have selected Schema Migration or DDL synchronization for Incremental Synchronization when you specify the migration types.
    ├─ sourceStoreFormat string The storage type for source table objects. Valid values: Default, Row Storage, Column Storage, and Hybrid Row-Column Storage.
    This parameter takes effect if the source is OceanBase Database V4.3.0 or later and you have selected DDL synchronization for Reverse Increment when you specify the migration types.
    enableStructTransfer boolean Indicates whether schema migration is allowed.
    structTransferConfig object This parameter is deprecated. We recommend that you call the DescribeProject operation.
    ├─ byteCharConvertStrategy string The BYTE/CHAR conversion scheme. Valid values: IGNORE_BYTE_IF_BYTE_USED, FORCE_CHAR_IF_BYTE_USED, EXPAND_LEN_IF_BYTE_USED, and DO_NOTHING_IF_BYTE_USED. Default value: DO_NOTHING_IF_BYTE_USED.
    ├─ deferIndexCreation boolean Indicates whether post-indexing is allowed. The default value is false.
    enableFullTransfer boolean Indicates whether full migration is enabled.
    enableFullVerify boolean Indicates whether full verification is enabled.
    fullTransferConfig object This parameter is deprecated. We recommend that you call the DescribeProject operation.
    ├─ nonePkUkTruncateDstTable boolean Indicates whether the target table is cleared during full migration from a table without a unique index.
    ├─ allowDestTableNotEmpty boolean The processing strategy to apply when the target table has records. Valid values: true and false. Setting this parameter to true or false is equivalent to selecting Ignore or Stop Migration for Handle Non-empty Tables in Target Database in the OMS console, respectively.
    • If you set the value to true, OMS ignores the existing data in the target table when writing data to the table. In other words, if a unique key conflict error is returned when data is synchronized from the source table to the target table, OMS will ignore the data in the source table and reserve the data in the target table.

      Notice

      If you set the value to true, data is pulled in IN mode for full verification. In this case, the scenario where the target table contains more data than the source table cannot be verified, and the verification efficiency will be decreased.

    • The value false specifies to stop migration. If the target table has records, an error is returned during full migration. In this case, clear the existing data in the target table and try again.

      Notice

      After an error is returned, if you click Resume in the dialog box, OMS ignores this error and continues to migrate data. Proceed with caution.

    ├─ fullTransferSpeedMode string Full migration speed, including STEADY, NORMAL, FAST, and CUSTOM.
    ├─ fullTransferSpeedConfig string Full migration speed configuration, which takes effect only when fullTransferSpeedMode is set to CUSTOM.
    ├─├─ memory integer Memory limit, in units of GB.
    ├─├─ readerWorkerNum integer Number of read concurrency.
    ├─├─ writerWorkerNum integer Number of write concurrency.
    ├─ fullVerifySpeedMode string Full verification speed, including STEADY, NORMAL, FAST, and CUSTOM.
    ├─ fullVerifySpeedConfig string Full verification speed configuration, which takes effect only when fullVerifySpeedMode is set to CUSTOM.
    ├─├─ memory integer Memory limit, in units of GB.
    ├─├─ readerWorkerNum integer Number of concurrent reads.
    ├─├─ writerWorkerNum integer Number of write concurrency.
    ├─ throttleRps integer The maximum allowed RPS for full migration, in terms of records per second. Set this parameter to null to specify not to limit the RPS.
    ├─ throttleIOPS integer The maximum allowed IOPS for full migration, in terms of bytes per second. Set this parameter to null to specify not to limit the IOPS.
    enableIncrTransfer boolean Indicates whether incremental synchronization is enabled.
    enableIncrVerify boolean Indicates whether incremental verification is enabled.
    enableReverseIncrTransfer boolean Indicates whether reverse increment is enabled.
    incrTransferConfig object This parameter is deprecated. We recommend that you call the DescribeProject operation.
    ├─ startTimestamp long The start timestamp for incremental synchronization. This parameter is available only when incremental synchronization is enabled and full migration is disabled.
    ├─ recordTypeWhiteList array The data types of incremental data synchronized in incremental synchronization. Supported data types are HEARTBEAT, INSERT, UPDATE, DELETE, BEGIN, COMMIT, ROLLBACK, DDL, and ROW.
    ├─ storeLogKeptHour integer The retention period of logs when incremental synchronization is enabled and the Store component is used to pull incremental logs. Unit: hours. The default retention period is seven days. The maximum retention period is 365 days.
    ├─ enableSequencingWithinTxn boolean Indicates whether intra-transaction sequencing is enabled when incremental synchronization is enabled and the Store component is used to pull incremental logs.
    ├─ incrSyncConcurrency integer The number of threads for incremental synchronization. Default value: 64.
    ├─ enableIncrSyncStatistics boolean Indicates whether statistics collection is enabled for incremental DML and DDL operation records.
    ├─ incrOnlineDdlConfig array The online DDL tool. Valid values: GH_OST, PT_OSC, and ALIYUN_DMS, representing the tools gh-ost, pt-osc, and Alibaba Cloud Data Management Service (DMS), respectively.
    • If this parameter takes effect on forward incremental synchronization from a MySQL database to a MySQL-compatible tenant of OceanBase Database.
    • If this parameter takes effect on reverse incremental synchronization from a MySQL-compatible tenant of OceanBase Database to a MySQL database.
    ├─ incrLogPullSpeedMode string The incremental log pull speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM (custom).
    ├─ incrLogPullSpeedConfig object The incremental log pull resource configuration, which takes effect only when incrLogPullSpeedMode is set to CUSTOM.
    ├─├─ memory integer The memory limit for incremental log pull.
    ├─ incrLogSyncSpeedMode string The incremental data write speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM (custom).
    ├─ incrLogSyncSpeedConfig object The incremental data write resource configuration, which takes effect only when incrLogSyncSpeedMode is set to CUSTOM.
    ├─├─ memory integer The memory limit for incremental log write.
    ├─├─ writerWorkerNum integer The number of concurrent workers for incremental log write.
    ├─ throttleRps integer The maximum transmission rate allowed in the incremental synchronization phase, in terms of records per second. Set this parameter to null to specify not to limit the RPS.
    ├─ throttleIOPS integer The maximum transmission traffic allowed in the incremental synchronization phase, in terms of bytes per second. Set this parameter to null to specify not to limit the IOPS.
    ├─ supportDDLTypes array The supported DDL types.
    • CREATE_TABLE
    • ALTER_TABLE
    • DROP_TABLE
    • RENAME_TABLE
    • TRUNCATE_TABLE
    • CREATE_INDEX
    • DROP_INDEX
    reverseIncrTransferConfig object The reverse incremental synchronization configuration.
    ├─ startTimestamp string The start timestamp for reverse incremental synchronization. This parameter is supported only when incremental synchronization is enabled but full migration is not.
    ├─ recordTypeWhiteList array The data types of incremental data to be synchronized when reverse incremental synchronization is enabled. Valid values: HEARTBEAT, INSERT, UPDATE, DELETE, BEGIN, COMMIT, ROLLBACK, DDL, and ROW.
    ├─ storeLogKeptHour integer The log retention period in hours when reverse incremental synchronization is enabled and the Store component is used to pull incremental logs. The default value is 7, indicating one week, and the maximum value is 365.
    ├─ enableSequencingWithinTxn boolean Indicates whether intra-transaction sequencing is enabled when reverse incremental synchronization is enabled and the Store component is used to pull incremental logs.
    ├─ enableIncrSyncStatistics boolean Indicates whether to enable statistics collection for reverse incremental records (DML and DDL).
    ├─ incrOnlineDdlConfig array The online DDL tool. Valid values: GH_OST, PT_OSC, and ALIYUN_DMS, representing the tools gh-ost, pt-osc, and Alibaba Cloud Data Management Service (DMS), respectively.
    • This parameter takes effect on forward incremental synchronization from a MySQL database to a MySQL-compatible tenant of OceanBase Database.
    • This parameter takes effect on reverse incremental synchronization from a MySQL-compatible tenant of OceanBase Database to a MySQL database.
    ├─ incrSyncConcurrency integer The number of threads for reverse incremental synchronization. Default value: 64.
    ├─ incrLogPullSpeedMode string The reverse incremental log pull speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM (custom).
    ├─ incrLogPullSpeedConfig object The reverse incremental log pull resource configuration, which takes effect only when incrLogPullSpeedMode is set to CUSTOM.
    ├─├─ memory integer The memory limit for reverse incremental log pull.
    ├─ incrLogSyncSpeedMode string The reverse incremental data write speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM (custom).
    ├─ incrLogSyncSpeedConfig object The reverse incremental data write resource configuration, which takes effect only when incrLogSyncSpeedMode is set to CUSTOM.
    ├─├─ memory integer The memory limit for reverse incremental data write.
    ├─├─ writerWorkerNum integer The number of concurrent workers for reverse incremental data write.
    ├─ throttleRps integer The maximum allowed RPS for reverse increment, in terms of records per second. Set this parameter to null to specify not to limit the RPS.
    ├─ throttleIOPS integer The maximum transmission traffic allowed for reverse increment, in terms of bytes per second. Set this parameter to null to specify not to limit the IOPS.
    ├─ supportDDLTypes array The supported DDL types.
    • CREATE_TABLE
    • ALTER_TABLE
    • DROP_TABLE
    • RENAME_TABLE
    • TRUNCATE_TABLE
    • CREATE_INDEX
    • DROP_INDEX
    sourceConnectInfo object The connection information of the source.
    ├─ id string The ID of the connection.
    ├─ endpointName string The name of the endpoint.
    ├─ endpointId string The ID of the endpoint.
    ├─ endpointSide string The type of the endpoint. Valid values: source and dest.
    ├─ dbEngine string The database engine of the endpoint.
    ├─ connectionInfo string The connection information of the endpoint.
    ├─ username string The username used to connect to the database.
    ├─ version string The version of the database.
    ├─ timezone string The time zone of the database.
    ├─ charset string The character set.
    ├─ nlsLengthSemantics string This attribute is available only when the data source is an Oracle database or an Oracle-compatible tenant of OceanBase Database.
    ├─ operatingSystem string The operating system. This parameter is unavailable for OceanBase Database.
    ├─ region string The region.
    ├─ ocpName string The name of the OceanBase Cloud Platform (OCP) instance.
    ├─ connExtraAttributes object The additional attributes of the connection. For more information about the nested response parameters, see Appendix.
    ├─ owner string The owner.
    ├─ host string The IP address.
    ├─ port integer The port number.
    sinkConnectInfo object The connection information of the target.
    ├─ id string The ID of the connection.
    ├─ endpointName string The name of the endpoint.
    ├─ endpointId string The ID of the endpoint.
    ├─ endpointSide string The type of the endpoint. Valid values: source and dest.
    ├─ dbEngine string The database engine of the endpoint.
    ├─ connectionInfo string The connection information of the endpoint.
    ├─ username string The username used to connect to the database.
    ├─ version string The version of the database.
    ├─ timezone string The time zone of the database.
    ├─ charset string The character set.
    ├─ nlsLengthSemantics string This attribute is available only when the data source is an Oracle database or an Oracle-compatible tenant of OceanBase Database.
    ├─ operatingSystem string The operating system. This parameter is unavailable for OceanBase Database.
    ├─ region string The region.
    ├─ ocpName string The name of the OCP instance.
    ├─ connExtraAttributes object The additional attributes of the connection. For more information about the nested response parameters, see Appendix.
    ├─ owner string The owner.
    ├─ host string The IP address.
    ├─ port integer The port number.
    steps object [] The steps.
    ├─ order integer The sequence number of the step.
    ├─ name string The name of the step.
    ├─ description string The description of the step.
    ├─ status string The status of the step.
    ├─ extraInfo object The additional information. For more information, see the Parameters in extraInfo section.
    ├─ startTime string The start time of the step, in the UTC+0 time zone.
    ├─ finishTime string The end time of the step, in the UTC+0 time zone.
    ├─ progress integer The progress of the step.
    ├─ stepInfo object The execution details of each step. For more information, see DescribeProjectSteps.
    extraInfo object This parameter is deprecated. We recommend that you call the DescribeProject operation.
    ├─ runningStep string The step in the Running state.
    ├─ runningProgress integer The progress of the step in the Running state.
    ├─ monitoringIncr boolean Indicates whether incremental data monitoring is started.
    ├─ subtopics string The subtopics of the store associated with the task.
    ├─ reverseSubtopics string The subtopics of the reverse store associated with the task.
    ├─ logServiceStartCheckpoint integer The start timestamp.
    ├─ sourceStoreKeptHour integer The retention period of logs.
    ├─ syncDelay integer The delay of incremental synchronization.
    ├─ syncDelaySampleTimestamp integer The timestamp when the synchronization delay is collected, in seconds.
    ├─ accessObSource boolean Indicates whether to allow direct connection to the source OceanBase database.
    ├─ overwriteConfig boolean Indicates whether the overwriting of all new configurations is allowed.
    ├─ ignoreUnsupportDdl boolean Indicates whether unsupported DDL statements are ignored.
    ├─ subDbs map The table configurations of different downstream consumers. This parameter is used for combining configurations when the data synchronization task is reused.
    ├─ subConds map The configuration objects.
    ├─ subIds map The IDs of the configuration objects.
    ├─ maxConnectorCount integer The maximum number of connectors. The value -1 indicates that the number of connectors is not limited.
    ├─ storeIncr boolean Indicates whether incremental data is saved.
    ├─ incrSyncTimestamp integer The current timestamp for incremental synchronization, in seconds.
    alarmStats object The alert statistics.
    ├─ target string The object for which the alert is generated.
    ├─ alarming boolean Indicates whether alerts exist in the system.
    ├─ recentlyTriggerCount integer The total number of recent alert messages.
    ├─ ruleToRecentlyTriggerCount map The number of recent alert messages by rule.
    ├─ alarmContent string The content of recent alert messages.
  • Parameters in databases/databasesBlack

    Parameter Type Description
    mappedName string The name of the target database.
    name string The name of the source database.
    id string The ID of the database.
    tables array The settings for the table objects to be transferred in the current database. When the value of the mode parameter is WILDCARD, this parameter indicates the settings for a specific blocklist or allowlist of tables and views.
    ├─ mappedName string The mapped-to table name.
    ├─ name string The name of the table.
    ├─ id string The ID of the table.
    ├─ whereClause string The WHERE clause in the standard SQL syntax that is used to configure row filters.
    ├─ filterColumns array The filter columns.
    ├─ shardColumns array The sharding columns.
    ├─ columns For more information, see Parameters in columns.
    views array The settings for the view objects to be transferred in the current database.
    ├─ mappedName string The mapped-to view name.
    ├─ name string The name of the view.
    ├─ id string The ID of the view.
    ├─ whereClause string The WHERE clause in the standard SQL syntax that is used to configure row filters.
    ├─ filterColumns array The filter columns.
    ├─ shardColumns array The sharding columns.
    ├─ columns object [] The columns to be transferred. For more information, see Parameters in columns.
    specificTables array The settings for the matched table objects. When the value of the mode parameter is WILDCARD, this parameter indicates the renaming and row filtering settings for the matched table objects.
    ├─ mappedName string The mapped-to table name.
    ├─ name string The name of the table.
    ├─ id string The ID of the table.
    ├─ whereClause string The WHERE clause in the standard SQL syntax that is used to configure row filters.
    ├─ filterColumns array The filter columns.
    ├─ shardColumns array The sharding columns.
    ├─ columns object [] The columns to be transferred. For more information, see Parameters in columns.
    specificViews array The settings for the matched view objects. When the value of the mode parameter is WILDCARD, this parameter indicates the renaming settings for the matched view objects.
    ├─ mappedName string The mapped-to view name.
    ├─ name string The name of the view.
    ├─ id string The ID of the view.
    ├─ whereClause string The WHERE clause in the standard SQL syntax that is used to configure row filters.
    ├─ filterColumns array The filter columns.
    ├─ shardColumns array The sharding columns.
    ├─ columns object [] The columns to be transferred. For more information, see Parameters in columns.
  • Parameters in columns

    Parameter Type Description
    columnName string The name of the column.
    mappedName string The mapped-to column name.
    position integer The position of the column.
    columnType string The type of the column.
    recordFieldType string The extension of the column type.
    rawColumnType string The original string of the column type recorded in the database.
    columnKey string The type of the index.
    nullable boolean Indicates whether null values are supported.
    defaultValue string The default value.
    dataLength integer The length of the column.
    dataPrecision integer The precision of the column.
    dataScale integer The number of decimal places.
    encoding string The character encoding format for the column.
    columnComment string The comment on the column.
    isGenerateField boolean Indicates whether the column is a hidden column.
  • Parameters in extraInfo

    Parameter Type Description
    errorDetails array The error details.
    errorCode string The error code.
    errorMsg string The error message.
    errorParam object The error-related parameters.
    failedTime string The time when the error occurred.

Examples

Request example

{
    "searchKey":"j_oms41_ob",
    "type":"MIGRATION",
    "status":[
        "RUNNING"
    ],
    "labelIds":[
        "l_4w****wygjk"
    ],
    "sourceEndpointTypes":[
        "OB_MYSQL"
    ],
    "sinkEndpointTypes":[

    ],
    "visibleSubProject":false,
    "sortField":"gmtCreate",
    "order":"asc",
    "pageNumber":1,
    "pageSize":5
}

Response example

{
    "success":"true",
    "errorDetail":null,
    "code":null,
    "message":null,
    "advice":null,
    "requestId":"e8dec2fe-40****",
    "pageNumber":"1",
    "pageSize":"5",
    "totalCount":"151",
    "cost":"54 ms",
    "data":[
        {
            "id":"np_4w****",
            "type":"MIGRATION",
            "name":"j_oms4****9_56_obo",
            "labels":[
                {
                    "id":"l_***",
                    "name":"boq***"
                }
            ],
            "owner":"oms_api_te***",
            "importance":"LOW",
            "status":"RUNNING",
            "gmtCreate":"2023-07-13T06:26:15",
            "gmtModified":"2023-07-13T07:01:27",
            "gmtStart":"2023-07-13T07:01:27",
            "gmtFinish":null,
            "destConnId":null,
            "isMerging":false,
            "isModifying":false,
            "isSubProject":false,
            "sourceEndpointType":"OB_MYSQL",
            "sinkEndpointType":"MYSQL",
            "enableStructTransfer":true,
            "enableFullTransfer":true,
            "enableFullVerify":true,
            "enableIncrTransfer":true,
            "enableIncrVerify":false,
            "enableReverseIncrTransfer":true,
            "sourceConnectInfo":{
                "id":"c_4w3aq****",
                "endpointName":"ration12****0obmysql4116892***",
                "endpointId":"e_4w3al***",
                "endpointSide":null,
                "dbEngine":"OB_MYSQL_PUBLIC",
                "connectionInfo":null,
                "username":"oms931mys**",
                "version":"5.7.27-log",
                "timezone":"UTC",
                "charset":"utf8mb4",
                "nlsLengthSemantics":null,
                "operatingSystem":"Linux",
                "region":"cn-beijing",
                "ocpName":"",
                "connExtraAttributes":null,
                "owner":"oms_api_te***",
                "host":"xxx.xxx.xxx.1",
                "port":"2883"
            },
            "sinkConnectInfo":{
                "id":"c_4w3akx***",
                "endpointName":"ation129***9apimysql5616****",
                "endpointId":"e_4w3aic***",
                "endpointSide":null,
                "dbEngine":"MYSQL_PUBLIC",
                "connectionInfo":null,
                "username":"oms**obmys**",
                "version":"2.2.77",
                "timezone":"+08:00",
                "charset":"utf8mb4",
                "nlsLengthSemantics":null,
                "operatingSystem":null,
                "region":"cn-anhui",
                "ocpName":"107",
                "connExtraAttributes":null,
                "owner":"oms_api_te***",
                "host":"xxx.xxx.xxx.2",
                "port":"2883"
            },
            "steps":[
                {
                    "order":"1",
                    "name":"TRANSFER_PRECHECK",
                    "description":"Precheck",
                    "status":"FINISHED",
                    "extraInfo":{
                        "errorDetails":null,
                        "errorCode":null,
                        "errorMsg":null,
                        "errorParam":null,
                        "failedTime":null
                    },
                    "startTime":null,
                    "finishTime":null,
                    "progress":100,
                    "stepInfo":{

                    }
                }
            ],
            "extraInfo":{
                "errorDetails":null,
                "errorCode":null,
                "errorMsg":null,
                "errorParam":null,
                "failedTime":null
            },
            "alarmStats":{
                "target":null,
                "alarming":false,
                "recentlyTriggerCount":null,
                "ruleToRecentlyTriggerCount":null,
                "alarmContent":null
            }
        }
    ]
}

Appendix

Kafka

{
    "connExtraAttributes":{
        "endpoint":"xxx.xxx.xxx.1:2883",
        "username":null,
        "enableSSL":null,
        "enableSASL":null,
        "saslMechanism":null,
        "disableIdentificationAlgorithm":false
    }
}
Parameter Type Description
endpoint string The service endpoint.
username string The username. This parameter is required when the authentication method is PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512.
enableSSL boolean Indicates whether SSL authentication is enabled. If you want to enable SSL authentication, you must upload an SSL certificate.
enableSASL boolean Indicates whether SASL authentication is enabled.
saslMechanism KafkaSaslMechanisnEnum The encryption method. Valid values: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, and KERBEROS.
disableIdentificationAlgorithm boolean Indicates whether hostname verification is enabled during SSL encryption.

DataHub

{
    "connExtraAttributes":{
        "endpoint":"xxx.xxx.xxx.1:2883",
        "project":"detx***"
    }
}
Parameter Type Description
endpoint string The service endpoint.
project string The name of the task.

RocketMQ

{
    "connExtraAttributes":{
        "endpoint":"xxx.xxx.xxx.1:2883",
        "endpointType":null,
        "version":null
    }
}
Parameter Type Description
endpoint string The service endpoint.
endpointType CloudRocketMQEndpoint.Type The type of the service endpoint.
version CloudRocketMQInst.Version The version of RocketMQ.

OceanBase

{
    "connExtraAttributes":{
        "cluster":"xgez***",
        "tenant":"gexr**",
        "isLogicSource":false,
        "useLogProxy":true,
        "drcUser":"tes***",
        "configUrl":"http://xxx.xxx.xxx.1:2883/service****",
        "logProxyIp":"xxx.xxx.xxx.2",
        "logProxyPort":2883,
        "noUserAuth":false
    }
}
Parameter Type Description
cluster string The name of the cluster.
tenant string The name of the tenant.
isLogicSource boolean Indicates whether the data source is a logical data source.
useLogProxy boolean Indicates whether the oblogproxy service is used.
drcUser string The configuration of drc_user.
configUrl string The actual IP address of the server that runs the OceanBase database.
logProxyIp string The IP address of the oblogproxy service.
logProxyPort integer The port number of the oblogproxy service.
noUserAuth boolean When you synchronize data to DataWorks, OMS automatically generates a data source. The username and password are required for connecting to OceanBase Database.

TiDB

{
    "connExtraAttributes":{
        "kafkaId":"e_edz****",
        "kafkaTopic":"test**",
        "kafkaName":"denz***"
    }
}
Parameter Type Description
kafkaId string The ID of the bound Kafka data source.
kafkaTopic string The name of the bound Kafka topic.
kafkaName string The name of the bound Kafka data source.

Previous topic

DeleteProject
Last

Next topic

DescribeProject
Next
What is on this page
Purpose
Call description
Limitations
Request path
Request parameters
Response parameters
Examples
Request example
Response example
Appendix
Kafka
DataHub
RocketMQ
OceanBase
TiDB