tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ManualBackupInstance

Last updated: 2024-04-03 11:33:35

    1. API Description

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

    This API is used to manually back up 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: ManualBackupInstance.
    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 a specified instance, such as "crs-xjhsdj****" Log in to the Redis console and copy the instance ID in the instance list.
    Remark No String Remarks for manual backup task
    StorageDays No Integer Retention period of backup data in days. Default value: 7 days. Value range: [0,1825]. If the value exceeds 7 days, submit a ticket for application. - If this parameter is not configured, it will set to be the same as the period of automatic backup retention. - If automatic backup is not set, the default value will be 7 days.

    3. Output Parameters

    Parameter Name Type Description
    TaskId Integer Task ID
    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 Sample request

    This example shows you how to manually back up an instance.

    Input Example

    https://redis.tencentcloudapi.com/?Action=ManualBackupInstance&InstanceId=crs-5a4p****&Remark=xxxx&<Common request parameters>

    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.CommitFlowError Failed to submit the task.
    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.
    ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy