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 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 target database.
  name	string	The name of the source database.
  id	string	The ID of the database.
  tables	array	The list of table object configurations to be transferred in the current database. When mode is WILDCARD, this parameter indicates the configuration of the specific blacklisted or whitelisted 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 a standard SQL statement for configuring row filtering. Notice When mode is WILDCARD, you cannot set whereClause.
  ├─ filterColumns	array	The filtered column set. Notice When mode is WILDCARD, you cannot set filterColumns.
  ├─ shardColumns	array	The shard column set. Notice When mode is WILDCARD, you cannot set shardColumns.
  views	array	The view object configurations 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 a standard SQL statement for configuring row filtering. Notice When mode is WILDCARD, you cannot set whereClause.
  ├─ filterColumns	array	The filtered column set. Notice When mode is WILDCARD, you cannot set filterColumns.
  ├─ shardColumns	array	The shard column set. Notice When mode is WILDCARD, you cannot set shardColumns.
  specificTables	array	The specific table object configurations. When mode is WILDCARD, this parameter indicates the renaming and row filtering configurations of specific tables.
  ├─ 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 a standard SQL statement for configuring row filtering. Notice When mode is WILDCARD, you cannot set whereClause.
  ├─ filterColumns	array	The filtered column set. Notice When mode is WILDCARD, you cannot set filterColumns.
  ├─ shardColumns	array	The shard column set. Notice When mode is WILDCARD, you cannot set shardColumns.
  specificViews	array	The specific view object configurations. When mode is WILDCARD, this parameter indicates the renaming configurations of specific views.
  ├─ 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 a standard SQL statement for configuring row filtering. Notice When mode is WILDCARD, you cannot set whereClause.
  ├─ filterColumns	array	The filtered column set. Notice When mode is WILDCARD, you cannot set filterColumns.
  ├─ shardColumns	array	The shard column set. Notice When mode is WILDCARD, you cannot set shardColumns.

Response parameters

Examples

Sample request

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

Sample response

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