查询所有备份包

查询所有备份包的信息。

请求 URL

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

请求参数

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

格式：Bearer {access_token}。
查询参数
参数 是否必填 类型 说明
pageNumber 否 Integer 定义显示第几个页面。
  • 默认值：1
pageSize 否 Integer 定义每页显示几项查询结果。
  • 默认值：10
  • 最大值：50
sort 否 String 定义排序字段。

可在排序字段中填入 响应参数，对查询结果进行排序。

示例：
  • backupFileId：查询结果根据备份包的 ID 升序排序。
  • -backupFileId：查询结果根据备份包的 ID 降序排序。

响应参数

参数 类型 说明
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 说明
pageSize Integer 每页显示几项查询结果。
pageNumber Integer 当前显示第几页。
total Integer 备份包总数量。
list Array <BackupFile_Info> 备份包信息。
BackupFile_Info
参数 类型 说明
backupFileId Long 备份包的唯一 ID。
backupFileType String 生成备份包的源 PBX 的类型。
  • cloud_pbx：云 PBX
backupTime Long 生成备份包的时间。
注： 此字段返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
backupFileName String 备份包名称。
backupFileSourcePbxName String 生成备份包的源 PBX 的名称。
注： 只有在备份包是通过备份任务生成时，才会返回此参数。
backupFileSourcePbxSn String 生成备份包的源 PBX 的序列号 (SN)。
注： 只有在备份包是通过备份任务生成时，才会返回此参数。
backupFileTaskName String 备份任务名称。
注： 只有在备份包是通过备份任务生成时，才会返回此参数。
backupFileTaskId String 备份任务 ID。
注： 只有在备份包是通过备份任务生成时，才会返回此参数。
backupFileRemark String 备注。

示例

请求示例

查询所有备份包：
  • 每页显示 3 条记录。
  • 显示第 1 页。
  • 查询结果根据备份包 ID 降序排序。
GET /dm/open_api/v1/backup_file?pageSize=3&pageNumber=1&sort=-backupFileId HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwicmVmcmVzaFZlcnNpb24iOjE2MzkwMTIwODh9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjM5MDEzODg4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI3MGI3N2NiOC03MzZjLTQxODctYjM2Yy0xNjM0MzNlZWJjNWEiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9._I0umqPvrMKnL1tlkragMjkuGWcYg1SAoTimfyKl7i8
响应示例
HTTP/1.1 200 OK
{
  "data": {
    "pageSize": 3,
    "pageNumber": 1,
    "total": 100,
    "list": [
      {
        "backupFileId": 98,
        "backupFileType": "cloud_pbx",
        "backupTime": 1669237535,
        "backupFileName": "PCE-Backup-84.9.0.8-20221206141900.bak",
        "backupFileSourcePbxName": "P-Series CE2",
        "backupFileSourcePbxSn": "3658B50690XXXXXXX",
        "backupFileTaskName": "Test",
        "backupFileTaskId": 379,
        "backupFileRemark": "for test"
      },
      {
        "backupFileId": 95,
        "backupFileType": "cloud_pbx",
        "backupTime": 1669237474,
        "backupFileName": "PCE-Backup-84.9.0.18-20221205174036.bak",
        "backupFileSourcePbxName": "P-Series PBX",
        "backupFileSourcePbxSn": "3658B43111XXXXXX",
        "backupFileTaskName": "backupfile",
        "backupFileTaskId": 378,
        "backupFileRemark": ""
      },
      {
        "backupFileId": 94,
        "backupFileType": "cloud_pbx",
        "backupTime": 1669237447,
        "backupFileName": "PCE-Backup-84.9.0.18-20221205173707.bak",
        "backupFileSourcePbxName": "Test_PBX-21205",
        "backupFileSourcePbxSn": "3658B43111XXXXXX",
        "backupFileTaskName": "Cloud PBX",
        "backupFileTaskId": 377,
        "backupFileRemark": ""
      }
    ]
  },
  "requestId": "5c7db8bc-2511-4c7c-9391-af3b72ca2717",
  "status": "Success",
  "time": 1670305586
}