ModifyMigration

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: ModifyMigration.
Version	Yes	String	Common Params. The value used for this API: 2018-03-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
MigrateId	Yes	Integer	Migration task ID
MigrateName	No	String	New name of migration task. If this parameter is left empty, no modification will be made
MigrateType	No	Integer	New migration type (1: structure migration, 2: data migration, 3: incremental sync). If this parameter is left empty, no modification will be made
SourceType	No	Integer	Migration source type. 1: TencentDB for SQL Server, 2: CVM-based self-created SQL Server database; 3: SQL Server backup restoration, 4: SQL Server backup restoration (in COS mode). If this parameter is left empty, no modification will be made
Source	No	MigrateSource	Migration source. If this parameter is left empty, no modification will be made
Target	No	MigrateTarget	Migration target. If this parameter is left empty, no modification will be made
MigrateDBSet.N	No	Array of MigrateDB	Database objects to be migrated. This parameter is not used for offline migration (SourceType=4 or SourceType=5). If it left empty, no modification will be made

3. Output Parameters

Parameter Name	Type	Description
MigrateId	Integer	Migration task ID
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.

4. Example

Example1 Modifying a migration task

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=ModifyMigration
&MigrateId=2728
&MigrateName=Test API
&MigrateType=2
&SourceType=5
&Source.Url.0=http://gz-oncvm-1254065710.cosgz.myqcloud.com/testdb.bak
&Target.InstanceId=mssql-si2823jyl
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
        "MigrateId": 2728
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.DBError	Database error.
InternalError	Internal error.
InternalError.CreateFlowFailed	Failed to create flow.
InternalError.DBConnectError	Database connection error.
InternalError.DBError	Database error
InternalError.SystemError	System error.
InternalError.UnknownError	Unknown error.
InvalidParameter	Invalid parameter.
InvalidParameter.InputIllegal	Input error.
InvalidParameter.ParamsAssertFailed	An error occurred while converting parameter assertion.
InvalidParameterValue.MigrationNameIsIllegal	The migration name contains invalid characters.
ResourceNotFound.InstanceNotFound	The instance does not exist.
ResourceUnavailable.InstanceMigrateRegionIllegal	Invalid instance migration region.
ResourceUnavailable.InstanceMigrateStatusInvalid	Invalid instance migration status.
ResourceUnavailable.InstanceStatusInvalid	Invalid instance status.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Modifying a migration task

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

About Tencent Cloud

Help & Support

Resources

User Center

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Tencent Big Model

Internet of Things

Stream Services

Cloud Real-time Rendering

Cloud Resource Management

More

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Management and Audit Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Voice Technology

Natural Language Processing

Communication

Media Process Services

Education Sevices

Developer Tools

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Image Creation

Optical Character Recognition

Interactive Video Services

Media SDK

Medical Services

Monitor and Operation

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Modifying a migration task

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

About Tencent Cloud

Help & Support

Resources

User Center