搜索特定本地代理网关实例

在本地代理网关实例列表搜索特定本地代理网关实例。

请求 URL

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

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • statusname
  • platform
  • version
  • intranet_ip
  • public_ip
  • phone_count
  • online_phone_count
  • audio_rtp_passthrough
  • status_update_time
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序
search_value 否 String 搜索关键字。
name 否 String 基于本地代理网关实例的名称进行模糊搜索。
注： 最大字符长度为 128。
intranet_ip 否 String 基于本地代理网关实例的内网 IP 地址进行模糊搜索。
注： 最大字符长度为 64。

响应参数

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

示例

请求示例

从本地代理网关实例列表中搜索内网 IP 地址为 172.17.0.16 的本地代理网关实例。

GET /openapi/v1.0/onsiteproxy/search?page=1&page_size=20&sort_by=status&order_by=asc&intranet_ip=172.17.0.16&access_token=WoAp9s3hYXSWgD5ZdOAhpGNvgnl8SufF HTTP/1.1
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "data": [
        {
            "id": 50,
            "uuid": "71XXX-XXXX-XXXX-XXXX-XXXXXXXXXc52",
            "name": "Proxy_036",
            "platform": "linux",
            "version": "99.0.0.9",
            "intranet_ip": "172.17.0.16",
            "public_ip": "192.0.2.112",
            "audio_rtp_passthrough": 1,
            "status": "connected",
            "phone_count": 5,
            "online_phone_count": 3,
            "create_time": 1769753210,
            "update_time": 1772422951
        }
    ],
    "connection_url": "198.51.100.10"
}