CreateProject

This topic describes the CreateProject API provided by OceanBase Migration Service (OMS): how to create a migration project.

Purpose

This interface is used to create a data migration or synchronization task.

Call description

Limitations

This interface applies only to OMS V4.1.0 and later.

Request path

POST /api/v2?Action=CreateProject

Request parameters

• Parameters in databases/databasesBlack

  Parameter	Type	Description
  mappedName	string	The name of the database in the target.
  name	string	The name of the database in the source.
  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 specifies the configurations of blacklisted or whitelisted tables and views.
  ├─ mappedName	string	The mapped name of a table.
  ├─ name	string	The name of a table.
  ├─ id	string	The ID of a table.
  ├─ whereClause	string	A standard SQL WHERE clause for configuring row filtering. Notice When mode is WILDCARD, you cannot set whereClause.
  ├─ filterColumns	array	A collection of filtered columns. Notice When mode is WILDCARD, you cannot set filterColumns.
  ├─ shardColumns	array	A collection of sharding columns. Notice When mode is WILDCARD, you cannot set shardColumns.
  views	array	The configurations of view objects to be transferred in the current database.
  ├─ mappedName	string	The mapped name of a view.
  ├─ name	string	The name of a view.
  ├─ id	string	The ID of a view.
  ├─ whereClause	string	A standard SQL WHERE clause for configuring row filtering. Notice When mode is WILDCARD, you cannot set whereClause.
  ├─ filterColumns	array	A collection of filtered columns. Notice When mode is WILDCARD, you cannot set filterColumns.
  ├─ shardColumns	array	A collection of sharding columns. Notice When mode is WILDCARD, you cannot set shardColumns.
  specificTables	array	The configurations of specific table objects. When mode is WILDCARD, this parameter specifies the renaming and row filtering configurations for specific table objects.
  ├─ mappedName	string	The mapped name of a table.
  ├─ name	string	The name of a table.
  ├─ id	string	The ID of a table.
  ├─ whereClause	string	A standard SQL WHERE clause for configuring row filtering. Notice When mode is WILDCARD, you cannot set whereClause.
  ├─ filterColumns	array	A collection of filtered columns. Notice When mode is WILDCARD, you cannot set filterColumns.
  ├─ shardColumns	array	A collection of sharding columns. Notice When mode is WILDCARD, you cannot set shardColumns.
  specificViews	array	The configurations of specific view objects. When mode is WILDCARD, this parameter specifies the renaming configurations for specific view objects.
  ├─ mappedName	string	The mapped name of a view.
  ├─ name	string	The name of a view.
  ├─ id	string	The ID of a view.
  ├─ whereClause	string	A standard SQL WHERE clause for configuring row filtering. Notice When mode is WILDCARD, you cannot set whereClause.
  ├─ filterColumns	array	A collection of filtered columns. Notice When mode is WILDCARD, you cannot set filterColumns.
  ├─ shardColumns	array	A collection of sharding columns. Notice When mode is WILDCARD, you cannot set shardColumns.

Response parameters

Examples

Request example

{
    "name":"test",
    "type":"MIGRATION",
    "labelIds":[
        "l_4w****wygjk"
    ],
    "sourceEndpointId":"e_4wg07f****",
    "sinkEndpointId":"e_4wfy2****",
    "transferMapping":{
        "mode":"SPECIFIC",
        "databases":[
            {
                "mappedName":"gez3***",
                "name":"ion1****bmysql",
                "id":null,
                "tables":[
                    {
                        "mappedName":"tion12***20obmysql2",
                        "name":"GRATION129****",
                        "id":null,
                        "whereClause":null,
                        "filterColumns":null,
                        "shardColumns":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
    },
    "enableStructTransfer":true,
    "structTransferConfig":{
        "byteCharConvertStrategy":"DO_NOTHING_IF_BYTE_USED",
        "deferIndexCreation":true
    },
    "enableFullTransfer":true,
    "enableFullVerify":true,
    "fullTransferConfig":{
        "nonePkUkTruncateDstTable":null,
        "allowDestTableNotEmpty":true,
        "throttleRps": 1000,
        "throttleIOPS": 1000,
        "fullTransferSpeedMode":"NORMAL",
        "fullVerifySpeedMode":"NORMAL"     
    },
    "enableIncrTransfer":true,
    "enableReverseIncrTransfer":true,
    "incrTransferConfig":{
        "startTimestamp":1689201369,
        "storeLogKeptHour":120,
        "recordTypeWhiteList":[
            "DELETE",
            "INSERT",
            "UPDATE"
        ],
        "enableSequencingWithinTxn":true,
        "incrSyncConcurrency":64,
        "incrLogPullSpeedMode":"NORMAL",
        "incrLogPullSpeedConfig":{
            "memory":4
            },
        "incrLogSyncSpeedMode":"CUSTOM",
        "incrLogSyncSpeedConfig":{
            "memory":4,
            "writerWorkerNum":2
            },
        "throttleRps": 1000,
        "throttleIOPS": 1000,
        "enableIncrSyncStatistics":true,
        "supportDDLTypes":[
            "CREATE_TABLE",
            "ALTER_TABLE"
        ],
        "incrOnlineDdlConfig":[
          "GH_OST",
          "PT_OSC",
          "ALIYUN_DMS"
        ]
    },
    "reverseIncrTransferConfig":{
        "startTimestamp":1689201369,
        "recordTypeWhiteList":[
            "DELETE",
            "INSERT",
            "UPDATE"
        ],
        "storeLogKeptHour":120,
        "incrSyncConcurrency":64,
        "incrLogPullSpeedMode":"NORMAL",
        "incrLogPullSpeedConfig":{
            "memory":4
            },
        "incrLogSyncSpeedMode":"CUSTOM",
        "incrLogSyncSpeedConfig":{
            "memory":4,
            "writerWorkerNum":2
            },
        "throttleRps": 1000,
        "throttleIOPS": 1000,
        "enableIncrSyncStatistics":true,
        "supportDDLTypes":[
            "CREATE_TABLE",
            "ALTER_TABLE"
        ]
    }
}

Response example

{
    "Success":true,
    "ErrorDetail":{
        "Code":"CM-RES***11",
        "Level":"WARN",
        "Message":"A system error occurred.",
        "Proposal":"Contact the administrator."
    },
    "Code":"INNER_ERROR",
    "Message":"A system error occurred.",
    "Advice":"Contact the administrator.",
    "RequestId":"XCVSADG****DSGDS",
    "PageNumber":1,
    "PageSize":1,
    "TotalCount":1,
    "Cost":"27 ms",
    "Data":"np_****"
}