tencent cloud

Tencent Cloud Distributed Cache (Redis OSS-Compatible)

DocumentaçãoTencent Cloud Distributed Cache (Redis OSS-Compatible)API DocumentationBackup and Restoration APIsDescribeBackupDetail

DescribeBackupDetail

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-08-14 16:53:27

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 from 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 method.

  • 1: Manual backup.
  • 0: Auto-backup.
Status Integer

Backup status.

  • 1: Backup is locked by other processes.
  • 2: Backup is normal, not locked by any processes.
  • -1: Backup has expired.
  • 3: Backup is being exported.
  • 4: Backup export successful.
Remark String

Backup remarks.
Locked Integer

Backup lock status.

  • 0: Unlocked.
  • 1: Has been locked.
BackupSize Integer

Backup file size. Measurement 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.
Encrypted Boolean

Whether it is encrypted or not.

Enumeration value:

  • true: Encrypted
  • false: Unencrypted
DecryptKey String

Decryption key.
KmsKeyId String

Key ID of the key in KMS.
KeyAlgorithm String

Encryption algorithm used to encrypt the backup file.

Enumeration value:

  • AES-256-CBC: Currently only support AES-256-CBC.
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,
        "DecryptKey": "rFGxk4E**********************U/nWERxvFx+FAY=",
        "KmsKeyId": "b2f531ee-****-****-b8b2-52540087****"
    }
}

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.
Anterior: DescribeInstanceSpecBandwidthPróximo: DescribeBackupDownloadRestriction

Ajuda e Suporte

Esta página foi útil?

comentários