DescribeInstanceBackups

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeInstanceBackups.
Version	Yes	String	Common parameter. The value used for this API: 2018-04-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	ID of the instance to be operated on, which can be obtained through the `InstanceId` field in the return value of the DescribeInstance API.
Limit	No	Integer	Instance list size. Default value: 20
Offset	No	Integer	Offset, which is an integral multiple of `Limit`
BeginTime	No	String	Start time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 16:46:34. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range.
EndTime	No	String	End time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 19:09:26. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range.
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 unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

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

Output Example

{
  "Response": {
    "RequestId": "2d4387ee-2011-449e-a32b-87f9366f3ef4",
    "TotalCount": 2
  }
}

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

Tencent Cloud CLI 3.0

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.DbOperationFailed	Internal system error with the database operation, which may be update, insert, select, etc.
InternalError.InternalError	Internal error.
InvalidParameter.InvalidParameter	Invalid service parameter.
InvalidParameter.PermissionDenied	The API has no CAM permissions.
ResourceNotFound.InstanceNotExists	No Redis instance is found by the serialId.
UnauthorizedOperation.NoCAMAuthed	No CAM permissions.

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

腾讯云合作伙伴网络

成为合作伙伴

国际合作伙伴学院

Recent Pages