This topic describes the CreateProjectModifyRecords API provided by OceanBase Migration Service (OMS).
Purpose
You can call this operation to add or remove table objects.
Call description
Limitations
This operation is supported in OMS V4.2.2 and later.
Request path
POST /api/v2?Action=CreateProjectModifyRecords
Request parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID of the data migration, data synchronization, or data verification task. |
| databases | object [] | The list of database objects. For more information, see the "Parameters in databases" section of this topic. |
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 filters. |
| ├─ filterColumns | array | The filter columns. |
| ├─ shardColumns | array | The sharding columns. |
| 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 filters. |
| ├─ 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 filters. |
| ├─ 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 filters. |
| ├─ filterColumns | array | The filter columns. |
| ├─ shardColumns | array | The sharding columns. |
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 | The suggestions about how to resolve the error. |
| requestId | string | The request ID. |
| pageNumber | integer | The number of the page to return. |
| pageSize | integer | The number of entries to return on each page. |
| totalCount | long | The total number of entries returned. |
| cost | string | The time spent in processing the request, in seconds. |
| data | long | The ID of the modification record. |
Examples
Request example
{
"id": "np_43fe****",
"databases":[
{
"name":"test",
"mappedName":"test",
"tables":[
{
"name":"a",
"mappedName":"a"
},
{
"name":"b",
"mappedName":"b"
},
{
"name":"c",
"mappedName":"c"
}
]
}
]
}
Response example
{
"success": true,
"errorDetail": null,
"code": null,
"message": null,
"advice": null,
"requestId": "E3D924FB-52****B253-0C1A7EFB778C",
"pageNumber": 1,
"pageSize": 10,
"totalCount": 100,
"cost": "371 ms",
"data": 24
}
