tencent cloud

Feedback

DescribeRollbackRangeTime

Last updated: 2024-11-20 11:12:28

    1. API Description

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

    This API (DescribeRollbackRangeTime) is used to query the time range available for instance rollback.

    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: DescribeRollbackRangeTime.
    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.
    InstanceIds.N Yes Array of String Instance ID list. An instance ID is in the format of cdb-c1nl9rpv, which is the same as the instance ID displayed on the TencentDB Console page.
    IsRemoteZone No String Whether the clone instance and the source instance are in the same AZ. Valid values: true (yes), false (no).
    BackupRegion No String The region of the clone instance, such as ap-guangzhou.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible instances.
    Items Array of InstanceRollbackRangeTime Returned parameter information.
    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 time range available for rollback

    This example shows you how to query the time range available for rollback.

    Input Example

    POST / HTTP/1.1
    Host: cdb.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeRollbackRangeTime
    <Common request parameters>
    
    {
        "InstanceIds": [
            "cdb-bdf7h3j1",
            "cdb-fix44sxh"
        ]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
            "TotalCount": 2,
            "Items": [
                {
                    "InstanceId": "cdb-fix44sxh",
                    "Message": "ok",
                    "Code": 0,
                    "Times": [
                        {
                            "Begin": "2017-08-21 02:06:20",
                            "End": "2017-08-25 17:52:05"
                        }
                    ]
                },
                {
                    "InstanceId": "cdb-bdf7h3j1",
                    "Message": "ok",
                    "Code": 0,
                    "Times": [
                        {
                            "Begin": "2017-08-21 02:06:00",
                            "End": "2017-08-25 17:52:05"
                        }
                    ]
                }
            ]
        }
    }
    

    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.
    InternalError.DatabaseAccessError Internal database error.
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound The instance does not exist.
    OperationDenied Operation denied.