Domain name for API request: dts.tencentcloudapi.com.
This API is used to modify a disaster recovery sync task.
If the status of a sync task is creating, created, check succeeded, or check failed, this API can be called to modify the task.
The information of the source and target instances cannot be modified, but the task name and the tables to be synced can.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dts.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: ModifySyncJob. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-03-30. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| JobId | Yes | String | ID of the disaster recovery sync task to be modified |
| JobName | No | String | Name of the disaster recovery sync task |
| SyncOption | No | SyncOption | Configuration options of a disaster recovery sync task |
| DatabaseInfo | No | String | When syncing the specified table, you need to set the information of the source table to be synced, which should be described in JSON string format. Below are examples. For databases with a database-table structure: [{"Database":"db1","Table":["table1","table2"]},{"Database":"db2"}] |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://dts.tencentcloudapi.com/?Action==ModifySyncJob
&JobId=sync-blj8wnt1
&JobName=testname3
&DatabaseInfo=[{"Database": "db1"}, {"Database": "db2"}]
&SyncOption.SyncObject=2
&<Common request parameters>{
"Response": {
"RequestId": "e3ebe70b-e294-4c15-9377-9e82ef73f342"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.NotAllowOperation | This operation is prohibited. |
| InternalError.DatabaseError | Failed to access the database on the DTS platform. |
| InternalError.DuplicateJob | Migration tasks are in conflict. |
| InternalError.ProtocolError | Communication protocol error. |
| InvalidParameter | A parameter error occurred. |
| ResourceNotFound.JobNotExist | The migration task does not exist. |
Was this page helpful?