릴리스 노트
Domain name for API request: dts.intl.tencentcloudapi.com.
This API (ModifyMigrateJob) is used to modify a data migration task.
If the status of a migration task is creating (status=1), check succeeded (status=4), check failed (status=5), or migration failed (status=10), this API can be called to modify the task, but the type of the source and target instances and the region of the target instance cannot be modified.
For a finance zone linkage, please use the domain name dts.ap-shenzhen-fsi.tencentcloudapi.com.
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: ModifyMigrateJob. |
| Version | Yes | String | Common Params. The value used for this API: 2018-03-30. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| JobId | Yes | String | ID of the data migration task to be modified |
| JobName | No | String | Data migration task name |
| MigrateOption | No | MigrateOption | Migration task configuration options |
| SrcAccessType | No | String | Source instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance) |
| SrcInfo | No | SrcInfo | Source instance information, which is correlated with the migration task type |
| DstAccessType | No | String | Target instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance). Currently, only cdb is supported |
| DstInfo | No | DstInfo | Target instance information. The region where the target instance is located cannot be modified. |
| DatabaseInfo | No | String | When migrating the specified table, you need to set the information of the source database table to be migrated, 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"}] For databases with a database-schema-table structure: [{"Database":"db1","Schema":"s1","Table":["table1","table2"]},{"Database":"db1","Schema":"s2","Table":["table1","table2"]},{"Database":"db2","Schema":"s1","Table":["table1","table2"]},{"Database":"db3"},{"Database":"db4","Schema":"s1"}] This field does not need to be set when the entire instance is to be migrated |
| SrcNodeType | No | String | Source instance type. simple: Primary/Secondary node; cluster: Cluster node. If this field is left empty, the value defaults to primary/secondary node. |
| SrcInfoMulti.N | No | Array of SrcInfo | Source instance information, which is correlated with the migration task type. |
| 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. |
This example shows you how to modify the configuration of the migration task “dts-1kl0iy0v”.
https://dts.intl.tencentcloudapi.com/?Action=ModifyMigrateJob
&JobId=dts-1kl0iy0v
&JobName=userdts
&DatabaseInfo=[{"Database":"test","Table":["user","log"]}]
&MigrateOption.RunMode=1
&MigrateOption.MigrateType=2
&MigrateOption.MigrateObject=2
&MigrateOption.ConsistencyType=5
&MigrateOption.IsOverrideRoot=0
&DstInfo.ReadOnly=0
&DstInfo.Region=ap-guangzhou
&SrcInfo.Supplier=others
&<Common request parameters>{
"Response": {
"RequestId": "27ef2b7c-a786-48b4-9404-2f9baf3f4916"
}
}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 | A communication protocol error occurred. |
| InternalError.UnknownError | An unknown internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameterValue.BizInvalidParameterValueError | Invalid business parameters. |
| InvalidParameterValue.DataConvertError | A data conversion error occurred. |
| ResourceNotFound.JobNotExist | The migration task does not exist. |
| UnauthorizedOperation.NotEnoughPrivileges | Authentication failed as there were no required permissions. |
피드백