DescribeProject|V4.3.1|OceanBase Migration Service| docs|Distributed Database

This topic describes the OceanBase Migration Service (OMS) OpenAPI: DescribeProject, which is used to query the details of a task.

Purpose

This interface is used to query the details of a data migration, synchronization, or verification task.

Call description

Limitations

This interface applies to OMS V4.1.0 and later.

Request path

POST /api/v2?Action=DescribeProject

Request parameters

Parameter	Type	Description
id	string	The ID of the data migration, synchronization, or verification task.

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	Advice.
requestId	string	The request ID.
pageNumber	integer	Page number, takes effect only when paged queries are performed.
pageSize	integer	Page size, takes effect only when paged queries are performed.
totalCount	integer	Total number of records, takes effect only when paged queries are performed.
cost	string	The time spent in processing the request, in seconds.
data	string	Information about the task. For specific information, see "Parameters in data".

Parameters in data

Parameter	Type	Description
id	string	The task ID.
type	string	The task type. `MIGRATION`: data migration task. `SYNC`: data synchronization task. `VERIFY`: data verification task.
name	string	The task name, which cannot contain spaces.
labels	object []	The tag set.
├─ id	string	Tag ID.
├─ name	string	Tag name.
owner	string	The task owner.
importance	string	The alert level of the task. Valid values: `HIGH`, `MEDIUM`, `LOW`, and `IGNORE`.
status	string	The task status.
gmtCreate	string	The task creation time, in the format of UTC + 0.
gmtModified	string	The task modification time, in the format of UTC + 0.
gmtStart	string	The task start time.
gmtFinish	string	The task end time.
destConnId	string	The task connection information ID.
isMerging	boolean	Indicates whether the task is in the merging state.
isModifying	boolean	Indicates whether the task is in the modification state.
isSubProject	boolean	Indicates whether the task is a sub-project.
sourceEndpointType	string	The data source type of the source.
sinkEndpointType	string	The data source type of the target.
transferMapping	object	The migration objects and their mapping information.
├─ mode	string	The mapping mode of the migration object. Valid values: `SPECIFIC` (specified object) and `WILDCARD` (matching rule).
├─ databases	object []	The database object list. For specific information, see "Parameters in databases/databasesBlack".
├─ databasesBlack	object []	The matching rule mode: database object blacklist list. For specific information, see "Parameters in databases/databasesBlack".
├─ tableAndViewWhiteList	array	The matching rule mode: wildcard whitelist of tables and views.
├─ tableAndViewBlackList	array	The matching rule mode: wildcard blacklist of tables and views.
commonTransferConfig	object	The common migration configuration.
├─ tableCategory	string	The type of the table to be transferred. 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	Indicates whether the disaster recovery and dual-active scenarios are enabled (deprecated in OMS V4.3.1).
├─ mqSerializerType	string	The 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	The partition routing mode when data is delivered to a message queue. Valid values: ONE (specify the partition for delivery), HASH (hash partitioning based on the primary key or the shard column value), and TABLE (hash partitioning based on the database and table name).
├─ mqPartition	integer	The partition position in the current topic when `partitionMode` is `ONE`.
├─ datahubTopicType	string	The type of the topic to which data is delivered in the form of tuples. Valid values: `TUPLE` and `BLOB`.
├─ rocketMqProducerGroup	string	The name of the producer group. This parameter is effective only when the target is RocketMQ. Default value: OMS.
├─ rocketMqMsgTags	string	The message tags when the target is RocketMQ. Default value: default->default_tag. When the value is `default`, the suffix `_tag` is appended by default.
├─ rocketMqEnableMsgTrace	boolean	Specifies whether to enable message tracing when the target is RocketMQ.
├─ rocketMqSendMsgTimeout	long	The timeout period for message delivery when the target is RocketMQ.
├─ dataWorksBusinessName	string	The business system identifier. This parameter identifies the business system source of data for subsequent custom processing. This parameter is supported only when the serialization mode is DataWorks. The length of the value must be 1 to 20 characters.
├─ sinkStoreFormat	string	The storage type of the target table object. Valid values: Default, Row Storage, Column Storage, and Hybrid Row-Column Storage. This parameter is effective only when the target OceanBase Database is V4.3.0 or later and the migration type is Schema Migration or Incremental Synchronization > DDL synchronization.
├─ sourceStoreFormat	string	The storage type of the source table object. Valid values: Default, Row Storage, Column Storage, and Hybrid Row-Column Storage. This parameter is effective only when the source OceanBase Database is V4.3.0 or later and the migration type is Reverse Increment > DDL synchronization.
├─ interactiveMode	boolean	Specifies whether to manually advance the task through the interface.
enableStructTransfer	boolean	Specifies whether to allow schema migration.
structTransferConfig	object	The schema migration configuration.
├─ byteCharConvertStrategy	string	The byte/char conversion strategy. Valid values: `IGNORE_BYTE_IF_BYTE_USED`, `FORCE_CHAR_IF_BYTE_USED`, `EXPAND_LEN_IF_BYTE_USED`, and `DO_NOTHING_IF_BYTE_USED` (default).
├─ deferIndexCreation	boolean	Specifies whether to allow index post-processing. Default value: No.
enableFullTransfer	boolean	Specifies whether to enable full migration.
enableFullVerify	boolean	Specifies whether to enable full verification.
fullTransferConfig	object	The full migration configuration.
├─ nonePkUkTruncateDstTable	boolean	Specifies whether to truncate the target table when full migration is performed for a source table without unique indexes.
├─ allowDestTableNotEmpty	boolean	The handling strategy when the target table contains data. Valid values: Ignore and Stop Migration. If you set the value to `true`, OMS will adopt the ignore strategy for data write when the target table contains data. In other words, when data conflicts with unique keys in the target table, OMS will ignore the corresponding data from the source and retain the data in the target. 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	The full migration speed. Valid values: `STEADY`, `NORMAL`, `FAST`, and `CUSTOM`.
├─ fullTransferSpeedConfig	string	The full migration speed configuration. This parameter is effective only when `fullTransferSpeedMode` is `CUSTOM`.
├─├─ memory	integer	Memory limit, in GB.
├─├─ readerWorkerNum	integer	Number of concurrent reads.
├─├─ writerWorkerNum	integer	Number of concurrent writes.
├─ fullVerifySpeedMode	string	The full verification speed. Valid values: `STEADY`, `NORMAL`, `FAST`, and `CUSTOM`.
├─ fullVerifySpeedConfig	string	The full verification speed configuration. This parameter is effective only when `fullVerifySpeedMode` is `CUSTOM`.
├─├─ memory	integer	Memory limit, in GB.
├─├─ readerWorkerNum	integer	Number of concurrent reads.
├─├─ writerWorkerNum	integer	Number of concurrent writes.
├─ throttleRps	integer	The maximum transfer rate allowed for full migration, in records per second. Enter null to indicate no restriction.
├─ throttleIOPS	integer	The maximum transfer traffic allowed for full migration, in bytes per second. Enter null to indicate no restriction.
enableIncrTransfer	boolean	Specifies whether to enable incremental synchronization.
enableIncrVerify	boolean	Specifies whether to enable incremental verification.
enableReverseIncrTransfer	boolean	Specifies whether to enable reverse incremental synchronization.
incrTransferConfig	object	The incremental synchronization configuration.
├─ startTimestamp	string	The Incremental synchronization start timestamp. This parameter is supported only when incremental synchronization is enabled but full migration is not enabled.
├─ recordTypeWhiteList	array	The incremental data types to be synchronized when incremental synchronization is enabled.
├─ storeLogKeptHour	integer	The log retention period when incremental logs are pulled by the Store component. The value ranges from 1 to 365.
├─ enableSequencingWithinTxn	boolean	Specifies whether to enable sequence number sequencing within transactions when incremental logs are pulled by the Store component.
├─ incrSyncConcurrency	integer	The number of threads for incremental synchronization. Default value: 64.
├─ enableIncrSyncStatistics	boolean	Specifies whether to enable incremental record (DML and DDL) statistics.
├─ incrOnlineDdlConfig	array	The value of this parameter indicates the name of the online DDL tool used for adaptation. Valid values: GH_OST, PT_OSC, and ALIYUN_DMS, which respectively indicate gh-ost, pt-osc, and Alibaba Cloud DMS. 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.
├─ incrLogPullSpeedMode	string	The incremental log pull speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM.
├─ incrLogPullSpeedConfig	string	The incremental log pull resource configuration. This parameter is effective only when `incrLogPullSpeedMode` is `CUSTOM`.
├─├─ memory	integer	The incremental log pull memory limit.
├─ incrLogSyncSpeedMode	string	The incremental data write speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM.
├─ incrLogSyncSpeedConfig	string	The incremental data write resource configuration. This parameter is effective only when `incrLogSyncSpeedMode` is `CUSTOM`.
├─├─ memory	integer	The incremental log write memory limit.
├─├─ writerWorkerNum	integer	The number of concurrent incremental log writes.
├─ throttleRps	integer	The maximum transfer rate allowed for incremental synchronization, in records per second. Enter null to indicate no restriction.
├─ throttleIOPS	integer	The maximum transfer traffic allowed for incremental synchronization, in bytes per second. Enter null to indicate no restriction.
├─ supportDDLTypes	array	The supported DDL types. CREATE_TABLE ALTER_TABLE DROP_TABLE RENAME_TABLE TRUNCATE_TABLE CREATE_INDEX DROP_INDEX
reverseIncrTransferConfig	object	The configuration of reverse incremental synchronization.
├─ startTimestamp	string	The reverse Incremental synchronization start timestamp. This parameter is supported only when incremental synchronization is enabled but full migration is not enabled.
├─ recordTypeWhiteList	array	The incremental data types 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 when incremental logs are pulled by the Store component in reverse incremental synchronization. The value ranges from 1 to 365.
├─ enableSequencingWithinTxn	boolean	Specifies whether to enable sequence number sequencing within transactions when incremental logs are pulled by the Store component in reverse incremental synchronization.
├─ enableIncrSyncStatistics	boolean	Specifies whether to enable reverse incremental record (DML and DDL) statistics.
├─ incrOnlineDdlConfig	array	The value of this parameter indicates the name of the online DDL tool used for adaptation. Valid values: GH_OST, PT_OSC, and ALIYUN_DMS, which respectively indicate gh-ost, pt-osc, and Alibaba Cloud DMS. 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.
├─ incrLogPullSpeedConfig	string	The reverse incremental log pull resource configuration. This parameter is effective only when `incrLogPullSpeedMode` is `CUSTOM`.
├─├─ memory	integer	The reverse incremental log pull memory limit.
├─ incrLogSyncSpeedMode	string	The reverse incremental data write speed. Valid values: STEADY (low), NORMAL (medium), FAST (high), and CUSTOM.
├─ incrLogSyncSpeedConfig	string	The reverse incremental data write resource configuration. This parameter is effective only when `incrLogSyncSpeedMode` is `CUSTOM`.
├─├─ memory	integer	The reverse incremental log write memory limit.
├─├─ writerWorkerNum	integer	The number of concurrent reverse incremental log writes.
├─ throttleRps	integer	The maximum transfer rate allowed for reverse incremental synchronization, in records per second. Enter null to indicate no restriction.
├─ throttleIOPS	integer	The maximum transfer traffic allowed for reverse incremental synchronization, in bytes per second. Enter null to indicate no restriction.
├─ 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	Connection information ID.
├─ endpointName	string	Endpoint name.
├─ endpointId	string	Endpoint ID.
├─ endpointSide	string	Endpoint type. Valid values: `source` and `dest` (target).
├─ dbEngine	string	Database engine of the endpoint.
├─ connectionInfo	string	Endpoint connection information.
├─ username	string	Username for connection.
├─ version	string	Database version.
├─ timezone	string	Database time zone.
├─ charset	string	Character set.
├─ nlsLengthSemantics	string	nlsLengthSemantics attribute. This parameter is supported only for Oracle and OceanBase Database Oracle compatible mode data sources.
├─ operatingSystem	string	Operating system. This parameter is not supported for OceanBase Database.
├─ region	string	Region.
├─ ocpName	string	OCP name.
├─ connExtraAttributes	Object	Connection extra attributes. For specific return fields, see the content in the Appendix section.
├─ owner	string	Owner.
├─ host	string	IP address.
├─ port	integer	Port number.
sinkConnectInfo	object	The connection information of the target.
├─ id	string	Connection information ID.
├─ endpointName	string	Endpoint name.
├─ endpointId	string	Endpoint ID.
├─ endpointSide	string	Endpoint type. Valid values: `source` and `dest` (target).
├─ dbEngine	string	Database engine of the endpoint.
├─ connectionInfo	string	Endpoint connection information.
├─ username	string	Username for connection.
├─ version	string	Database version.
├─ timezone	string	Database time zone.
├─ charset	string	Character set.
├─ nlsLengthSemantics	string	nlsLengthSemantics attribute. This parameter is supported only for Oracle and OceanBase Database Oracle compatible mode data sources.
├─ operatingSystem	string	Operating system. This parameter is not supported for OceanBase Database.
├─ region	string	Region.
├─ ocpName	string	OCP name.
├─ connExtraAttributes	Object	Connection extra attributes. For specific return fields, see the content in the Appendix section.
├─ owner	string	Owner.
├─ host	string	IP address.
├─ port	integer	Port number.
steps	object []	The step list.
├─ order	integer	The step execution order.
├─ name	string	Step name.
├─ description	string	Step description.
├─ status	string	Step status.
├─ extraInfo	object	Supplemental information. For specific information, see "Parameters in extraInfo".
├─ startTime	string	Start time, in the format of UTC + 0.
├─ finishTime	string	End time, in the format of UTC + 0.
├─ progress	integer	Step progress.
├─ stepInfo	object	Details of each step. For specific information, see "Parameters in stepInfo".
extraInfo	object	Supplemental information such as error information.
├─ runningStep	string	The step in the running state.
├─ runningProgress	integer	The progress of the step in the running state.
├─ monitoringIncr	boolean	Specifies whether to enable incremental monitoring.
├─ subtopics	string	The subtopics associated with the task when it is related to the Store component.
├─ reverseSubtopics	string	The subtopics associated with the task when it is related to the reverse Store component.
├─ logServiceStartCheckpoint	integer	The start checkpoint.
├─ sourceStoreKeptHour	integer	The log retention period.
├─ syncDelay	integer	The incremental synchronization delay.
├─ syncDelaySampleTimestamp	integer	The incremental synchronization delay sampling timestamp in seconds.
├─ accessObSource	boolean	Specifies whether the source OceanBase database can be directly connected.
├─ overwriteConfig	boolean	Specifies whether to allow complete overwrite of updated configurations.
├─ ignoreUnsupportDdl	boolean	Specifies whether to ignore unsupported DDL statements.
├─ subDbs	map	The table configurations for different downstream consumers. This parameter is used for configuration merging when the task is reused for data synchronization.
├─ subConds	map	The configuration object list.
├─ subIds	map	The list of IDs of the configuration objects.
├─ maxConnectorCount	integer	The maximum number of Connectors, -1 indicating no limit.
├─ storeIncr	boolean	Specifies whether to save incremental data.
├─ incrSyncTimestamp	integer	The current incremental synchronization timestamp in seconds.
alarmStats	object	Alert statistics.
├─ target	string	The target of the alert.
├─ alarming	boolean	Specifies whether an alert is being issued.
├─ recentlyTriggerCount	integer	The total number of alert messages.
├─ ruleToRecentlyTriggerCount	map	The number of alert messages triggered by each rule.
├─ alarmContent	string	The content of the latest alert message.

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 configurations of table objects to be transferred in the current database. When `mode` is `WILDCARD`, this parameter indicates the configurations of specific blacklists or whitelists, which are shared by tables and views.
├─ mappedName	string	The mapped name of the table.
├─ name	string	The name of the table.
├─ id	string	The ID of the table.
├─ whereClause	string	The `WHERE` clause in the standard SQL statement for configuring row filtering.
├─ filterColumns	array	The filtered column set.
├─ shardColumns	array	The shard column set.
├─ columns	object []	The specific column information. For more information, see "Parameters in columns".
views	array	The configurations of view objects to be transferred in the current database.
├─ mappedName	string	The mapped name of the view.
├─ name	string	The name of the view.
├─ id	string	The ID of the view.
├─ whereClause	string	The `WHERE` clause in the standard SQL statement for configuring row filtering.
├─ filterColumns	array	The filtered column set.
├─ shardColumns	array	The shard column set.
├─ columns	object []	The list of columns to be transferred. For more information, see "Parameters in columns".
specificTables	array	The configurations of specific table objects. When `mode` is `WILDCARD`, this parameter indicates the renaming and row filtering configurations of specific table objects.
├─ mappedName	string	The mapped name of the table.
├─ name	string	The name of the table.
├─ id	string	The ID of the table.
├─ whereClause	string	The `WHERE` clause in the standard SQL statement for configuring row filtering.
├─ filterColumns	array	The filtered column set.
├─ shardColumns	array	The shard column set.
├─ columns	object []	The list of columns to be transferred. For more information, see "Parameters in columns".
specificViews	array	The configurations of specific view objects. When `mode` is `WILDCARD`, this parameter indicates the renaming configurations of specific view objects.
├─ mappedName	string	The mapped name of the view.
├─ name	string	The name of the view.
├─ id	string	The ID of the view.
├─ whereClause	string	The `WHERE` clause in the standard SQL statement for configuring row filtering.
├─ filterColumns	array	The filtered column set.
├─ shardColumns	array	The shard column set.
├─ columns	object []	The list of 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 name of the column.
position	integer	The position of the column.
columnType	string	The type of the column.
recordFieldType	string	The derived type of the column type.
rawColumnType	string	The original string of the column type in the database record.
columnKey	string	The type of the index.
nullable	boolean	Specifies whether the column can be empty.
defaultValue	string	The default value of the column.
dataLength	integer	The length of the column.
dataPrecision	integer	The precision of the column.
dataScale	integer	The decimal point.
encoding	string	The character encoding of the column.
columnComment	string	The comment on the column.
isGenerateField	boolean	Specifies 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	Parameters related to the error.
failedTime	string	Error time.

Parameters in stepInfo

The stepInfo parameter returns different fields for different steps.

TRANSFER_APP_SWITCH (forward switchover)

Parameter	Type	Description
checkpointSampleTimestamp	long	The timestamp when the checkpoint is sampled. The value is in Unix timestamp format and the unit is seconds.

INCR_TRANSFER (incremental synchronization)

Parameter	Type	Description
incrTimestampCheckpoint	long	The timestamp when the checkpoint is sampled. The value is in Unix timestamp format and the unit is seconds.
checkpointSampleTimestamp	long	The timestamp when the checkpoint is sampled. The value is in Unix timestamp format and the unit is seconds.
enableIncrStatistics	boolean	Specifies whether to enable DML/DDL statistics.

FULL_VERIFIER (full verification) and FULL_TRANSFER (full migration)

Parameter	Type	Description
processedRecords	long	The number of migrated rows.
capacity	long	The estimated total number of rows.
srcRps	long	The source RPS, in records per second.
srcRt	string	The source RT, in milliseconds per row.
srcIops	long	The source IOPS, in bytes per second.
dstRps	long	The target RPS, in records per second.
dstRt	long	The target RT, in milliseconds per row.
dstIops	long	The target IOPS, in bytes per second.
srcRpsRef	long	The reference source RPS.
dstRpsRef	long	The reference target RPS.
dstRtRef	long	The reference target RT.

Examples

Request example

{
    "id":"np_4wh****"
}

Response example

{
    "success":true,
    "errorDetail":null,
    "code":null,
    "message":null,
    "advice":null,
    "requestId":"a7b57****",
    "pageNumber":null,
    "pageSize":null,
    "totalCount":null,
    "cost":"27 ms",
    "data":[
        {
            "id":"np_4w****",
            "type":"MIGRATION",
            "name":"oms41_mig***",
            "labels":null,
            "owner":"oms_api_t***",
            "importance":"MEDIUM",
            "status":"RUNNING",
            "gmtCreate":"2023-07-13T03:59:15",
            "gmtModified":"2023-07-13T10:12:44",
            "gmtStart":"2023-07-13T06:47:35",
            "gmtFinish":null,
            "destConnId":null,
            "isMerging":false,
            "isModifying":false,
            "isSubProject":false,
            "sourceEndpointType":"DB2_LUW",
            "sinkEndpointType":"OB_MYSQL",
            "transferMapping":{
                "mode":"SPECIFIC",
                "databases":[
                    {
                        "mappedName":"tion12***20obmysql2",
                        "name":"GRATION129****",
                        "id":null,
                        "tables":[
                            {
                                "mappedName":"TEST_MA***",
                                "name":"TEST_M***",
                                "id":null,
                                "whereClause":null,
                                "filterColumns":null,
                                "shardColumns":null,
                                "columns":null
                            }
                        ],
                        "views":null,
                        "specificTables":null,
                        "specificViews":null
                    }
                ],
                "databasesBlack":null,
                "tableAndViewWhiteList":null,
                "tableAndViewBlackList":null
            },
            "commonTransferConfig":{
                "tableCategory":null,
                "activeActive":false,
                "mqSerializerType":null,
                "mqPartitionMode":null,
                "mqPartition":0,
                "datahubTopicType":null,
                "rocketMqProducerGroup":null,
                "rocketMqMsgTags":null,
                "rocketMqEnableMsgTrace":null,
                "rocketMqSendMsgTimeout":null,
                "dataWorksBusinessName":null,
                "interactiveMode":true
            },
            "enableStructTransfer":true,
            "structTransferConfig":{
                "byteCharConvertStrategy":"DO_NOTHING_IF_BYTE_USED",
                "deferIndexCreation":true
            },
            "enableFullTransfer":true,
            "enableFullVerify":true,
            "fullTransferConfig":{
                "nonePkUkTruncateDstTable":null,
                "allowDestTableNotEmpty":true,
                "fullTransferSpeedMode":"CUSTOM",
                "fullTransferSpeedConfig":{
                    "memory":4,
                    "readerWorkerNum":1,
                    "writerWorkerNum":2
                    },
                "fullVerifySpeedMode":"CUSTOM",
                "fullVerifySpeedConfig":{
                    "memory":4,
                    "readerWorkerNum":1,
                    "writerWorkerNum":2
                    },
                "throttleRps": 1000,
                "throttleIOPS": 1000
                    },
            "enableIncrTransfer":true,
            "enableIncrVerify":false,
            "enableReverseIncrTransfer":true,
            "incrTransferConfig":{
                "startTimestamp":1689201369,
                "recordTypeWhiteList":[
                    "INSERT",
                    "DELETE",
                    "UPDATE"
                ],
                "storeLogKeptHour":120,
                "enableSequencingWithinTxn":null,
                "incrSyncConcurrency":null,
                "enableIncrSyncStatistics":null,
                "incrLogPullSpeedMode":"NORMAL",
                "incrLogPullSpeedConfig":{
                    "memory":4
                    },
                "incrLogSyncSpeedMode":"CUSTOM",
                "incrLogSyncSpeedConfig":{
                    "memory":4,
                    "writerWorkerNum":2
                    },
                "throttleRps": 1000,
                "throttleIOPS": 1000,
                "incrOnlineDdlConfig":[
                  "GH_OST",
                  "PT_OSC",
                  "ALIYUN_DMS"
                  ]
            },
            "sourceConnectInfo":{
                "id":"c_4w1qs****",
                "endpointName":"GRATION12948*****",
                "endpointId":"e_4w1q****",
                "endpointSide":null,
                "dbEngine":"DB2_LUW_PUBLIC",
                "connectionInfo":null,
                "username":"db2i***",
                "version":"11.5.0.0",
                "timezone":"+08:00",
                "charset":"UTF8",
                "nlsLengthSemantics":null,
                "operatingSystem":"Linux",
                "region":"cn-anhui",
                "ocpName":"",
                "connExtraAttributes":null,
                "owner":"oms_api_t***",
                "host":"xxx.xxx.xxx.1",
                "port":"2883"
            },
            "sinkConnectInfo":{
                "id":"c_4w1qs***",
                "endpointName":"tion1294820obmysq****",
                "endpointId":"e_4w1qr2***",
                "endpointSide":null,
                "dbEngine":"OB_MYSQL_PUBLIC",
                "connectionInfo":null,
                "username":"oms2027obmysql@oms_***",
                "version":"2.2.77",
                "timezone":"+08:00",
                "charset":"utf8mb4",
                "nlsLengthSemantics":null,
                "operatingSystem":null,
                "region":"cn-anhui",
                "ocpName":"107",
                "connExtraAttributes":null,
                "owner":"oms_api_t***",
                "host":"xxx.xxx.xxx.4",
                "port":"2883"
            },
            "steps":[
                {
                    "order":1,
                    "name":"TRANSFER_PRECHECK",
                    "description":"Precheck",
                    "status":"FINISHED",
                    "extraInfo":{
                        "errorDetails":null,
                        "errorCode":null,
                        "errorMsg":null,
                        "errorParam":null,
                        "failedTime":null
                    },
                    "startTime":"2023-07-12T22:33:42",
                    "finishTime":"2023-07-12T22:33:48",
                    "progress":100,
                    "stepInfo":null
                },
                {
                    "order":2,
                    "name":"STRUCT_TRANSFER",
                    "description":"schema migration",
                    "status":"FINISHED",
                    "extraInfo":{
                        "errorDetails":null,
                        "errorCode":null,
                        "errorMsg":null,
                        "errorParam":null,
                        "failedTime":"2023-07-12T22:35:48.881"
                    },
                    "startTime":"2023-07-12T22:35:24",
                    "finishTime":"2023-07-12T22:36:04",
                    "progress":100,
                    "stepInfo":null
                },
                {
                    "order":6,
                    "name":"INCR_TRANSFER",
                    "description":"Incremental synchronization",
                    "status":"MONITORING",
                    "extraInfo":{
                        "errorDetails":null,
                        "errorCode":null,
                        "errorMsg":null,
                        "errorParam":null,
                        "failedTime":null
                    },
                    "startTime":"2023-07-12T22:41:20",
                    "finishTime":"2023-07-12T22:46:57",
                    "progress":99,
                    "stepInfo":{
                        "incrTimestampCheckpoint":1689213946,
                        "checkpointSampleTimestamp":1689214358,
                        "enableIncrStatistics":true
                    }
                }
            ],
            "extraInfo":null,
            "alarmStats":{
                "target":"np_4w1q****",
                "alarming":false,
                "recentlyTriggerCount":null,
                "ruleToRecentlyTriggerCount":null,
                "alarmContent":null
            }
        }
    ]
}

Appendix E

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 when you set the authentication type to PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512.
enableSSL	boolean	Specifies whether to enable SSL authentication. If SSL authentication is enabled, you must upload a trusted certificate.
enableSASL	boolean	Specifies whether to enable SASL authentication.
saslMechanism	KafkaSaslMechanisnEnum	The encryption method. Valid values: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, and KERBEROS.
disableIdentificationAlgorithm	boolean	Specifies whether to enable hostname verification in SSL authentication.

If an Oracle data source serves as the source or the target and you obtain incremental data from Kafka, the following parameters are returned in the connExtraAttributes parameter.

Parameter	Type	Description
kafkaId	string	The ID of the bound Kafka data source that is required after you choose to obtain incremental data from Kafka.
kafkaTopic	string	The topic of the bound Kafka data source.
cdcDataFormat	string	The incremental message format. Valid values: `ogg_json` and `ogg_json_row`.
kafkaName	string	The name of the bound Kafka data source.

Oracle data source as the source

{
"sourceConnectInfo": {
    "connExtraAttributes": {
        "kafkaId": "e_6m*****",
        "kafkaTopic": "test",
        "cdcDataFormat": "ogg_json",
        "kafkaName": "kafka-test"
        }
    }
}

Oracle data source as the target

{
"sinkConnectInfo": {
    "connExtraAttributes": {
        "kafkaId": "e_6m*****",
        "kafkaTopic": "test",
        "cdcDataFormat": "ogg_json",
        "kafkaName": "kafka-test"
        }
    }
}

DataHub

{
    "connExtraAttributes":{
        "endpoint":"xxx.xxx.xxx.1:2883",
        "project":"detx***"
    }
}

Parameter	Type	Description
endpoint	string	The endpoint of the service.
project	string	The task name.

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 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 server where OceanBase Database is located.
logProxyIp	string	The IP address of LogProxy.
logProxyPort	integer	The port number of LogProxy.
noUserAuth	boolean	For the interface of DataWorks, the data source is automatically generated by OMS. If no username and password are provided, the OceanBase Database of the user 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.

Enterprise Edition

Community Edition

DescribeProject