查询备份文件列表

查询备份文件列表。

请求 URL

GET {base_url}/{api_path}/backup/list?access_token={access_token}

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • file_name
  • backup_time
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 备份文件总数。
backup_list Array<Backup_Info> 备份文件的信息。
Backup_Info
参数 类型 说明
file_name String 备份文件的名称。
backup_time String 备份时间。
memo String 备份文件的备注。

示例

请求示例

GET /openapi/v1.0/backup/list?access_token=sTxrM4A46DKnXvmC7MgudkEgPEJABBQ6&page=1&page_size=2&sort_by=file_name&order_by=asc HTTP/1.1 

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 3,
    "backup_list": [
        {
            "file_name": "Backup-X.18.0.89-20250313132238-local.bak",
            "backup_time": "2025/03/13 13:24:15",
            "memo": ""
        },
        {
            "file_name": "Backup-X.18.0.45-20250208112520-local.bak",
            "backup_time": "2025/02/08 11:27:15",
            "memo": ""
        }
    ]
}