MENU
      exportBackupToObjectStorage

        exportBackupToObjectStorage


        Article summary

        Available in VPC

        Send Cloud DB for Redis backup files to Object Storage.
        To send backup files to Object Storage, Object Storage buckets for storing and searching backup files must be created in advance. For more information, see the Object Storage Guide.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        GET, POST/exportBackupToObjectStorage

        Request headers

        For headers common to Cloud DB for Redis APIs, see Cloud DB for Redis request headers.

        Request parameter

        The following describes the parameters.

        FieldTypeRequiredDescription
        regionCodeStringOptionalRegion code of the Cloud DB for Redisinstance whose backup file you want to send to Object Storage
        • Check through getRegionList
        • First Region of the getRegionList query result (default)
        fileNameStringRequiredName of the backup file
        bucketNameStringRequiredName of the Object Storage bucket the backup file will be sent to
        cloudRedisInstanceNoStringRequiredCloud DB for Redis instance number
        backupTypeModeStringRequiredCloud DB for Redis backup type
        • SYSTEM | MANUAL
          • SYSTEM: system backup
          • MANUAL: manual backup
        responseFormatTypeStringOptionalFormat of the response result
        • xml (default) | json

        Request example

        The following is a sample request.

        curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/exportBackupToObjectStorage
        ?regionCode=KR
        &fileName=20240702
        &bucketName=redis-backup
        &cloudRedisInstanceNo=****511
        &backupTypeMode=SYSTEM'
        --header 'x-ncp-apigw-timestamp: {Timestamp}'
        --header 'x-ncp-iam-access-key: {Access Key}'
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Curl

        Response

        The following describes the response format.

        Response status codes

        For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

        Response example

        The following is a sample response.

        • If responseFormatType=json
        {
            "exportBackupToObjectStorageResponse": {
                "requestId": "afee84ad-****-****-****-d4b359e85dca",
                "returnCode": "0",
                "returnMessage": "success"
            }
        }
        JSON
        • If responseFormatType=xml (default)
        <?xml version="1.0" encoding="UTF-8"?>
        <exportBackupToObjectStorageResponse>
            <requestId>afee84ad-****-****-****-d4b359e85dca</requestId>
            <returnCode>0</returnCode>
            <returnMessage>success</returnMessage>
        </exportBackupToObjectStorageResponse>
        XML

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.