You can call this operation to open a database when migrating backup data to RDS.

Before performing this operation, we recommend that you view Migrate full backup data to RDS for SQL Server 2012/2016/2017.


You can use API Explorer to perform debugging. API Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateOnlineDatabaseTask

The operation that you want to perform. Set the value to CreateOnlineDatabaseTask.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

DBName String Yes testDB

The name of the database.

MigrateTaskId String Yes 5652255443

The ID of the migration task.

CheckDBMode String Yes AsyncExecuteDBCheck

The consistency check method for an open database. Valid values:

  • SyncExecuteDBCheck
  • AsyncExecuteDBCheck
Note You can specify this parameter for ApsaraDB RDS for SQL Server.
ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

The client token that is used to ensure the idempotency of requests. The parameter value is generated by the client and is unique among different requests. The value is a string of up to 64 ASCII characters.

AccessKeyId String No LTAIfCxxxxxxx

The AccessKey ID that Alibaba Cloud issues to a user for service access.

Response parameters

Name Type Example Description
RequestId String 1B2EBD14-36F6-4645-A3F9-DE19D321C18F

The ID of the request.


Sample requests

http(s):// Action=CreateOnlineDatabaseTask
&<Common request parameters>

Successful response examples

XML format


JSON format


Error codes

View error codes