View Backup List

Last updated: 2020-06-04 17:56:07

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new SQL Server API 3.0 which is standardized and faster.

    1. API Description

    This API (ListBackup) is used to view backup list.
    Domain for API request: sqlserver.api.qcloud.com

    2. Input Parameters

    The following request parameter list only provides API request parameters. Common request parameters are also needed when the API is called. For more information, please seeCommon Request Parameters. The Action field for this API is ListBackup.

    Parameter Name Required Type Description
    resourceId Yes String Instance ID
    startTime Yes String Start time (yyyy-MM-dd HH:mm:ss)
    endTime Yes String End time (yyyy-MM-dd HH:mm:ss)
    pageSize No Int Page size
    pageNo No Int Page number

    3. Output Parameters

    Parameter Name Type Description
    code Int Common error code. 0: Successful; other values: Failed. For more information, please see Common Error Codes on the Error Codes page.
    message String Module error message description depending on API.
    data Array Returned data

    Parameter data is composed as follows:

    Parameter Name Type Description
    totalCount Int Total number of backups
    backupList Array Details of backup list

    Parameter backupList is composed as follows:

    Parameter Name Type Description
    fileName String File name
    size Int File size (in KB)
    startTime String Start time of the backup
    endTime String End time of the backup
    internalAddr String Download address in the private network
    externalAddr String Download address in the public network

    4. Error Codes

    Error Code Error Message Error Description
    50 InstanceNotFound Instance does not exist
    1000 SystemError System error. Contact customer service.
    1002 DBConnectError Database connection error
    1005 CreateFlowFailed Failed to create task flow

    5. Example

    Input

    https://sqlserver.api.qcloud.com/v2/index.php?Action=ListBackup&<Common request parameters>&resourceId=mssql-q6g71pcf&startTime=2016-09-27 00:00:00&endTime=2016-09-28 00:00:00&pageSize=10&pageNo=0

    Output

    {
        "code":"0",
        "message":"",
        "data":{
            "backupList":[
                {
                    "fileName":"backup_540316.tar",
                    "size":"1440",
                    "startTime":"2016-09-27 02:03:15",
                    "endTime":"2016-09-27 02:21:45",
                    "internalAddr":"http://10.66.185.141:58366/download/backup_540316.tar?YJW3gzNLKt2LCrywP9JslJXZo6TXiqprJ6x+tRJfDqzPsYYttIeozrDQeh2yfY/Dq/8OltqtK/+Bg3+plnNy5TzRhaYuCh+DpYehlAXVPBHPARU+zHUfxGkimTw+RxB5BBmgF/TTvwQXHfyjCr2DnQ==",
                    "externalAddr":"http://119.29.47.51:9097/download/backup_540316.tar?YJW3gzNLKt2LCrywP9JslJXZo6TXiqprJ6x+tRJfDqzPsYYttIeozrDQeh2yfY/Dq/8OltqtK/+Bg3+plnNy5TzRhaYuCh+DpYehlAXVPBHPARU+zHUfxGkimTw+RxB5BBmgF/TTvwQXHfyjCr2DnQ=="
                }
            ],
            "totalCount":"1"
        }
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help