获取备份文件的备份状态

获取指定备份文件的备份状态。

请求 URL

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

请求参数

参数 是否必填 类型 说明
file_name Integer 备份文件名称。
注: 可使用 搜索特定备份文件 接口查询备份文件名称。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
status String 备份文件的备份状态。
  • success:备份成功。
  • failed:备份失败。
  • processing:正在备份。

示例

请求示例

查询指定备份文件的备份状态 (Name: Backup-X.20.0.X-20250827140801-local.bak)。

GET /openapi/v1.0/backup/getstatus?access_token=bnmkmFeDCGp1HlKRuMGMUxF1ZA76qer1&file_name=Backup-X.20.0.X-20250827140801-local.bak HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "status": "success"
}