Transferring Backups to an OBS Bucket (RDS for MySQL)

Function

This API is used to transfer backups of a DB instance to an OBS bucket.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

URI

URI format
POST /v3/{project_id}/instances/{instance_id}/backups/transfer

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Parameters
Parameter	Mandatory	Type	Description
backups	Yes	Array of String	Definition List of backup IDs. Constraints N/A Range The minimum number of elements in backups is 1, and each element must be unique. Default Value N/A
instance_id	Yes	String	Definition Instance ID. Constraints N/A Range N/A Default Value N/A
destination	Yes	String	Definition Name of the destination OBS bucket. Constraints N/A Range 0 to 128 characters Default Value N/A
prefix	No	String	Definition Prefix of the storage location in the destination OBS bucket. Constraints N/A Range The value can contain 0 to 128 characters and must end with a slash (/). Default Value N/A

Example Request

Transfer backups of a DB instance to an OBS bucket.

POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/e38d120bb5a640519fb2a1613140afd9in01/backups/transfer

{ 
     "instance_id":"9addef3bcf264a8a82e710d62b3f1439in01", 
     "backups":[ 
     "38e7f95bc332408e9b4d6409fc28f9a0br01" 
    ], 
     "destination":"obs-test", 
     "prefix":"test/" 
}

Response

Normal response

**Table 3** Parameters
Parameter	Type	Description
results	Array of objects	Definition Transfer task results. For details, see Table 4.

**Table 4** results field description
Parameter	Type	Description
backup_id	String	Definition Backup ID. Range N/A
status	String	Definition Task submission status. Range Success: The task is successfully submitted.
job_id	String	Definition Task ID. Range N/A

Example normal response

{ 
    "results":[ 
        { 
         "backupId":"38e7f95bc332408e9b4d6409fc28f9a0br01", 
             "status":"Success", 
             "jobId":"9b0b2a50-e2ea-468a-90ce-a777217b7570" 
        } 
    ] 
}