查询云 PBX 状态

查询指定云 PBX 的激活状态和运行状态。

请求 URL

GET {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/status

请求参数

路径参数
参数 是否必填 类型 描述
cloudPbxId 是 Long 云 PBX 的 ID。
注： 可使用 查询所有云 PBX 接口查询云 PBX ID。
请求头
参数 是否必填 类型 描述
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。

响应参数

参数 类型 描述
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
cloudPbxId Long 云 PBX 的 ID。
pbxStatus String 云 PBX 的运行状态。
  • Stopped：PBX 停止运行
  • Starting：PBX 正在启动
  • Running：PBX 正在运行
  • Upgrading：PBX 正在升级
  • Restoring：PBX 正在还原数据
  • Provisioning：PBX 正在部署中
activationStatus String 云 PBX 的激活状态。
  • Activated：已激活
  • Unactivated：未激活

示例

请求示例

查询云 PBX (ID: 7738) 的状态。
GET /dm/open_api/v1/cloud_pbx/instances/7738/status
Host:ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0NDE5NjF9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDQzNzYwLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiIwNzM2ZDJkMS0wMDZjLTQ1ZmUtYTBiZS0zNWNjNjIxNTVmYjIiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.h3Hz2suOlciWP9X8bxrAtsOaoCGEFad76kWc3xxk-nQ
响应示例
HTTP/1.1 200 OK
{
  "data": {
    "cloudPbxId": 7738,
    "pbxStatus": "Running",
    "activationStatus": "Activated"
  },
  "requestId": "9a83eba1eda1cc4d12c0cc17db543fa5",
  "status": "Success",
  "time": 1664441966
}