CreateMmsTimer
Operation description
Before you call this API, make sure you understand the billing methods and pricing for dedicated resource groups and elastic reserved computing resources in the Data Transmission Service.
Try it now
Test
RAM authorization
Request syntax
POST /api/v1/mms/datasources/{sourceId}/timers HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| sourceId |
integer |
Yes |
The data source ID. |
2000015 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
The request parameters. |
|
| sourceId |
integer |
No |
The ID of the data source. |
2000014 |
| name |
string |
No |
The name of the scheduled task. |
planA |
| srcDbName |
string |
No |
The name of the source database. |
src_db |
| partitions |
array |
No |
A list of IDs for the table partitions to migrate. This parameter takes effect only when the |
|
|
integer |
No |
The ID of a table partition to migrate. |
1232 |
|
| tables |
array |
No |
A list of table names to migrate. This parameter takes effect only when the |
|
|
string |
No |
The name of a table to migrate. |
t1 |
|
| tableBlackList |
array |
No |
A blacklist of tables to exclude from the migration. This parameter takes effect only when the |
|
|
string |
No |
The name of a table to exclude from the migration. |
t1 |
|
| tableWhiteList |
array |
No |
A whitelist of tables to migrate. This parameter takes effect only when the |
|
|
string |
No |
The name of a table to migrate. |
t1 |
|
| partitionFilters |
object |
No |
A map of table names to their corresponding partition filter expressions. |
|
|
string |
No |
A partition filter expression. Example:
Partition values can be strings or numbers. String values must be enclosed in single ( Values for partition columns with types other than Supported comparison operators: The Supported logical operators: Parentheses |
{ "student": "p1 >= '2022-03-04' and (p2 = 10 or p3 > 20) and p4 in ('abc', 'cde')" } |
|
| enableSchemaMigration |
boolean |
No |
Specifies whether to migrate the table schema. |
true |
| enableDataMigration |
boolean |
No |
Specifies whether to migrate table data. |
true |
| enableVerification |
boolean |
No |
Specifies whether to enable data verification. If set to |
false |
| tableMapping |
object |
No |
A map of source table names to target table names. |
|
|
string |
No |
A key-value pair that maps a source table name (key) to a target table name (value). |
{'a': 'a1'} |
|
| columnMapping |
object |
No |
A map of source column names to target column names. |
|
|
string |
No |
A key-value pair that maps a source column name (key) to a target column name (value). |
{"c-1": "c_1"} |
|
| others |
object |
No |
Other configuration settings. |
|
|
any |
No |
A key-value pair for an additional configuration setting. |
{} |
|
| value |
string |
No |
The time to run the scheduled task. If |
12:00 |
| scheduleType |
string |
No |
The schedule type for the task. |
Daily |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response object. |
||
| requestId |
string |
The ID of the request. |
0be3e0b716671885050924814e3623 |
| data |
object |
The response data. |
|
| timerId |
integer |
The ID of the timer. |
1 |
Examples
Success response
JSON format
{
"requestId": "0be3e0b716671885050924814e3623",
"data": {
"timerId": 1
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.