查询还原状态

查询指定云 PBX 最近一次还原操作的状态。

请求 URL

GET {base_url}/dm/open_api/v1/backup_file/restore_result/{restoreDstPbxSn}

请求参数

路径参数

参数 是否必填 类型 描述
restoreDstPbxSn 是 String 要还原的 PBX 系统的序列号 (SN)。
注： 可使用 查询所有云 PBX 接口查询 PBX 序列号。
请求头
参数 是否必填 类型 描述
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。

响应参数

参数 类型 描述
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
state String 云 PBX 备份包还原的执行状态。
  • restoring：正在还原备份包。
  • finished：还原操作已执行完成。
  • error：还原操作失败。
    故障： 还原操作失败可能由以下原因导致：
    • 备份包固件版本高于 PBX 系统的固件版本。
    • 备份包损坏或不兼容。

示例

请求示例

GET /dm/open_api/v1/backup_file/restore_result/3658B50690XXXXXX HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwicmVmcmVzaFZlcnNpb24iOjE2MzkwMTIwODh9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjM5MDEzODg4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI3MGI3N2NiOC03MzZjLTQxODctYjM2Yy0xNjM0MzNlZWJjNWEiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9._I0umqPvrMKnL1tlkragMjkuGWcYg1SAoTimfyKl7i8
响应示例
HTTP/1.1 200 OK
{
  "data": {
    "state": "finished"
  },
  "requestId": "8fed5890-0c8e-4444-96d2-99b13ace6408",
  "status": "Success",
  "time": 1670309208
}