Updated on 2026-08-25 GMT+08:00

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 the request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:backup:download	write	-	-	-	-

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. You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. 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 The minimum number of elements in backups is 1, and each element must be unique. Range You can obtain the value of this parameter from id in Table 3 by calling the API for obtaining backups. Default Value N/A
instance_id	Yes	String	Definition Instance ID. Constraints N/A Range You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Default Value N/A
destination	Yes	String	Definition Name of the destination OBS bucket. Constraints N/A Range You can obtain the value of this parameter from the returned Bucket.Name by calling the API for obtaining the bucket list. 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 96 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":[ 
        { 
         "backup_id":"38e7f95bc332408e9b4d6409fc28f9a0br01", 
          "status":"Success", 
          "job_id":"9b0b2a50-e2ea-468a-90ce-a777217b7570" 
        } 
    ] 
}

Abnormal response
For details, see Abnormal Response Results.

Status Code

Normal
200
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup and Restoration