Opens the database that is involved in a backup data migration task of an ApsaraDB RDS for SQL Server instance.
Operation description
Supported database engines
- SQL Server
References
This operation is used to migrate backup data to the cloud. Before you call this operation, make sure that you understand the descriptions in the following topics:
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. | ETnLKlblzczshOTUbOCz**** |
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5xxxxxxx |
DBName | string | Yes | The name of the database. | testDB |
MigrateTaskId | string | Yes | The ID of the migration task. | 5652255443 |
CheckDBMode | string | Yes | The consistency check method after the database is open. Valid values:
Note
The check methods are supported for RDS instances that run SQL Server 2008 R2.
| AsyncExecuteDBCheck |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "1B2EBD14-36F6-4645-A3F9-DE19D321C18F"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | EngineNotSupported | Engine specified cannot be supported the operation. | The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance. |
400 | EngineVersionNotSupported | EngineVersion specified cannot be replicate with the source DB Instance. | Instance cloning is not supported for the database engine version of the current instance. |
400 | InvalideStatus | Parent migrate task status is invalid. | The parent migration task is abnormal. |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
403 | IncorrectDBInstanceType | Current DB instance engine and type does not support operations. | The operation failed. The operation is not supported for the database engine of the RDS instance. |
404 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | The instance ID cannot be found. |
404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | The operation failed. The RDS instance is locked. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2022-06-23 | API Description Update. The Error code has changed | View Change Details |