tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRemoteBackupConfig

Last updated: 2024-01-30 10:26:28

    1. API Description

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

    This API is used to query the configuration information of a remote TencentDB instance backup.

    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: DescribeRemoteBackupConfig.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB console.

    3. Output Parameters

    Parameter Name Type Description
    ExpireDays Integer Remote backup retention period in days
    RemoteBackupSave String Remote data backup. Valid values:off (disable), on (enable).
    RemoteBinlogSave String Remote log backup. Valid values: off (disable), on (enable). Only when the parameter RemoteBackupSave is on, the RemoteBinlogSave parameter can be set to on.
    RemoteRegion Array of String List of configured remote backup regions
    RegionList Array of String List of remote backup regions
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the configuration information of a remote TencentDB instance backup

    This example shows you how to query the configuration information of a remote TencentDB instance backup.

    Input Example

    https://cdb.tencentcloudapi.com/?Action=DescribeRemoteBackupConfig&InstanceId=cdb-c1nl9rpv&<common request parameters>

    Output Example

    {
    "Response": {
        "ExpireDays": 7,
        "RemoteBackupSave": "on",
        "RemoteBinlogSave": "on",
        "RemoteRegion": [
            "ap-guangzhou",
            "ap-shanghai"
        ],
        "RegionList": [
            "ap-guangzhou",
            "ap-shanghai",
            "ap-beijing",
            "ap-shanghai"
        ],
        "RequestId": "9d73ec37-89b8-4d36-9f40-123123123"
    }
}

    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.UnknownError Unknown error
    ResourceNotFound.CdbInstanceNotFoundError The instance cannot be found. Please check whether your instance status is normal.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy