tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for SQL Server
    Documentation
    Download PDF

    CreateBackupMigration

    Last updated: 2023-09-18 11:41:53
    Download PDF

    1. API Description

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

    This API is used to create a backup import 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: CreateBackupMigration.
    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.
    InstanceId Yes String ID of imported target instance
    RecoveryType Yes String Migration task restoration type. FULL: full backup restoration, FULL_LOG: full backup and transaction log restoration, FULL_DIFF: full backup and differential backup restoration
    UploadType Yes String Backup upload type. COS_URL: the backup is stored in user’s Cloud Object Storage, with URL provided. COS_UPLOAD: the backup is stored in the application’s Cloud Object Storage and needs to be uploaded by the user.
    MigrationName Yes String Task name
    BackupFiles.N No Array of String If the UploadType is COS_URL, fill in the URL here. If the UploadType is COS_UPLOAD, fill in the name of the backup file here. Only 1 backup file is supported, but a backup file can involve multiple databases.

    3. Output Parameters

    Parameter Name Type Description
    BackupMigrationId String Backup import 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 backup file import task

    Input Example

    https://sqlserver.tencentcloudapi.com/?Action=CreateBackupMigration
&InstanceId=mssql-rdc0gajn
&RecoveryType=FULL
&UploadType=COS_UPLOAD
&MigrationName=character string
&BackupFiles.0=db1.bak
&<common request parameters>

    Output Example

    {
    "Response": {
        "BackupMigrationId": "mssql-backup-migration-cg0ffgqt",
        "RequestId": "4e2f2093-9cde-44ec-b64b-edfcc2f911d4"
    }
}

    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
    InternalError.DBError Database error
    InternalError.SystemError System error.
    InvalidParameter.InputIllegal Input error.
    InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
    InvalidParameterValue.BackupNameIsIllegal The backup name contains invalid characters.
    InvalidParameterValue.MigrationNameIsIllegal The migration name contains invalid characters.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication error.
    Contact Us

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

    Contact Us
    Technical Support

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

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy