查询可用固件版本

查询指定区域中星纵统一管理平台、集群服务器或 P 系列云 PBX 的可用固件版本。

请求 URL

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

请求参数

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

格式：Bearer {access_token}。
查询参数
参数 是否必填 类型 描述
type 是 String 固件类型。
取值范围：
  • pbx：P 系列云 PBX 固件
  • cluster：SBC 服务器、SBC Proxy 服务器或 PBXHub 服务器固件
  • cm：星纵统一管理平台固件
regionIds 否 Array <Integer> 区域的 ID 列表。
注： 可使用 查询可用区域 接口查询区域 ID。

响应参数

参数 类型 描述
data Array <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
versionId Integer 固件版本 ID。
version String 固件版本号。
regionIds Array <Integer> 存在此固件版本的区域 ID 列表。

示例

请求示例

查询指定区域 (ID：16) 可用的 PBX 固件。
GET /dm/open_api/v1/firmware?type=pbx&regionIds=16 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjM1NTkwMDZ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjYzNTYwODA2LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2N2FmZDY4OS01N2M4LTQ3ZjAtYjg5OS04MmJjNjMzZjZhNmQiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.RkrDaoBpepDUY4FurjRsRZ8JvlwVbEdPguWgsHIjFuk
响应示例
HTTP/1.1 200 OK
{
  "data": [
    {
      "versionId": 764,
      "version": "84.8.0.25",
      "regionIds": [
        4,
        16
      ]
    },
    {
      "versionId": 757,
      "version": "84.7.0.51",
      "regionIds": [
        16,
        4
      ]
    }, 
    {
      "versionId": 237,
      "version": "84.6.0.47",
      "regionIds": [
        4,
        16,
        22,
        24,
        28
      ]
    }
  ],
  "requestId": "9a981b12-2cf5-40c9-9b32-498913222ba3",
  "status": "Success",
  "time": 1664275935
}