ListProjectModifyRecords

This topic describes the ListProjectModifyRecords API provided by OceanBase Migration Service (OMS).

Purpose

You can call this operation to query the modification records of a data migration or synchronization task based on the task ID.

Call description

Limitations

This operation is supported in OMS V4.2.2 and later.

Request path

POST /api/v2?Action=ListProjectModifyRecords

Request parameters

Response parameters

Parameters in data

• Parameters in databases

  Parameter	Type	Description
  id	string	The ID of the database.
  name	string	The name of the database.
  mappedName	string	The mapped database name.
  tables	object []	The settings for the table objects to be transferred in the current database. When the value of the mode parameter is WILDCARD, this parameter indicates the settings for a specific blocklist or allowlist of tables and views.
  ├─ name	string	The name of the table.
  ├─ mappedName	string	The mapped table name.
  ├─ id	string	The ID of the table.
  ├─ whereClause	string	The WHERE clause in the standard SQL syntax that is used to configure row filtering.
  ├─ filterColumns	array	The filter columns.
  ├─ shardColumns	array	The sharding columns.
  columns	object []	The columns to be transferred.
  ├─ columnName	string	The name of the column.
  ├─ mappedName	string	The mapped column name.
  ├─ position	integer	The position of the column.
  ├─ columnType	string	The type of the column.
  ├─ recordFieldType	string	The extension of the column type.
  ├─ rawColumnType	string	The original string of the column type recorded in the database.
  ├─ columnKey	string	The type of the index.
  ├─ nullable	boolean	Indicates whether null values are supported.
  ├─ defaultValue	string	The default value.
  ├─ dataLength	integer	The length of the column.
  ├─ dataPrecision	integer	The precision of the column.
  ├─ dataScale	integer	The number of decimal places.
  ├─ encoding	string	The character encoding format for the column.
  ├─ columnComment	string	The comment on the column.
  ├─ isGenerateField	boolean	Indicates whether the column is a hidden column.
  ├─ type	string	Valid values: DATABASE and TABLE.
  views	object []	The settings for the view objects to be transferred in the current database.
  ├─ name	string	The name of the view.
  ├─ mappedName	string	The mapped view name.
  ├─ id	string	The ID of the view.
  ├─ whereClause	string	The WHERE clause in the standard SQL syntax that is used to configure row filtering.
  ├─ filterColumns	array	The filter columns.
  ├─ shardColumns	array	The sharding columns.
  specificTables	object []	The settings for the matched table objects. When the value of the mode parameter is WILDCARD, this parameter indicates the rename and row filtering settings for the matched table objects.
  ├─ name	string	The name of the table.
  ├─ mappedName	string	The mapped table name.
  ├─ id	string	The ID of the table.
  ├─ whereClause	string	The WHERE clause in the standard SQL syntax that is used to configure row filtering.
  ├─ filterColumns	array	The filter columns.
  ├─ shardColumns	array	The sharding columns.
  specificViews	object []	The settings for the matched view objects. When the value of the mode parameter is WILDCARD, this parameter indicates the rename settings for the matched view objects.
  ├─ name	string	The name of the view.
  ├─ mappedName	string	The mapped view name.
  ├─ id	string	The ID of the view.
  ├─ whereClause	string	The WHERE clause in the standard SQL syntax that is used to configure row filtering.
  ├─ filterColumns	array	The filter columns.
  ├─ shardColumns	array	The sharding columns.

• Parameters in migrationObjectsInfo

  Parameter	Type	Description
  wildcardMode	boolean	Specifies whether the wildcard mode is used.
  tables	object []	The list of tables to be migrated.
  ├─ schema	string	The name of the database.
  ├─ name	string	The name of the table to be migrated.
  tablesBlack	object []	The list of tables blocked from migration.
  ├─ schema	string	The name of the database.
  ├─ name	string	The name of the table blocked from migration.
  views	object []	The list of views to be migrated.
  ├─ schema	string	The name of the database.
  ├─ name	string	The name of the view to be migrated.
  viewsBlack	object []	The list of views blocked from migration.
  ├─ schema	string	The name of the database.
  ├─ name	string	The name of the view blocked from migration.

• Parameters in omsProjectMappingInfo

  Parameter	Type	Description
  schemaMappings	object []	The list of schema mappings.
  ├─ sourceName	string	The name of the source schema.
  ├─ destName	string	The name of the destination schema.
  tableMappings	object []	The list of table mappings.
  ├─ sourceSchema	string	The name of the source schema.
  ├─ sourceName	string	The name of the source object.
  ├─ destName	string	The name of the destination object.
  columnMappings	object []	The list of column mappings.
  ├─ sourceSchema	string	The name of the source schema.
  ├─ sourceTable	string	The name of the source table.
  ├─ sourceName	string	The name of the source object.
  ├─ destName	string	The name of the destination object.
  viewMappings	object []	The list of view mappings.
  ├─ sourceSchema	string	The name of the source schema.
  ├─ sourceName	string	The name of the source object.
  ├─ destName	string	The name of the destination object

• Parameters in tableEtlList

  Parameter	Type	Description
  tenantName	string	The name of the tenant.
  database	string	The name of the source database.
  destDatabase	string	The name of the destination database.
  tableName	string	The name of the source table.
  destName	string	The name of the destination table or topic.
  whereClause	string	The WHERE clause in the standard SQL syntax that is used to configure row filtering.
  filterColumns	array	The filter columns.
  shardColumns	array	The sharding columns.
  logicTableId	string	The ID of the logical table.
  sourceEndpointId	string	This parameter is deprecated.

Examples

Sample request

{
  "id": "np_5****"
}

Sample response

{
    "success": true,
    "errorDetail": null,
    "code": null,
    "message": null,
    "advice": null,
    "requestId": "94665a90-8****",
    "pageNumber": null,
    "pageSize": null,
    "totalCount": null,
    "cost": "15 ms",
    "data": [
        {
            "id": 14,
            "subProjectId": "np_5****",
            "mergeRequestId": null,
            "updateRequestId": null,
            "type": "INCREASE_OBJECT",
            "status": "RUNNING",
            "errorDetail": null,
            "databases": [
                {
                    "name": "oms_test",
                    "mappedName": "mapped_test",
                    "id": null,
                    "tables": [
                        {
                            "name": "table1",
                            "mappedName": "table1",
                            "id": null,
                            "whereClause": null,
                            "filterColumns": null,
                            "shardColumns": null,
                            "columns": null,
                            "adbTableSchema": null
                        }
                    ],
                    "views": null,
                    "specificTables": null,
                    "specificViews": null
                }
            ],
            "migrationObjectsInfo": null,
            "omsProjectMappingInfo": null,
            "tableEtlList": null,
            "gmtModified": "2024-02-19T03:53:45"
        }
    ]
}