Query the Restore Status
Query the latest restore status for a specific Cloud PBX.
Request URL
GET {base_url}/dm/open_api/v1/backup_file/restore_result/{restoreDstPbxSn}
Request parameters
Path Parameter
Parameter | Required | Type | Description |
---|---|---|---|
restoreDstPbxSn | Yes | String | The serial number of the PBX system to be restored. Note: You can query the serial number of a
PBX system using Query All the Cloud PBXs. |
Headers
Parameter | Required | Type | Description |
---|---|---|---|
Authorization | Yes | String | Pass the access token in the header. Format: Bearer {access_token}. |
Response parameters
Parameter | Type | Description |
---|---|---|
data | Object <Details> | The detailed information. |
requestId | String | The unique ID of the request, which can be used to quickly locate the request. |
status | String | Request result:
|
time | Long | The response time. Note: The YCM API response returns a
timestamp, you can convert the timestamp to detailed
date and time as needed. For more information, see Convert Timestamp to Local Date and Time.
|
Details
Parameter | Type | Description |
---|---|---|
state | String | The restore status of a Cloud PBX.
|
Example
Request example
GET /dm/open_api/v1/backup_file/restore_result/3658B50690XXXXXX HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwicmVmcmVzaFZlcnNpb24iOjE2MzkwMTIwODh9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjM5MDEzODg4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI3MGI3N2NiOC03MzZjLTQxODctYjM2Yy0xNjM0MzNlZWJjNWEiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9._I0umqPvrMKnL1tlkragMjkuGWcYg1SAoTimfyKl7i8
Response
exampleHTTP/1.1 200 OK
{
"data": {
"state": "finished"
},
"requestId": "8fed5890-0c8e-4444-96d2-99b13ace6408",
"status": "Success",
"time": 1670309208
}