This topic describes the UpdateFullImport operation provided by OceanBase Migration Service (OMS) Community Edition.
Description
This API operation is used to update a Full-Import component.
Usage notes
Limitations
This operation is applicable to OMS Community Edition V4.1.1 and later versions.
Request path
POST /api/v2?Action=UpdateFullImport
Request parameters
| Parameter | Type | Description |
|---|---|---|
| dimension | string | The operation dimension. The value is fixed to NAME. This parameter must be specified. |
| key | string | The value in the current dimension. This parameter must be specified. |
| cmRegion | string | The region to which the Full-Import component belongs. This parameter must be specified. |
| config | map | The component configuration. This parameter must be specified. |
| ├─coordinator | map | The configuration path of the Coordinator, which is conf/coordinator.json. |
| ├─condition | map | The configuration path of the Condition module, which is conf/condition.json. |
| ├─source | map | The configuration path of source plug-ins, which is conf/source.json. Each configuration class has a config key. |
| ├─sink | map | The configuration path of sink plug-ins, which is conf/sink.json. Each configuration class has a config key. |
| allowDelete | boolean | Specifies whether the configuration can be deleted. Default value: false. The value true indicates that the configuration can be deleted. If this parameter is set to true, the operation passes the configuration that needs to be retained. |
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 description. |
| advice | string | The suggestions. |
| requestId | string | The request ID. |
| pageNumber | integer | The page number, which takes effect in a pagination query. |
| pageSize | integer | The page size, which takes effect in a pagination query. |
| totalCount | integer | The total number of pages, which takes effect in a pagination query. |
| cost | string | The amount of time spent in processing the request, in seconds. |
| data | integer | The returned O&M task ID. |
Examples
Sample request
{
"dimension":"NAME",
"key":"xxx.xxx.xxx.1-9000:connector_v2:np_4x9j****-incr_trans-1-0:0000000006",
"cmRegion":"cn-beijing",
"config":{
"coordinator":{
},
"condition":{
},
"source":{
},
"sink":{
}
},
"allowDelete":false
}
Sample response
{
"success":true,
"errorDetail":null,
"code":null,
"message":null,
"advice":null,
"requestId":"95b4e**a-4e***",
"pageNumber":1,
"pageSize":10,
"totalCount":415,
"cost":"36 ms",
"data":20
}
