Querying Transfer Tasks (RDS for MySQL)

Function

This API is used to query transfer tasks of a DB instance.

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

URI

URI format
GET /v3/{project_id}/transfer-info

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
offset	Yes	Integer	Definition Page number. Constraints N/A Range The minimum value is 1, indicating that the first page is queried. Default Value 1
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints N/A Range Minimum value: 0 Default Value 10

**Table 2** Parameters
Parameter	Mandatory	Type	Description
order_field	No	String	Definition Sorting field. Constraints N/A Range N/A Default Value N/A
order_rule	No	String	Definition Sorting rule. Constraints N/A Range N/A Default Value N/A
filter_field	No	String	Definition Filter fields. Constraints N/A Range N/A Default Value N/A
filter_content	No	String	Definition Filter keywords. Constraints N/A Range N/A Default Value N/A
begin_time	No	Long	Definition Start timestamp. Constraints N/A Range N/A Default Value N/A
end_time	No	Long	Definition End timestamp. Constraints N/A Range N/A Default Value N/A
transfer_type	No	String	Definition Type of transfer tasks. Constraints N/A Range manual: manual transfer task auto: automatic transfer task Default Value manual

Request

None

Example Request

Query transfer tasks of a DB instance.

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/transfer-info

Response

Normal response

**Table 3** Parameters
Parameter	Type	Description
total	Long	Definition Number of tasks. Range N/A
transfer_list	Array of objects	Definition Task list. For details, see Table 4.

**Table 4** transfer_list field description
Parameter	Type	Description
id	String	Definition Backup ID. Range N/A
name	String	Definition Backup name. Range N/A
begin_time	Long	Definition Task start time. Range N/A
end_time	Long	Definition Task end time. Range N/A
status	String	Definition Task status. Range N/A
size	Double	Definition Object size, in KB. Range N/A
instance_id	String	Definition Instance ID. Range N/A
file_name	String	Definition Name of the object to be transferred. Range N/A
destination	String	Definition Destination bucket name. Range N/A
backup_begin_time	Long	Definition Start time for a backup transfer. Range N/A
backup_end_time	Long	Definition End time for a backup transfer. Range N/A
transfer_type	String	Definition Type of a transfer task. Range manual: manual transfer task auto: automatic transfer task
type	String	Definition Type of backups to be transferred. Range db: automated backup log: incremental backup snapshot: manual backup
prefix	String	Definition Prefix of the transfer destination. Range The value can contain 0 to 128 characters and must end with a slash (/).

Example normal response

{ 
    "total":3, 
    "transfer_list":[ 
        { 
            "id":"38e7f95bc332408e9b4d6409fc28f9a0br01", 
            "name":"mysql-local-adf1-20250305072705950", 
            "begin_time":1741171386518, 
            "end_time":1741171389039, 
            "status":"Completed", 
            "size":3607.899415, 
            "instance_id":"9addef3bcf264a8a82e710d62b3f1439in01",
         "file_name":"test/0cf6f193231e41feac6deabbf6620274_9addef3bcf264a8a82e710d62b3f1439in01_Db_38e7f95bc332408e9b4d6409fc28f9a0br01_20250305072659001_20250305072705879_2c6b7a6bd85b4a4596673e37acc732deno01_xbcloud_.qp/0cf6f193231e41feac6deabbf6620274_9addef3bcf264a8a82e710d62b3f1439in01_Db_38e7f95bc332408e9b4d6409fc28f9a0br01_20250305072659001_20250305072705879_2c6b7a6bd85b4a4596673e37acc732deno01_xbcloud_.qp", 
            "destination":"obs-4144" 
        }, 
        { 
            "id":"38e7f95bc332408e9b4d6409fc28f9a0br01", 
            "name":"mysql-local-adf1-20250305072705950", 
            "begin_time":1741171082762, 
            "end_time":1741171087592, 
            "status":"Completed", 
            "size":3607.899415, 
            "instance_id":"9addef3bcf264a8a82e710d62b3f1439in01", 
         "file_name":"0cf6f193231e41feac6deabbf6620274_9addef3bcf264a8a82e710d62b3f1439in01_Db_38e7f95bc332408e9b4d6409fc28f9a0br01_20250305072659001_20250305072705879_2c6b7a6bd85b4a4596673e37acc732deno01_xbcloud_.qp/0cf6f193231e41feac6deabbf6620274_9addef3bcf264a8a82e710d62b3f1439in01_Db_38e7f95bc332408e9b4d6409fc28f9a0br01_20250305072659001_20250305072705879_2c6b7a6bd85b4a4596673e37acc732deno01_xbcloud_.qp", 
            "destination":"obs-rdstest1" 
        }, 
        { 
            "id":"38e7f95bc332408e9b4d6409fc28f9a0br01", 
            "name":"mysql-local-adf1-20250305072705950", 
            "begin_time":1741166966484, 
            "end_time":1741166970807, 
            "status":"Completed", 
            "size":3607.899415, 
            "instance_id":"9addef3bcf264a8a82e710d62b3f1439in01", 
         "file_name":"0cf6f193231e41feac6deabbf6620274_9addef3bcf264a8a82e710d62b3f1439in01_Db_38e7f95bc332408e9b4d6409fc28f9a0br01_20250305072659001_20250305072705879_2c6b7a6bd85b4a4596673e37acc732deno01_xbcloud_.qp/0cf6f193231e41feac6deabbf6620274_9addef3bcf264a8a82e710d62b3f1439in01_Db_38e7f95bc332408e9b4d6409fc28f9a0br01_20250305072659001_20250305072705879_2c6b7a6bd85b4a4596673e37acc732deno01_xbcloud_.qp", 
            "destination":"obs-rdstest1" 
        } 
    ] 
}