tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBackupUploadSize

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

    1. API Description

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

    This API is used to query the size of uploaded backup files. It is valid if the backup file type is COS_UPLOAD (the file is stored in COS).

    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: DescribeBackupUploadSize.
    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
    IncrementalMigrationId No String Incremental import task ID

    3. Output Parameters

    Parameter Name Type Description
    CosUploadBackupFileSet Array of CosUploadBackupFile Information of uploaded backups
    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 Querying the list of uploaded full backup files

    Input Example

    https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeBackupUploadSize
&InstanceId=mssql-rdc0gajn
&BackupMigrationId=mssql-backup-migration-kpl74n9l
&<common request parameters>

    Output Example

    {
    "Response": {
        "CosUploadBackupFileSet": [
            {
                "FileName": "db1.bak",
                "Size": 172032
            }
        ],
        "RequestId": "15455085-fe18-4c19-a463-5494451fb0f0"
    }
}

    Example2 Querying the list of uploaded incremental backup files

    Input Example

    https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeBackupUploadSize
&InstanceId=mssql-rdc0gajn
&BackupMigrationId=mssql-backup-migration-cg0ffgqt
&IncrementalMigrationId=mssql-incremental-migration-kp7bgv8p
&<common request parameters>

    Output Example

    {
    "Response": {
        "CosUploadBackupFileSet": [
            {
                "FileName": "db_cvm_1_20200927204209_2log2_2noreconvery2.bak",
                "Size": 28672
            },
            {
                "FileName": "db_cvm_3_20200927204219_2log2_2noreconvery2.bak",
                "Size": 40960
            }
        ],
        "RequestId": "08218621-158d-49df-8366-dfa7958a1ffd"
    }
}

    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.CosError COS API error.
    InternalError.DBError Database error
    InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
    InvalidParameterValue.CosPathError Wrong upload path.
    ResourceNotFound.FullBackupMigrationNotExist The full backup import task does not exist.
    ResourceNotFound.IncreBackupMigrationNotExist The incremental backup import task does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy