tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyBackupMigration

Last updated: 2024-11-26 16:33:32

    1. API Description

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

    This API is used to modify 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: ModifyBackupMigration.
    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
    BackupMigrationId Yes String Backup import task ID, which is returned through the API CreateBackupMigration
    MigrationName No String Task name
    RecoveryType No String Migration task restoration type: FULL,FULL_LOG,FULL_DIFF
    UploadType No String 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.
    BackupFiles.N No Array of String If the UploadType is COS_URL, fill in 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.
    DBRename.N No Array of RenameRestoreDatabase Name set of databases to be renamed

    3. Output Parameters

    Parameter Name Type Description
    BackupMigrationId String Backup import task ID
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Modifying a full backup import task

    Input Example

    POST / HTTP/1.1
Host: sqlserver.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBackupMigration
<Common request parameters>

{
    "BackupMigrationId": "mssql-backup-migration-kpl74n9l",
    "InstanceId": "mssql-rdc0gajn",
    "UploadType": "COS_UPLOAD",
    "BackupFiles": [
        "db1.bak"
    ],
    "MigrationName": "character string",
    "RecoveryType": "FULL"
}

    Output Example

    {
    "Response": {
        "BackupMigrationId": "mssql-backup-migration-kpl74n9l",
        "RequestId": "836a10d3-cd1f-4ac1-96a9-f2e642333f0b"
    }
}

    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.MigrationLockError Locking the backup import task failed.
    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.FullBackupMigrationNotExist The full backup import task does not exist.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    ResourceUnavailable.CosStatusErr A wrong status of offline restoration tasks.
    UnauthorizedOperation.PermissionDenied CAM authentication error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy