还原备份包

还原备份包到指定的 P 系列云 PBX。

限制条件

了解以下关于数据还原的限制条件：

  • 要还原的 PBX 系统必须处于 运行 状态。
  • 备份包的固件版本不得高于要还原的 PBX 系统的固件版本。
    提示： 可在备份包名称 “PCE-Backup-{firmware_version}-{backup_time}” 中查看固件版本信息。
    例如：
    • 备份包固件版本为 v84.5.0.55，PBX 固件版本为 v84.5.0.57，那么系统可以还原备份数据。
    • 备份包固件版本为 v84.5.0.57，PBX 固件版本为 v84.5.0.55，那么系统无法还原备份数据。

请求 URL

POST {base_url}/dm/open_api/v1/backup_file/restore

请求参数

请求头
参数 是否必填 类型 描述
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 描述
backupFileId 是 Long 要还原的备份包的 ID。
注：
  • 须确保备份包的固件版本不高于要还原的 PBX 系统的固件版本，否则还原会失败。可在备份包名称中查看固件版本信息。
  • 可使用 查询所有备份包 接口查询备份包 ID 和名称。
restoreDstPbxSn 是 String 要还原的 PBX 系统的序列号 (SN)。
注： 可使用 查询所有云 PBX 接口查询 PBX 序列号。

响应参数

参数 类型 描述
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。

示例

请求示例

POST /dm/open_api/v1/backup_file/restore HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwicmVmcmVzaFZlcnNpb24iOjE2MzkwMTIwODh9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjM5MDEzODg4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI3MGI3N2NiOC03MzZjLTQxODctYjM2Yy0xNjM0MzNlZWJjNWEiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9._I0umqPvrMKnL1tlkragMjkuGWcYg1SAoTimfyKl7i8
Content-Type: application/json
{
  "backupFileId": 1079,
  "restoreDstPbxSn":"3658B50690XXXXXX"
}
响应示例
HTTP/1.1 200 OK
{
  "requestId": "2f62e5ab-2518-460e-89bb-c18ea3513232",
  "status": "Success",
  "time": 1670308450
}