Release Notes
Announcements
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.
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. |
| 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. |
This example shows you how to query the backup information of a specified instance backup ID through this API.
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"
}{
"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
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários