tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBackupDetail

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

1. API Description

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

This API is used to query the backup details of an instance.

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: DescribeBackupDetail.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID. Log in to the Redis console and copy it in the instance list.
BackupId Yes String Backup ID, which can be obtained through the response parameter RedisBackupSet of the API DescribeInstanceBackups.

3. Output Parameters

Parameter Name Type Description
BackupId String Backup ID.
StartTime String Backup start time.
EndTime String Backup end time.
BackupType String Backup mode.

- 1: manual backup.
- 0: automatic backup.
Status Integer Backup status.

- 1: The backup is locked by other processes.
- 2: The backup is normal and not locked by any processes.
- -1: The backup has expired.
- 3: The backup is being exported.
- 4: The backup is successfully exported.
Remark String Backup remarks.
Locked Integer Whether the backup is locked.

- 0: not locked.
- 1: locked.
BackupSize Integer Backup file size. Unit: byte.
InstanceType Integer Instance type.
MemSize Integer Memory size of a single shard. Unit: MB.
ShardNum Integer Number of shards.
ReplicasNum Integer Number of replicas.
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 Backup Information Details

This example shows you how to query the backup information of a specified instance backup ID through this API.

Input Example

POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupDetail
<Common request parameters>

{
    "InstanceId": "crs-g9my5vt7",
    "BackupId": "154571841-1165701309-438602494"
}

Output Example

{
    "Response": {
        "BackupId": "154571841-1165701309-438602494",
        "BackupSize": 528,
        "BackupType": "0",
        "EndTime": "2022-12-19 19:42:20",
        "InstanceType": 9,
        "Locked": 0,
        "MemSize": 2048,
        "Remark": "test005",
        "ReplicasNum": 1,
        "RequestId": "add15b91-8f3c-4ff3-ba52-7c64c9c435ba",
        "ShardNum": 3,
        "StartTime": "2022-12-19 19:41:42",
        "Status": 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

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
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
InternalError.InternalError Internal error.
InvalidParameter.PermissionDenied The API has no CAM permissions.
InvalidParameterValue.BackupNotExists The backup does not exist.
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy