tencent cloud

Feedback

CreateMigration

Last updated: 2022-08-16 16:32:49

1. API Description

Domain name for API request: sqlserver.tencentcloudapi.com.

This API is used to create a migration task.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
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: CreateMigration.
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.
MigrateName Yes String Migration task name
MigrateType Yes Integer Migration type (1: structure migration, 2: data migration, 3: incremental sync)
SourceType Yes 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)
Source Yes MigrateSource Migration source
Target Yes MigrateTarget Migration target
MigrateDBSet.N No Array of MigrateDB Database objects to be migrated. This parameter is not used for offline migration (SourceType=4 or SourceType=5)
RenameRestore.N No Array of RenameRestoreDatabase Restore and rename the databases listed in ReNameRestoreDatabase. If this parameter is left empty, all restored databases will be renamed in the default format. This parameter takes effect only when SourceType=5.

3. Output Parameters

Parameter Name Type Description
MigrateId Integer Migration task ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a migration task

Input Example

https://sqlserver.tencentcloudapi.com/?Action=CreateMigration
&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

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.
FailedOperation.GcsError The operation failed or the network timed out.
InternalError Internal error.
InternalError.CreateFlowFailed Failed to create flow.
InternalError.DBConnectError Database connection 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.DBCharIllegal The database name contains invalid characters.
InvalidParameterValue.DBExist The database already exists.
InvalidParameterValue.MigrationNameIsIllegal The migration name contains invalid characters.
InvalidParameterValue.OnCvmTypeNotSupported Basic edition instances are not supported.
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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support