All Products
Search

This Product

    ApsaraDB RDS:CreateOnlineDatabaseTask

    Document Center

    ApsaraDB RDS:CreateOnlineDatabaseTask

    Last Updated:Dec 05, 2024

    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

    Note : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

    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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:CreateOnlineDatabaseTaskcreate
    *DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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****
    DBInstanceIdstringYes

    The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

    		rm-uf6wjk5xxxxxxx
    DBNamestringYes

    The name of the database.

    		testDB
    MigrateTaskIdstringYes

    The ID of the migration task.

    		5652255443
    CheckDBModestringYes

    The consistency check method after the database is open. Valid values:

    • SyncExecuteDBCheck: synchronous database check
    • AsyncExecuteDBCheck: asynchronous database check
    Note The check methods are supported for RDS instances that run SQL Server 2008 R2.
    		AsyncExecuteDBCheck

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		1B2EBD14-36F6-4645-A3F9-DE19D321C18F

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1B2EBD14-36F6-4645-A3F9-DE19D321C18F"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400EngineNotSupportedEngine 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.
    400EngineVersionNotSupportedEngineVersion specified cannot be replicate with the source DB Instance.Instance cloning is not supported for the database engine version of the current instance.
    400InvalideStatusParent migrate task status is invalid.The parent migration task is abnormal.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    403IncorrectDBInstanceTypeCurrent 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.
    404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.The instance ID cannot be found.
    404IncorrectDBInstanceLockModeCurrent 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 timeSummary of changesOperation
    2022-06-23API Description Update. The Error code has changedView Change Details