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.2.4Enterprise Edition

  • OMS Documentation
  • OMS Introduction
    • What is 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 data 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
    • Integrate the OIDC protocol to OMS to implement SSO
    • Scale out
    • 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 a MySQL-compatible tenant of OceanBase Database
    • Migrate data from an Oracle-compatible tenant of OceanBase Database to an Oracle database
    • Migrate data from an Oracle database to an Oracle-compatible tenant of OceanBase Database
    • Migrate data from a DB2 LUW database to an Oracle-compatible 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 within OceanBase Database
    • Create an active-active disaster recovery task in OceanBase Database
    • Migrate data from a TiDB database to a MySQL-compatible tenant of OceanBase Database
    • Migrate data from a PostgreSQL database to a MySQL-compatible tenant 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 the parameter configurations of a data migration task
      • Start and pause a data migration task
      • Release 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
        • CREATE TABLE
          • Create a table
          • Create a column
          • Create an index or a constraint
          • Create partitions
        • Data type conversion
        • ALTER TABLE
          • Modify a table
          • Operations on columns
          • Operations on constraints and indexes
          • Operations on partitions
        • 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 a MySQL-compatible tenant 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 an Oracle-compatible tenant of OceanBase Database
        • CREATE TABLE
          • Overview
          • Create a relational table
            • Create a relational table
            • Define columns of a relational table
          • Virtual columns
          • Regular columns
          • Create partitions
            • Overview
            • Partitioning
            • Subpartitioning
            • Composite partitioning
            • User-defined partitioning
            • Subpartition templates
          • Constraints
            • Overview
            • Inline constraints
            • Out-of-line constraints
        • CREATE INDEX
          • Overview
          • Normal indexes
        • ALTER TABLE
          • Modify tables
          • 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 partitions
            • Drop subpartitions
            • Add partitions and subpartitions
            • Modify partitions
            • Truncate partitions
        • 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
      • DDL synchronization from an Oracle-compatible tenant 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 an Oracle-compatible tenant 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 a MySQL-compatible tenant of OceanBase Database to a DB2 LUW database
      • DDL synchronization between MySQL-compatible tenants of OceanBase Database
      • DDL synchronization between Oracle-compatible tenants of OceanBase Database
  • 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 physical table in 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
      • Release and delete a data synchronization 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 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
    • Components
      • Store
        • Create a store
        • View details of a store
        • Update the configurations of a store
        • Start and pause a store
        • Delete a store
      • 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
        • Delete a Full-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 parameters
        • Incr-Sync parameters
        • Full-Import parameters
        • Full-Verification parameters
        • CM parameters
        • Supervisor 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
    • 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
      • Supported DDL operations for synchronization
      • Rename a migration or synchronization object
      • Use SQL conditions to filter data
      • Set an incremental synchronization timestamp
      • Configure matching rules
      • Wildcard patterns supported for matching rules
      • Hidden column mechanisms
      • Instructions on schema migration
      • Create and update a heartbeat table
      • Change the 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
    • 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
    • OMS error codes
    • SQL statements for querying table objects
    • Create a trigger
    • Change the log level for a PostgreSQL instance
    • Online DDL tools
    • Oracle supplemental logging
  • 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 destination 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
    • V4.2
      • 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 What is 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 data 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 Integrate the OIDC protocol to OMS to implement SSO Scale out 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 a MySQL-compatible tenant of OceanBase Database Migrate data from an Oracle-compatible tenant of OceanBase Database to an Oracle database Migrate data from an Oracle database to an Oracle-compatible tenant of OceanBase Database Migrate data from a DB2 LUW database to an Oracle-compatible 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 within OceanBase Database Create an active-active disaster recovery task in OceanBase Database Migrate data from a TiDB database to a MySQL-compatible tenant of OceanBase Database Migrate data from a PostgreSQL database to a MySQL-compatible tenant 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 the parameter configurations of a data migration task Start and pause a data migration task Release and delete a data migration task Synchronize DDL operations from a MySQL-compatible tenant of OceanBase Database to a MySQL database DDL synchronization from an Oracle-compatible tenant 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 an Oracle-compatible tenant 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 a MySQL-compatible tenant of OceanBase Database to a DB2 LUW database DDL synchronization between MySQL-compatible tenants of OceanBase Database DDL synchronization between Oracle-compatible tenants of OceanBase Database 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 physical table in 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 Release and delete a data synchronization task 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 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 O&M overview
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.2.4
iconOceanBase Migration Service
V 4.2.4Enterprise 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.13
  • 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:2026-04-14 07:36:49  Updated
share
What is on this page
Purpose
Call description
Limitations
Request path
Request parameters
Response parameters
Examples
Sample request
Return example
Appendix
Kafka
DataHub
RocketMQ
OceanBase
TiDB

folded

share

This topic describes the OpenAPI provided by OceanBase Migration Service (OMS): ListProjects, which is used to list projects in a paged manner.

Purpose

This interface is used to query data migration or synchronization tasks in a paginated manner on the task list page.

Call description

Limitations

This interface applies to 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 a data migration or synchronization task.
type string The type of the task. Valid values: MIGRATION (indicating a data migration task) and SYNC (indicating a data synchronization task).
status array The status of a data migration or synchronization task. Valid values: INIT (indicates that the task is not started), RUNNING (indicates that the task is in progress), SUSPEND (indicates that the task is suspended), FAILED (indicates that the task has failed), FINISHED (indicates that the task is completed), RELEASING (indicates that the task is being released), RELEASED (indicates that the task has been released), DELETED (indicates that the task has been deleted), RUNNING_MODIFYING (indicates that the task is being modified), RUNNING_MERGING (indicates that the task is being merged), and RUNNING_ALARMING (indicates that the task is generating an alert).
labelIds array A collection of label IDs. You can specify up to five label IDs.
sourceEndpointTypes array A collection of types of source data sources.
sinkEndpointTypes array A collection of types of destination data sources.
visibleSubProject boolean Specifies whether to display subtasks. The default is false, indicating that subtasks are not displayed.
sortField string The field for sorting. Valid values: gmtCreate and gmtModified. The default is gmtCreate.
order string The order for sorting. Valid values: asc (ascending) and descend (descending). The default is descend.
pageNumber integer The current page number. The default is 1.
pageSize integer The number of records per page. The default is 10, with a maximum of 150.

Response parameters

Parameter Type Description
success boolean Whether the call is successful.
errorDetail object Error details.
code string Error code.
message string Error description.
advice string Suggestion.
requestId string Request ID.
pageNumber integer Page number, which takes effect when paged queries are performed.
pageSize integer Page size, which takes effect when paged queries are performed.
totalCount integer Total number of records, which takes effect when paged queries are performed.
cost string Request latency in seconds.
data object [] Task list information. For more information about the data in this field, see "Parameters in data".
  • Parameters in data

    Parameter Type Description
    id string Task ID.
    type string Task type, which can be MIGRATION (indicating a data migration task) or SYNC (indicating a data synchronization task).
    name string Task name, which must not contain spaces.
    labels object [] Tag set.
    ├─ id string Tag ID.
    ├─ name string Tag name.
    owner string Task owner.
    importance string Task alert level, which can be HIGH, MEDIUM, LOW, or IGNORE.
    status string Task status.
    gmtCreate string Task creation time, which is displayed in the UTC + 0 time zone.
    gmtModified string Task modification time, which is displayed in the UTC + 0 time zone.
    gmtStart string Task start time.
    gmtFinish string Task end time.
    destConnId string Task connection ID.
    isMerging boolean Whether the task is in the merging state.
    isModifying boolean Whether the task is in the modification state.
    isSubProject boolean Whether it is a sub-project.
    sourceEndpointType string Source data source type, which can be MYSQL, OB_ORACLE, OB_MYSQL, ORACLE, TIDB, DB2_LUW, POSTGRESQL, IDB, or DBP_OP_ROUTE.
    sinkEndpointType string Target data source type, which can be MYSQL, OB_ORACLE, OB_MYSQL, ORACLE, DB2_LUW, KAFKA, DATAHUB, or ROCKETMQ.
    transferMapping object This parameter is deprecated. We recommend that you call the DescribeProject interface.
    ├─ mode string Transmission object mapping mode, which can be SPECIFIC (indicating specified objects) or WILDCARD (indicating matching rules).
    ├─ databases object [] Database object list. For more information, see "Parameters in databases/databasesBlack".
    ├─ databasesBlack object [] Matching rules mode: database object black list. For more information, see "Parameters in databases/databasesBlack".
    ├─ tableAndViewWhiteList array Matching rules mode: wildcard whitelist of tables and views.
    ├─ tableAndViewBlackList array Matching rules mode: wildcard black list of tables and views.
    commonTransferConfig object This parameter is deprecated. We recommend that you call the DescribeProject interface.
    ├─ tableCategory string Type of tables to be transmitted. Valid values: ALL (all tables), WITH_UNIQUE_ROW_ID (tables with unique row identifiers), and WITHOUT_UNIQUE_ROW_ID (tables without unique row identifiers). Default value: ALL.
    ├─ activeActive boolean Whether it is a disaster recovery dual-active scenario.
    ├─ mqSerializerType string JSON serialization type when data is delivered to a message queue. Valid values: DEFAULT, CANAL, DATAWORKS_V2, SHAREPLEX, DEFAULT_WITH_SCHEMA, DEBEZIUM, DEBEZIUMFLATTEN, and DEBEZIUMSMT.
    ├─ mqPartitionMode string Partition routing mode when data is delivered to a message queue. Valid values: ONE (specify the partition to deliver data to), HASH (partition data based on the primary key or the value of the partitioning column), and TABLE (partition data based on the database and table name).
    ├─ mqPartition integer When partitionMode is ONE, this parameter indicates the position of the partition in the current topic.
    ├─ datahubTopicType string Topic type when data is delivered to a DataHub instance. Valid values: TUPLE and BLOB.
    ├─ rocketMqProducerGroup string Name of the target RocketMQ instance. If the target is a RocketMQ instance, the default value is OMS.
    ├─ rocketMqMsgTags string Tags of messages sent to the target RocketMQ instance. The default value is default_tag, which means that when the value of this parameter is default, _tag is appended to the value.
    ├─ rocketMqEnableMsgTrace boolean Whether to enable message tracing, which takes effect only when the target is a RocketMQ instance.
    ├─ rocketMqSendMsgTimeout long Message delivery timeout, which takes effect only when the target is a RocketMQ instance.
    ├─ dataWorksBusinessName string Business system identifier. This parameter identifies the source of the business system for your future custom processing. This parameter is supported only when the serialization format is DataWorks. The length of the value of this parameter must be 1 to 20 characters.
    ├─ sinkStoreFormat string Storage type of the destination table object. Valid values: Default, Row storage, Column storage, and Hybrid columnar storage.
    When the source is OceanBase Database V4.3.0 or later and you select Schema Migration or Incremental Synchronization > DDL synchronization as the migration type, this parameter becomes effective for OceanBase Database V4.3.0 or later.
    ├─ sourceStoreFormat string Storage type of the source table object. Valid values: Default, Row storage, Column storage, and Hybrid columnar storage.
    When the source is OceanBase Database V4.3.0 or later and you select Reverse Increment > DDL synchronization as the migration type, this parameter becomes effective for OceanBase Database V4.3.0 or later.
    enableStructTransfer boolean Whether to allow schema transmission.
    structTransferConfig object This parameter is deprecated. We recommend that you call the DescribeProject interface.
    ├─ byteCharConvertStrategy string Byte/char conversion strategy. Valid values: IGNORE_BYTE_IF_BYTE_USED (ignore bytes if bytes are used), FORCE_CHAR_IF_BYTE_USED (forcefully convert bytes to characters if bytes are used), EXPAND_LEN_IF_BYTE_USED (expand the length if bytes are used), and DO_NOTHING_IF_BYTE_USED (do not perform any operation if bytes are used). Default value: DO_NOTHING_IF_BYTE_USED.
    ├─ deferIndexCreation boolean Whether to allow index postcreation. The default value is false.
    enableFullTransfer boolean Whether to enable full transmission.
    enableFullVerify boolean Whether to enable full verification.
    fullTransferConfig object This parameter is deprecated. We recommend that you call the DescribeProject interface.
    ├─ nonePkUkTruncateDstTable boolean Whether to truncate the destination table when the source table does not have a unique index.
    ├─ allowDestTableNotEmpty boolean Strategy to be adopted when the destination table contains records. Valid values: Ignore and Stop Migration.
    • If set to true, the ignore strategy is adopted when the destination table contains data. In this case, OMS adopts the ignore strategy for data writing. That is, when data conflicts with the unique key in the destination table, the source data is not synchronized, and the data in the destination table is retained.

      Notice

      If you set this parameter to Ignore, full verification will use the IN mode to pull data, which cannot verify whether the destination table contains data that does not exist in the source table. The performance of verification will also be downgraded to some extent.

    • If set to false, migration is stopped when the destination table contains data. In this case, full migration will fail and you must process the data in the destination table before continuing the migration.

      Notice

      If an error occurs, and you click Resume, OMS will ignore this parameter and continue to migrate table data. Proceed with caution.

    ├─ fullTransferSpeedMode string Full transmission concurrency speed. Valid values: STEADY, NORMAL, and FAST.
    ├─ fullVerifySpeedMode string Full verification concurrency speed. Valid values: STEADY, NORMAL, and FAST.
    ├─ throttleRps integer Maximum transmission rate in records per second that can be achieved in the full transmission phase. Input null to indicate no restriction.
    ├─ throttleIOPS integer Maximum transmission traffic in bytes per second that can be achieved in the full transmission phase. Input null to indicate no restriction.
    enableIncrTransfer boolean Whether to enable incremental synchronization.
    enableIncrVerify boolean Whether to enable incremental verification.
    enableReverseIncrTransfer boolean Whether to enable reverse incremental synchronization.
    incrTransferConfig object This parameter is deprecated. We recommend that you call the DescribeProject interface.
    ├─ startTimestamp long Starting timestamp of incremental synchronization. This parameter is supported only when incremental synchronization is enabled but full transmission is not.
    ├─ recordTypeWhiteList array Data types of incremental data to be synchronized. Valid values: HEARTBEAT, INSERT, UPDATE, DELETE, BEGIN, COMMIT, ROLLBACK, DDL, and ROW.
    ├─ storeLogKeptHour integer When incremental synchronization is enabled and the incremental log puller is Store, the log retention period in hours. Valid values: 1 to 365.
    ├─ enableSequencingWithinTxn boolean Whether to enable sequence number preallocation within a transaction when incremental synchronization is enabled and the incremental log puller is Store.
    ├─ incrSyncConcurrency integer Number of threads for incremental synchronization. Default value: 64.
    ├─ enableIncrSyncStatistics boolean Whether to enable statistics (DML and DDL records) for incremental records.
    ├─ incrOnlineDdlConfig array Online DDL tool adaptation. Valid values: GH_OST, PT_OSC, and ALIYUN_DMS, indicating gh-ost, pt-osc, and Alibaba Cloud DMS respectively.
    • This parameter takes effect only in the configuration of forward incremental synchronization for MySQL databases to MySQL-compatible tenants of OceanBase Database.
    • This parameter takes effect only in the configuration of reverse incremental synchronization for MySQL-compatible tenants of OceanBase Database to MySQL databases.
    ├─ incrLogPullSpeedMode string Incremental log pulling concurrency speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM (custom).
    ├─ incrLogPullSpeedConfig object Incremental log pulling resource configuration. This parameter is effective only when incrLogPullSpeedMode is set to CUSTOM.
    ├─├─ memory integer Memory limit for incremental log pulling.
    ├─ incrLogSyncSpeedMode string Incremental data writing concurrency speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM (custom).
    ├─ incrLogSyncSpeedConfig object Incremental data writing resource configuration. This parameter is effective only when incrLogSyncSpeedMode is set to CUSTOM.
    ├─├─ memory integer Memory limit for incremental data writing.
    ├─├─ writerWorkerNum integer Number of threads for incremental data writing.
    ├─ throttleRps integer Maximum transmission rate in records per second that can be achieved in the incremental synchronization phase. Input null to indicate no restriction.
    ├─ throttleIOPS integer Maximum transmission traffic in bytes per second that can be achieved in the incremental synchronization phase. Input null to indicate no restriction.
    ├─ supportDDLTypes array Supported DDL types.
    • CREATE_TABLE
    • ALTER_TABLE
    • DROP_TABLE
    • RENAME_TABLE
    • TRUNCATE_TABLE
    • CREATE_INDEX
    • DROP_INDEX
    reverseIncrTransferConfig object Configuration of reverse incremental synchronization.
    ├─ startTimestamp string Starting timestamp of reverse incremental synchronization. This parameter is supported only when incremental synchronization is enabled but full migration is not.
    ├─ recordTypeWhiteList array Data types of incremental data to be synchronized. Valid values: HEARTBEAT, INSERT, UPDATE, DELETE, BEGIN, COMMIT, ROLLBACK, DDL, and ROW.
    ├─ storeLogKeptHour integer When reverse incremental synchronization is enabled and the incremental log puller is Store, the log retention period in hours. Valid values: 1 to 365.
    ├─ enableSequencingWithinTxn boolean Whether to enable sequence number preallocation within a transaction when reverse incremental synchronization is enabled and the incremental log puller is Store.
    ├─ enableIncrSyncStatistics boolean Whether to enable statistics (DML and DDL records) for incremental records.
    ├─ incrOnlineDdlConfig array Online DDL tool adaptation. Valid values: GH_OST, PT_OSC, and ALIYUN_DMS, indicating gh-ost, pt-osc, and Alibaba Cloud DMS respectively.
    • This parameter takes effect only in the configuration of forward incremental synchronization for MySQL databases to MySQL-compatible tenants of OceanBase Database.
    • This parameter takes effect only in the configuration of reverse incremental synchronization for MySQL-compatible tenants of OceanBase Database to MySQL databases.
    ├─ incrSyncConcurrency integer Number of threads for reverse incremental synchronization. Default value: 64.
    ├─ incrLogPullSpeedMode string Reverse incremental log pulling concurrency speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM (custom).
    ├─ incrLogPullSpeedConfig object Reverse incremental log pulling resource configuration. This parameter is effective only when incrLogPullSpeedMode is set to CUSTOM.
    ├─├─ memory integer Memory limit for reverse incremental log pulling.
    ├─ incrLogSyncSpeedMode string Reverse incremental data writing concurrency speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM (custom).
    ├─ incrLogSyncSpeedConfig object Reverse incremental data writing resource configuration. This parameter is effective only when incrLogSyncSpeedMode is set to CUSTOM.
    ├─├─ memory integer Memory limit for reverse incremental data writing.
    ├─├─ writerWorkerNum integer Number of threads for reverse incremental data writing.
    ├─ throttleRps integer Maximum transmission rate in records per second that can be achieved in the reverse incremental synchronization phase. Input null to indicate no restriction.
    ├─ throttleIOPS integer Maximum transmission traffic in bytes per second that can be achieved in the reverse incremental synchronization phase. Input null to indicate no restriction.
    ├─ supportDDLTypes array Supported DDL types.
    • CREATE_TABLE
    • ALTER_TABLE
    • DROP_TABLE
    • RENAME_TABLE
    • TRUNCATE_TABLE
    • CREATE_INDEX
    • DROP_INDEX
    sourceConnectInfo object Connection information of the source endpoint.
    ├─ id string Connection information ID.
    ├─ endpointName string Endpoint name.
    ├─ endpointId string Endpoint ID.
    ├─ endpointSide string Endpoint type, which can be source (source endpoint) or dest (destination endpoint).
    ├─ dbEngine string Database engine.
    ├─ connectionInfo string Connection information.
    ├─ username string Username.
    ├─ version string Database version.
    ├─ timezone string Time zone.
    ├─ charset string Character set.
    ├─ nlsLengthSemantics string nlsLengthSemantics attribute. This parameter applies only to Oracle and Oracle-compatible tenants of OceanBase Database.
    ├─ operatingSystem string Operating system. (This parameter does not apply to OceanBase Database).
    ├─ region string Region.
    ├─ ocpName string OCP name.
    ├─ connExtraAttributes Object Connection extra attributes. For more information about the returned fields, see the Appendix section.
    ├─ owner string Owner.
    ├─ host string IP address.
    ├─ port integer Port number.
    sinkConnectInfo object Connection information of the destination endpoint.
    ├─ id string Connection information ID.
    ├─ endpointName string Endpoint name.
    ├─ endpointId string Endpoint ID.
    ├─ endpointSide string Endpoint type, which can be source (source endpoint) or dest (destination endpoint).
    ├─ dbEngine string Database engine.
    ├─ connectionInfo string Connection information.
    ├─ username string Username.
    ├─ version string Database version.
    ├─ timezone string Time zone.
    ├─ charset string Character set.
    ├─ nlsLengthSemantics string nlsLengthSemantics attribute. This parameter applies only to Oracle and Oracle-compatible tenants of OceanBase Database.
    ├─ operatingSystem string Operating system. (This parameter does not apply to OceanBase Database).
    ├─ region string Region.
    ├─ ocpName string OCP name.
    ├─ connExtraAttributes Object Connection extra attributes. For more information about the returned fields, see the Appendix section.
    ├─ owner string Owner.
    ├─ host string IP address.
    ├─ port integer Port number.
    steps object [] Step list.
    ├─ order integer Step order.
    ├─ name string Step name.
    ├─ description string Step description.
    ├─ status string Step status.
    ├─ extraInfo object Supplemental information. For more information about the returned fields, see "Parameters in extraInfo".
    ├─ startTime string Start time, which is displayed in the UTC + 0 time zone.
    ├─ finishTime string Finish time, which is displayed in the UTC + 0 time zone.
    ├─ progress integer Step progress.
    ├─ stepInfo object Step details. For more information, see Query task step details.
    extraInfo object This parameter is deprecated. We recommend that you call the DescribeProject interface.
    ├─ runningStep string Running step.
    ├─ runningProgress integer Running progress of the step.
    ├─ monitoringIncr boolean Whether to start monitoring incremental data.
    ├─ subtopics string Subtopics associated with the task.
    ├─ reverseSubtopics string Subtopics associated with the reverse task.
    ├─ logServiceStartCheckpoint integer Starting timestamp.
    ├─ sourceStoreKeptHour integer Log retention period.
    ├─ syncDelay integer Incremental synchronization latency.
    ├─ syncDelaySampleTimestamp integer Timestamp in seconds of incremental synchronization latency.
    ├─ accessObSource boolean Whether to allow direct connection to the source OceanBase Database.
    ├─ overwriteConfig boolean Whether to allow complete overwrite and update of configurations.
    ├─ ignoreUnsupportDdl boolean Whether to ignore unsupported DDL statements.
    ├─ subDbs map Table configurations for different downstream consumers. This parameter is used to merge configurations when a data synchronization task is reused.
    ├─ subConds map Configuration object list.
    ├─ subIds map Configuration object IDs.
    ├─ maxConnectorCount integer Maximum number of Connectors. The value -1 indicates no limit.
    ├─ storeIncr boolean Whether to store incremental data.
    ├─ incrSyncTimestamp integer Current incremental synchronization timestamp in seconds.
    alarmStats object Alert statistics.
    ├─ target string Target of the alert.
    ├─ alarming boolean Whether an alert is being issued.
    ├─ recentlyTriggerCount integer Total number of alert messages.
    ├─ ruleToRecentlyTriggerCount map Number of alert messages triggered by rule.
    ├─ alarmContent string Content of the latest alert message.
  • Parameters in databases/databasesBlack

    Parameter Type Description
    mappedName string Name of the destination database.
    name string Name of the source database.
    id string Database ID.
    tables array Table configurations of the tables to be transmitted in the current database. The mode value of WILDCARD indicates that this parameter specifies the black or white list configurations for specific tables and views shared by tables and views.
    ├─ mappedName string Mapped table name.
    ├─ name string Table name.
    ├─ id string Table ID.
    ├─ whereClause string Row filter configuration by using the WHERE clause in a standard SQL statement.
    ├─ filterColumns array Filter column set.
    ├─ shardColumns array Sharding column set.
    ├─ columns object [] Column list. For more information, see "Parameters in columns".
    views array View configurations of the views to be transmitted in the current database.
    ├─ mappedName string Mapped view name.
    ├─ name string View name.
    ├─ id string View ID.
    ├─ whereClause string Standard SQL statement WHERE clause for row filter configuration.
    ├─ filterColumns array Filter column set.
    ├─ shardColumns array Sharding column set.
    ├─ columns object [] List of columns to be transferred. For specific information, see "Parameters in columns".
    specificTables array Table configurations of specific tables. The mode value of WILDCARD indicates that this parameter specifies the renaming and row filter configurations for specific tables.
    ├─ mappedName string Mapped table name.
    ├─ name string Table name.
    ├─ id string Table ID.
    ├─ whereClause string Standard SQL statement WHERE clause for row filter configuration.
    ├─ filterColumns array Filter column set.
    ├─ shardColumns array Sharding column set.
    ├─ columns object [] List of columns to be transferred. For specific information, see "Parameters in columns".
    specificViews array View configurations of specific views. The mode value of WILDCARD indicates that this parameter specifies the renaming configurations for specific views.
    ├─ mappedName string Mapped view name.
    ├─ name string View name.
    ├─ id string View ID.
    ├─ whereClause string Standard SQL statement WHERE clause for row filter configuration.
    ├─ filterColumns array Filter column set.
    ├─ shardColumns array Sharding column set.
    ├─ columns object [] List of columns to be transferred. For specific information, see "Parameters in columns ".
  • Parameters in columns

    Parameter Type Description
    columnName string Column name.
    mappedName string Mapped column name.
    position integer Column position.
    columnType string Column type.
    recordFieldType string Extended column type.
    rawColumnType string Raw column type string in database records.
    columnKey string Index type.
    nullable boolean Whether the column can be null.
    defaultValue string Default value.
    dataLength integer Column length.
    dataPrecision integer Column precision.
    dataScale integer Decimal places.
    encoding string Column character encoding.
    columnComment string Column comment.
    isGenerateField boolean Whether the column is a hidden column.
  • Parameters in extraInfo

    Parameter Type Description
    errorDetails array Error details.
    errorCode string Error code.
    errorMsg string Error message.
    errorParam object Error-related parameters.
    failedTime string Error time.

Examples

Sample request

{
    "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
}

Return 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 endpoint of the service.
username string The username. This parameter is required if you choose the PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512 authentication method.
enableSSL boolean Whether to enable SSL authentication. If enabled, you need to upload a trusted certificate.
enableSASL boolean Whether to enable SASL authentication.
saslMechanism KafkaSaslMechanisnEnum The encryption method, which can be one of the following: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, and KERBEROS.
disableIdentificationAlgorithm boolean Whether to enable hostname verification in SSL encryption.

DataHub

{
    "connExtraAttributes":{
        "endpoint":"xxx.xxx.xxx.1:2883",
        "project":"detx***"
    }
}
Parameter Type Description
endpoint string The endpoint of the service.
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 endpoint of the service.
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 Specifies whether the data source is a logical data source.
useLogProxy boolean Specifies whether to use LogProxy.
drcUser string The configuration of drc_user.
configUrl string The URL for obtaining the real IP address of the underlying server of OceanBase Database.
logProxyIp string The IP address of LogProxy.
logProxyPort integer The port number of LogProxy.
noUserAuth boolean For interfaces synchronized to DataWorks, the data source is automatically generated by OMS. If no username and password are provided, the OceanBase Database cannot be connected.

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
Sample request
Return example
Appendix
Kafka
DataHub
RocketMQ
OceanBase
TiDB