DescribeRollbackTimeValidity

Last updated: 2021-08-05 17:35:42

1. API Description

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

This API is used to query whether rollback is possible based on the specified time and cluster.

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 parameter. The value used for this API: DescribeRollbackTimeValidity.
Version Yes String Common parameter. The value used for this API: 2019-01-07.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID
ExpectTime Yes String Expected time point to roll back to
ExpectTimeThresh Yes Integer Error tolerance range for rollback time point

3. Output Parameters

Parameter Name Type Description
PoolId Integer Storage poolID
QueryId Integer Rollback task ID, which needs to be passed in when rolling back to this time point
Status String Whether the time point is valid. pass: check passed; fail: check failed
SuggestTime String Suggested time point. This value takes effect only if Status is fail
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying whether rollback is possible based on specified time point

Input Example

https://cynosdb.tencentcloudapi.com/?Action=DescribeRollbackTimeValidity
&ClusterId=cynosdbpg-gn65y9nk
&ExpectTime=2019-01-1302:12:05
&ExpectTimeThresh=0
&<Common request parameters>

Output Example

{
  "Response": {
    "PoolId": 1050,
    "QueryId": 2008,
    "Status": "pass",
    "SuggestTime": ""
  }
}

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.SystemError Internal system error.
InvalidParameterValue.ParamError Incorrect parameter.
InvalidParameterValue.StoragePoolNotFound No related storage pool found.
UnauthorizedOperation.PermissionDenied CAM authentication failed.