tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for Redis®
    Documentation
    Download PDF

    RestoreInstance

    Last updated: 2024-04-03 11:33:33
    Download PDF

      1. API Description

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

      This API is used to restore a Redis 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: RestoreInstance.
      Version Yes String Common Params. The value used for this API: 2018-04-12.
      Region No String Common Params. This parameter is not required for this API.
      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 DescribeInstances API.
      BackupId Yes String Backup ID, which can be obtained through the backupId field in the return value of the GetRedisBackupList API.
      Password No String Instance password, which needs to be validated during instance restoration (this parameter is not required for password-free instances)

      3. Output Parameters

      Parameter Name Type Description
      TaskId Integer Task ID, which can be used to query the task execution status through the DescribeTaskInfo API.
      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 Restoring a Redis Instance

      Input Example

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

{
    "InstanceId": "crs-5a4py64p",
    "BackupId": "678362566696298532848117",
    "Password": "mypassword"
}

      Output Example

      {
    "Response": {
        "TaskId": "6954227",
        "RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"
    }
}

      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.InternalError Internal error.
      InvalidParameter.InvalidParameter Invalid service parameter.
      InvalidParameter.PermissionDenied The API has no CAM permissions.
      InvalidParameterValue.BackupNotExists The backup does not exist.
      InvalidParameterValue.PasswordError Password verification error due to incorrect password.
      ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
      ResourceUnavailable.BackupLockedError The backup has been locked by another task, and the operation cannot be performed temporarily.
      ResourceUnavailable.BackupSpecError Backup and recovery specifications are not supported.
      ResourceUnavailable.BackupStatusAbnormal Backup status exception. The operation cannot be performed temporarily. The backup may have expired or been deleted.
      ResourceUnavailable.InstanceLockedError Redis has been locked by another process.
      ResourceUnavailable.InstanceStateError Instance status error.
      ResourceUnavailable.InstanceStatusAbnormal The Redis status is exceptional, and the corresponding process cannot be executed.
      UnauthorizedOperation.NoCAMAuthed No CAM permissions.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy