DescribeInstanceBackups

Last updated: 2019-09-09 12:20:57

1. API Description

API domain name: redis.tencentcloudapi.com.

This API queries a list of the backups of a Redis instance.

Default API request rate limit: 20 requests/sec.

Note: This API supports financial availability zones. Because financial availability zones and non-financial availability zones are isolated, if the common parameter Region specifies a financial availability zone (e.g., ap-shanghai-fsi), you need to specify a domain name with the financial availability zone as well, which preferably in the same region as the specified Region, for example: vod.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: DescribeInstanceBackups
Version Yes String Common parameter; the version of this API: 2018-04-12
Region Yes String Common parameters; for details, see the List of Regions supported by the product.
InstanceId Yes String ID of the operated instance. You can find this value at the output parameter InstanceId returned by API DescribeInstance.
Limit No Integer Instance list size; 20 by default
Offset No Integer Offset, which is an integral multiple of Limit
BeginTime No String Time when the backup starts. Sample format:2017-02-08 16:46:34. You can query the list of instance backups started between the beginTime and endTime.
EndTime No String Time when the backup ends. Sample format:2017-02-08 16:46:34. You can query the list of instance backups started between the beginTime and endTime.
Status.N No Array of Integer 1: backup in process; 2: backing up normally; 3: converting from backup to RDB file; 4: RDB conversion completed; -1: backup expired; -2: backup deleted.

3. Output Parameters

Parameter name Type Description
TotalCount Integer Total number of backups
BackupSet Array of RedisBackupSet Array of instance backups
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Sample 1. Request Example

Input Sample Code

https://redis.tencentcloudapi.com/?Action=DescribeInstanceBackups
&Limit=5&Offset=0
&InstanceId=crs-5a4py64p
&<Common request parameter>

Output Sample Code

{
  "Response": {
    "RequestId": "2d4387ee-2011-449e-a32b-87f9366f3ef4",
    "TotalCount": 2,
    "RedisBackupSet": [
      {
        "StartTime": "2018-09-04 12:51:21",
        "BackupId": "2e4127f8-affe-11e8-941e-4846fb00c75d",
        "BackupType": "0",
        "Status": 2,
        "Remark": "For testing",
        "Locked": 0
      },
      {
        "StartTime": "2018-09-04 12:53:06",
        "BackupId": "6cbbf53a-affe-11e8-905b-4846fb00c75d",
        "BackupType": "0",
        "Status": 2,
        "Remark": "xxx",
        "Locked": 0
      }
    ]
  }
}

5. Developer Resources

API Explorer

API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

TCCLI

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
InternalError.InternalError Internal error.
InvalidParameter.InvalidParameter Application parameter error.
ResourceNotFound.InstanceNotExists No Redis instance found by the specified serialId.
UnauthorizedOperation.NoCAMAuthed The operation performed is not authorized by CAM.