查询单个本地代理网关实例信息

查询单个本地代理网关实例的详细信息。

请求 URL

GET {base_url}/{api_path}/onsiteproxy/get?access_token={access_token}

请求参数

参数 是否必填 类型 说明
id 是 Integer 本地代理网关实例的唯一 ID。
注： 可使用 搜索特定本地代理网关实例 查询实例 ID。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Object<Proxy_DetailInfo> 本地代理网关实例的详细信息。
Proxy_DetailInfo
参数 类型 说明
id Integer 实例 ID。
uuid String 实例 UUID.
name String 实例名称。
platform String 部署实例的操作系统。
version String 实例的版本。
intranet_ip String 实例的内网 IP 地址。
public_ip String 实例的公网 IP 地址。
intranet_port Integer 实例的内部端口。
audio_rtp_passthrough Integer 语音 RTP 透传功能是否已启用。
  • 0: 禁用
  • 1: 启用
status String PBX 和实例之间的连接状态。
  • connected：PBX 和实例正常连接。
  • disconnected：PBX 和实例连接断开。
  • abnormal：实例的系统资源使用率超出以下任一阈值：
    • CPU 使用率超过 85%。
    • 内存 使用率超过 85%。
    • 磁盘使用率超过 95%。
status_update_time Integer 连接状态最近一次更新的时间戳。
phone_count Integer 话机数，即关联的 IP 话机总数，包括该实例通过 PnP 方式自动发现的话机和通过该实例注册的其他话机。
online_phone_count Integer 在线话机数，即通过该实例成功注册 PBX 分机的 IP 话机数量。
last_report_time Integer 实例最近一次向 PBX 上报数据的时间戳。
cpu_usage Number 实例的 CPU 使用率。
memory_usage Number 实例的内存使用率。
disk_usage Number 实例的磁盘使用率。
create_time Integer 创建实例的时间戳。
update_time Integer 除话机数和在线话机数外，实例的其他数据最近一次更新的时间戳。
secret_key_activated Integer 密钥是否被激活。
  • 0：未激活
  • 1：已激活
connection_address String PBX 服务器的连接地址。

示例

请求示例

查询本地代理网关实例 (ID: 47) 的详细信息。

GET /openapi/v1.0/onsiteproxy/get?id=47&access_token=q0GyBcsgO8FsXWxPpzAJVW33vd0OpnUz HTTP/1.1
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 47,
        "uuid": "67XXX-XXXX-XXXX-XXXX-XXXXXXXXXf42",
        "name": "Proxy_033",
        "platform": "linux",
        "version": "99.0.0.9",
        "intranet_ip": "172.17.0.19",
        "public_ip": "192.0.2.10",
        "intranet_port": 5060,
        "audio_rtp_passthrough": 1,
        "status": "disconnected",
        "status_update_time": 1772604748,
        "phone_count": 2,
        "online_phone_count": 1,
        "last_report_time": 1772604682,
        "cpu_usage": 2.218301,
        "memory_usage": 37.12323,
        "disk_usage": 52.622917,
        "create_time": 1769753210,
        "update_time": 1772422943,
        "secret_key_activated": 1,
        "connection_address": "198.51.100.10"
    }
}