tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for SQL Server
    Documentation
    Download PDF

    DescribeBackupMigration

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

    1. API Description

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

    This API is used to create an incremental 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: DescribeBackupMigration.
    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 No String Backup import task ID, which is returned through the API CreateBackupMigration.
    MigrationName No String Import task name
    BackupFileName No String Backup file name
    StatusSet.N No Array of Integer Status set of import tasks
    RecoveryType No String Import 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.
    Limit No Integer The maximum number of results returned per page. Default value: 100.
    Offset No Integer Page number. Default value: 0.
    OrderBy No String Sort by field. Valid values: name, createTime, startTime, endTime. By default, the results returned are sorted by createTime in the ascending order.
    OrderByType No String Sorting order which is valid only when OrderBy is specified. Valid values: asc (ascending), desc (descending). Default value: asc.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of tasks
    BackupMigrationSet Array of Migration Migration task set
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying a full backup import task

    Input Example

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

{
    "BackupMigrationId": "mssql-backup-migration-kpl74n9l",
    "OrderBy": "createTime",
    "MigrationName": "character string",
    "UploadType": "COS_UPLOAD",
    "Offset": "0",
    "StatusSet": [
        "2"
    ],
    "InstanceId": "mssql-rdc0gajn",
    "Limit": "100",
    "OrderByType": "desc",
    "BackupFileName": "db1",
    "RecoveryType": "FULL"
}

    Output Example

    {
    "Response": {
        "BackupMigrationSet": [
            {
                "Action": {
                    "AllAction": [
                        "start",
                        "delete",
                        "incremental",
                        "modify",
                        "view",
                        "upload"
                    ],
                    "AllowedAction": [
                        "view",
                        "modify",
                        "delete",
                        "upload",
                        "start"
                    ]
                },
                "AppId": 251006279,
                "BackupFiles": [
                    "db1.bak"
                ],
                "CreateTime": "2020-09-27 16:23:47",
                "Detail": {
                    "Progress": 0,
                    "StepAll": 0,
                    "StepInfo": [],
                    "StepNow": 0
                },
                "EndTime": "0000-00-00 00:00:00",
                "InstanceId": "mssql-rdc0gajn",
                "IsRecovery": "",
                "Message": "",
                "MigrationId": "mssql-backup-migration-kpl74n9l",
                "MigrationName": "character string",
                "RecoveryType": "FULL",
                "Region": "ap-guangzhou",
                "StartTime": "0000-00-00 00:00:00",
                "Status": 2,
                "DBRename": [
                    {
                        "NewName": "newdb",
                        "OldName": "olddb"
                    }
                ],
                "UploadType": "COS_UPLOAD"
            }
        ],
        "RequestId": "cf4b1509-8029-4daf-b7b1-e504ff82cbba",
        "TotalCount": 1
    }
}

    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.ParamsAssertFailed An error occurred while converting parameter assertion.
    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