CreateProject

This topic describes the CreateProject OpenAPI provided by OceanBase Migration Service (OMS): how to create a task.

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 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 migrated in the current database. When mode is WILDCARD, this parameter specifies the configurations for renaming and row filtering 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. Notice When mode is WILDCARD, this parameter is not supported.
  ├─ filterColumns	array	The filtered column set. Notice When mode is WILDCARD, this parameter is not supported.
  ├─ shardColumns	array	The sharding column set. Notice When mode is WILDCARD, this parameter is not supported.
  views	array	The configurations of view objects to be migrated 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. Notice When mode is WILDCARD, this parameter is not supported.
  ├─ filterColumns	array	The filtered column set. Notice <When mode is WILDCARD, this parameter is not supported.
  ├─ shardColumns	array	The sharding column set. Notice When mode is WILDCARD, this parameter is not supported.
  functions	array	The configurations of function objects to be migrated in the current database.
  ├─ name	string	The name of the function.
  ├─ mappedName	string	The mapped name of the function. This parameter cannot be modified.
  procedures	array	The configurations of stored procedure objects to be migrated in the current database.
  ├─ name	string	The name of the stored procedure.
  ├─ mappedName	string	The mapped name of the stored procedure. This parameter cannot be modified.
  packages	array	The configurations of package objects to be migrated in the current database.
  ├─ name	string	The name of the package.
  ├─ mappedName	string	The mapped name of the package. This parameter cannot be modified.
  synonyms	array	The configurations of synonym objects to be migrated in the current database.
  ├─ name	string	The name of the synonym.
  ├─ mappedName	string	The mapped name of the synonym. This parameter cannot be modified.
  sequences	array	The configurations of sequence objects to be migrated in the current database.
  ├─ name	string	The name of the sequence.
  ├─ mappedName	string	The mapped name of the sequence. This parameter cannot be modified.
  specificTables	array	The configurations of specific table objects. When mode is WILDCARD, this parameter specifies 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. Notice When mode is WILDCARD, this parameter is not supported.
  ├─ filterColumns	array	The filtered column set. Notice When mode is WILDCARD, this parameter is not supported.
  ├─ shardColumns	array	The sharding column set. Notice When mode is WILDCARD, this parameter is not supported.
  specificViews	array	The configurations of specific view objects. When mode is WILDCARD, this parameter specifies 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. Notice When mode is WILDCARD, this parameter is not supported.
  ├─ filterColumns	array	The filtered column set. Notice When mode is WILDCARD, this parameter is not supported.
  ├─ shardColumns	array	The sharding column set. Notice When mode is WILDCARD, this parameter is not supported.
  specificFunctions	array	The configurations of specific function objects. When mode is WILDCARD, this parameter specifies the renaming configurations of specific function objects.
  ├─ name	string	The name of the function.
  ├─ mappedName	string	The mapped name of the function. This parameter cannot be modified.
  specificProcedures	array	The configurations of specific stored procedure objects. When mode is WILDCARD, this parameter specifies the renaming configurations of specific stored procedure objects.
  ├─ name	string	The name of the stored procedure.
  ├─ mappedName	string	The mapped name of the stored procedure. This parameter cannot be modified.
  specificPackages	array	The configurations of specific package objects. When mode is WILDCARD, this parameter specifies the renaming configurations of specific package objects.
  ├─ name	string	The name of the package.
  ├─ mappedName	string	The mapped name of the package. This parameter cannot be modified.
  specificSynonyms	array	The configurations of specific synonym objects. When mode is WILDCARD, this parameter specifies the renaming configurations of specific synonym objects.
  ├─ name	string	The name of the synonym.
  ├─ mappedName	string	The mapped name of the synonym. This parameter cannot be modified.
  specificSequences	array	The configurations of specific sequence objects. When mode is WILDCARD, this parameter specifies the renaming configurations of specific sequence objects.
  ├─ name	string	The name of the sequence.
  ├─ mappedName	string	The mapped name of the sequence. This parameter cannot be modified.

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",
        "autoProcessedToNextStep": true,
        "indexMigrationType": "AFTER_FULL_TRANSFER",
        "triggerMigrationType":"NOT_MIGRATION"
    },
    "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,
    "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,
            "readerWorkerNum":1,
            "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,
            "readerWorkerNum":1,
            "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_****"
}