tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateBackup

Last updated: 2024-11-20 11:14:00

    1. API Description

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

    This API (CreateBackup) is used to create a TencentDB instance backup.

    A maximum of 5 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: CreateBackup.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.
    BackupMethod Yes String Target backup method. Valid values: logical (logical cold backup), physical (physical cold backup), snapshot (snapshot backup). Basic Edition instances only support snapshot backups.
    BackupDBTableList.N No Array of BackupItem Information of the table to be backed up. If this parameter is not set, the entire instance will be backed up by default. It can be set only in logical backup (i.e., BackupMethod = logical). The specified table must exist; otherwise, backup may fail.
    For example, if you want to backup tb1 and tb2 in db1 and the entire db2, you should set the parameter as [{"Db": "db1", "Table": "tb1"}, {"Db": "db1", "Table": "tb2"}, {"Db": "db2"} ].
    ManualBackupName No String Manual backup alias

    3. Output Parameters

    Parameter Name Type Description
    BackupId Integer Backup 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 Creating a database backup

    Input Example

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

{
    "InstanceId": "cdb-c1nl9rpv",
    "BackupDBTableList": [
        {
            "Table": "tb1",
            "Db": "db1"
        }
    ],
    "BackupMethod": "logical"
}

    Output Example

    {
    "Response": {
        "BackupId": 102996666,
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

    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
    AuthFailure CAM signature/authentication error.
    CdbError Backend or process error.
    FailedOperation.StatusConflict Task status conflict.
    InternalError.CdbError System error.
    InternalError.DatabaseAccessError Internal database error.
    InternalError.DesError Internal system error.
    InternalError.HttpError Exceptional HTTP request
    InternalError.NetworkError Network error
    InternalError.OssError An error occurred in TencentDB for MySQL High-Availability Edition database service.
    InternalError.UndefinedError Unknown error
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound The instance does not exist.
    InvalidParameterValue.DataConvertError Data conversion failed.
    OperationDenied.ActionInProcess The instance is performing another task.
    OperationDenied.ActionNotSupport Unsupported operation.
    OperationDenied.UserHasNoStrategy This account is not authorized to access the requested resource.
    OverQuota Limit exceeded.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy