Domain name for API request: dts.tencentcloudapi.com.
This API is used to configure a migration task. After it is configured successfully, you can call the CreateMigrationCheckJob
API to create a check task, and only after it passes the check can it be started.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: ModifyMigrationJob. |
Version | Yes | String | Common Params. The value used for this API: 2021-12-06. |
Region | No | String | Common Params. This parameter is not required for this API. |
JobId | Yes | String | Task ID |
RunMode | Yes | String | Running mode. Valid values: immediate , timed . |
MigrateOption | Yes | MigrateOption | Migration task configuration options, which describe how the task performs migration. The RateLimitOption option cannot be configured. To modify the speed limit settings of the task, use the ModifyMigrateRateLimit API after the task starts running. |
SrcInfo | Yes | DBEndpointInfo | Source instance information |
DstInfo | Yes | DBEndpointInfo | Target instance information |
JobName | No | String | Migration task name, which can contain up to 128 characters. |
ExpectRunTime | No | String | Expected start time in the format of "2006-01-02 15:04:05", which is required if RunMode is timed . |
Tags.N | No | Array of TagItem | Tag information |
AutoRetryTimeRangeMinutes | No | Integer | Automatic retry time, which can be set to 5-720 minutes. 0 indicates that retry is disabled. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMigrationJob
<Common request parameters>
{
"JobId": "abc",
"JobName": "abc",
"RunMode": "abc",
"ExpectRunTime": "abc",
"MigrateOption": {
"MigrateType": "abc",
"Consistency": {
"Mode": "abc"
},
"DatabaseTable": {
"ObjectMode": "abc",
"Databases": [
{
"DbName": "abc",
"NewDbName": "abc",
"SchemaName": "abc",
"NewSchemaName": "abc",
"DBMode": "abc",
"SchemaMode": "abc",
"TableMode": "abc",
"Tables": [
{
"TableName": "abc",
"NewTableName": "abc",
"TmpTables": [
"abc"
],
"TableEditMode": "abc"
}
],
"ViewMode": "abc",
"Views": [
{
"ViewName": "abc",
"NewViewName": "abc"
}
],
"RoleMode": "abc",
"Roles": [
{
"RoleName": "abc",
"NewRoleName": "abc"
}
],
"FunctionMode": "abc",
"TriggerMode": "abc",
"EventMode": "abc",
"ProcedureMode": "abc",
"Functions": [
"abc"
],
"Procedures": [
"abc"
],
"Events": [
"abc"
],
"Triggers": [
"abc"
]
}
],
"AdvancedObjects": [
"abc"
]
},
"IsMigrateAccount": true,
"IsOverrideRoot": true,
"IsDstReadOnly": true,
"ExtraAttr": [
{
"Key": "abc",
"Value": "abc"
}
]
},
"SrcInfo": {
"Supplier": "abc",
"Region": "abc",
"AccessType": "abc",
"DatabaseType": "abc",
"NodeType": "abc",
"Info": [
{
"Role": "abc",
"DbKernel": "abc",
"Host": "abc",
"Port": 1,
"User": "abc",
"Password": "abc",
"CvmInstanceId": "abc",
"UniqVpnGwId": "abc",
"UniqDcgId": "abc",
"InstanceId": "abc",
"CcnGwId": "abc",
"VpcId": "abc",
"SubnetId": "abc",
"EngineVersion": "abc",
"Account": "abc",
"AccountRole": "abc",
"AccountMode": "abc",
"TmpSecretId": "abc",
"TmpSecretKey": "abc",
"TmpToken": "abc"
}
],
"ExtraAttr": [
{
"Key": "abc",
"Value": "abc"
}
],
"DatabaseNetEnv": "abc"
},
"DstInfo": {
"Supplier": "abc",
"Region": "abc",
"AccessType": "abc",
"DatabaseType": "abc",
"NodeType": "abc",
"Info": [
{
"Role": "abc",
"DbKernel": "abc",
"Host": "abc",
"Port": 1,
"User": "abc",
"Password": "abc",
"CvmInstanceId": "abc",
"UniqVpnGwId": "abc",
"UniqDcgId": "abc",
"InstanceId": "abc",
"CcnGwId": "abc",
"VpcId": "abc",
"SubnetId": "abc",
"EngineVersion": "abc",
"Account": "abc",
"AccountRole": "abc",
"AccountMode": "abc",
"TmpSecretId": "abc",
"TmpSecretKey": "abc",
"TmpToken": "abc"
}
],
"ExtraAttr": [
{
"Key": "abc",
"Value": "abc"
}
],
"DatabaseNetEnv": "abc"
},
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"AutoRetryTimeRangeMinutes": 0
}
{
"Response": {
"RequestId": "abc"
}
}
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 |
---|---|
AuthFailure.AuthFailureError | Authentication failed. |
AuthFailure.AuthorizedOperationDenyError | Authentication was denied. |
AuthFailure.UnauthorizedOperationError | The current user is not allowed to perform this operation as the authentication failed. |
DryRunOperation.DryRunOperationError | DryRun operation, which means an unnecessary DryRun parameter is passed in yet the request will still be successful. |
FailedOperation.FailedOperationError | The operation failed. |
InternalError | An internal error occurred. |
InternalError.InternalErrorError | An internal error occurred. |
InternalError.InternalHttpServerError | An HTTP access request error occurred. |
InternalError.UnknownError | An unknown internal error occurred. |
InvalidParameter.InvalidParameterError | The parameter is invalid. |
InvalidParameterValue.DataConvertError | A data conversion error occurred. |
InvalidParameterValue.InvalidParameterValueError | The parameter is invalid. |
LimitExceeded.LimitExceededError | The quantity exceeds the limit. |
MissingParameter.MissingParameterError | The parameter is lost. |
OperationDenied.OperationDeniedError | The operation was denied. |
RequestLimitExceeded.RequestLimitExceededError | The number of requests exceeds the limit. |
ResourceInUse.ResourceInUseError | The resource is being used. |
ResourceInsufficient.ResourceInsufficientError | The resources are insufficient. |
ResourceNotFound.ResourceNotFoundError | The resource was not found. |
ResourceUnavailable.ResourceUnavailableError | The resource is unavailable. |
ResourcesSoldOut.ResourcesSoldOutError | The resources have been sold out. |
UnauthorizedOperation.UnauthorizedOperationError | The operation is unauthorized. |
UnknownParameter.UnknownParameterError | The parameter is unknown. |
UnsupportedOperation.UnsupportedOperationError | The operation is not supported. |
Was this page helpful?