文档首页/ 云数据库 RDS/ API参考/ API v3(推荐)/ 备份与恢复/ 查询转储任务列表(MySQL)
更新时间:2025-07-16 GMT+08:00
分享

查询转储任务列表(MySQL)

功能介绍

查询转储任务列表。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    GET /v3/{project_id}/transfer-info

  • 参数说明
    表1 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    参数解释

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    offset

    Integer

    参数解释

    分页页码。

    约束限制

    不涉及。

    取值范围

    最小值为1,表示查询第1页。

    默认取值

    1

    limit

    Integer

    参数解释

    每页展示条数。

    约束限制

    不涉及。

    取值范围

    最小值为0。

    默认取值

    10

    表2 参数说明

    名称

    是否必选

    参数类型

    说明

    order_field

    String

    参数解释

    排序字段。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    order_rule

    String

    参数解释

    排序规则。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    filter_field

    String

    参数解释

    筛选字段。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    filter_content

    String

    参数解释

    筛选关键字。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    begin_time

    Long

    参数解释

    开始时间戳。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    end_time

    Long

    参数解释

    结束时间戳。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    transfer_type

    String

    参数解释

    转储任务类型。

    约束限制

    不涉及。

    取值范围

    • manual:手动转储任务。
    • auto:自动转储任务。

    默认取值

    manual

请求消息

无。

请求示例

查询转储任务列表。

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

响应消息

  • 正常响应要素说明
    表3 要素说明

    参数

    参数类型

    描述

    total

    Long

    参数解释

    任务数量。

    取值范围

    不涉及。

    transfer_list

    Array of objects

    参数解释

    任务列表。详情请参见表4

    表4 transfer_list字段说明

    名称

    参数类型

    说明

    id

    String

    参数解释

    备份ID。

    取值范围

    不涉及。

    name

    String

    参数解释

    备份名称。

    取值范围

    不涉及。

    begin_time

    Long

    参数解释

    开始时间。

    取值范围

    不涉及。

    end_time

    Long

    参数解释

    结束时间。

    取值范围

    不涉及。

    status

    String

    参数解释

    任务状态。

    取值范围

    不涉及。

    size

    Double

    参数解释

    对象大小,单位为KByte。

    取值范围

    不涉及。

    instance_id

    String

    参数解释

    实例ID。

    取值范围

    不涉及。

    file_name

    String

    参数解释

    目标对象名称。

    取值范围

    不涉及。

    destination

    String

    参数解释

    目标桶名。

    取值范围

    不涉及。

    backup_begin_time

    Long

    参数解释

    转储备份起始时间。

    取值范围

    不涉及。

    backup_end_time

    Long

    参数解释

    转储备份结束时间。

    取值范围

    不涉及。

    transfer_type

    String

    参数解释

    转储任务类型。

    取值范围

    • manual:手动转储任务。
    • auto:自动转储任务。

    type

    String

    参数解释

    转储备份类型。

    取值范围

    • db:自动备份。
    • log:增量备份。
    • snapshot:手动备份。

    prefix

    String

    参数解释

    转储目标前缀。

    取值范围

    0~128个字符,以分隔符“/”结尾。

  • 正常响应样例
    { 
        "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" 
            } 
        ] 
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档