向日葵开放API
贝锐企业+试用向日葵企业管理平台
贝锐企业+试用向日葵企业管理平台
  1. 设备信息管理
  • 📃 简介
  • 🌐 管理平台API
    • 开发者必读
      • 流程概述
      • 接入准备
      • 平台签名校验
      • 用户身份校验
      • 错误码对照表
    • 用户身份授权API
      • 身份授权
      • 续租授权
    • 核心服务API
      • 设备信息管理
        • 创建/取消主机授权
          POST
        • 获取主机列表
          GET
        • 获取单个主机基本信息
          GET
        • 修改主机
          PUT
        • 删除主机
          DELETE
        • 查询主机状态
          GET
      • 审计日志查询
        • 查询远程日志列表
        • 查询被控端(上下线)日志列表
        • 查询被控日志
        • 查询控制端最近登录日志
        • 查询文件传输日志
        • 查询操作日志
      • 资产信息查询
        • 查询IT资产列表
        • 根据资产ID查询是否有变更数据
        • 查询IT资产变更历史
      • 坐席服务管理
        • 新增坐席成员
        • 更新坐席成员
        • 查询坐席成员-列表
        • 删除坐席星标客户
        • 删除坐席成员
        • 强制下线-坐席成员
        • 查询坐席星标客户-列表
        • 查询坐席日志
      • 设备分组管理
        • 查询主机关联的分组
        • 创建主机与分组的关联
        • 创建分组
        • 删除主机与分组的关联
        • 修改分组
        • 删除分组
        • 查询分组的列表
      • 企业子账号管理
        • 子账号身份授权
        • 修改子账号信息
        • 创建企业子账号
        • 删除企业子账号
        • 查询子账号列表
        • 获取指定子账号信息
        • 查询账号分组的功能模块列表
        • 修改指定的分组功能模块
        • 获取角色分组列表
        • 新增角色分组
        • 更新角色分组
        • 删除角色分组
        • 获取组织部门列表
        • 创建部门
        • 修改部门
        • 删除部门
        • 获取功能模块列表
        • 修改企业账号密码
    • 硬件API
      • 获取插座用电量
      • 开关插座
      • 获取插座状态
  • 💻 客户端本地API
    • 开发者必读
      • 接入指南
    • 服务端API
      • 开发指南
        • 如何调用服务端API
        • 服务端API错误码对照表
      • 获取访问凭证
        • 获取客户端API访问凭证
    • 客户端API
      • 开发指南
        • 如何调用客户端API
        • 客户端API报文加解密流程
        • 客户端API错误码对照表
      • 向日葵企业主控端能力
        • 主控端调起协议
        • 指定设备ID/识别码发起远控
        • 在设备列表中定位指定设备ID并发起远控
        • 检测应用程序是否存活
      • 向日葵企业被控端能力
        • 获取当前设备信息
    • 参考
      • 调用过程及示例代码
  1. 设备信息管理

获取主机列表

GET
https://api.oraydev.cn/sl/v1/remotes
获取主机列表
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.oraydev.cn/sl/v1/remotes?keyword=00:0C:29:1D:80:CC&keyword_field=mac&limit=10&offset=0&with_info=&with_state=&with_share=&online_status=1&sort=-remote_id'
响应示例响应示例
200 - 示例 1
[
    {
        "client": "string",
        "create_time": 0,
        "ent_id": 0,
        "hostinfo": {
            "envs": [
                {
                    "id": "string",
                    "name": "string",
                    "param": "string",
                    "version": "string"
                }
            ],
            "plugins": [
                {
                    "id": "string",
                    "name": "string",
                    "param": "string",
                    "version": "string"
                }
            ]
        },
        "info": {
            "avatar": "string",
            "base_board": "string",
            "configmodifiedtime": 0,
            "contactemail": "string",
            "cpu": "string",
            "description": "string",
            "description_share": "string",
            "disk_drive": "string",
            "memory": "string",
            "name": "string",
            "network_adapter": "string",
            "os": "string",
            "os_name": "string",
            "pc_name": "string",
            "remote_id": 0,
            "tag_ids": "string",
            "version": "string",
            "versioncode": "string",
            "video_controller": "string"
        },
        "ip": "string",
        "is_connected": true,
        "is_granted": true,
        "is_mob_granted": true,
        "is_multiple": true,
        "is_package": true,
        "is_share": true,
        "lan_ip": "string",
        "license": {
            "account": "string",
            "code": "string",
            "is_bind": true,
            "key": "string",
            "level": 0,
            "password": "string",
            "remote_id": 0,
            "service_id": 0,
            "user_id": 0
        },
        "license_code": "string",
        "limit_control": "string",
        "mac": "string",
        "owner_id": 0,
        "remote_client": {
            "client_id": "string",
            "mac": "string",
            "remote_id": 0,
            "user_id": 0
        },
        "remote_id": 0,
        "state": {
            "addr": "string",
            "fastcode": "string",
            "ip": "string",
            "login_time": 0,
            "new_server": 0,
            "origin_server_ip": "string",
            "osname": "string",
            "owner_id": 0,
            "serverip": "string",
            "serverip6": "string",
            "state": 0,
            "svr_version": "string",
            "version": "string"
        },
        "statuscode": 0,
        "user": {
            "account": "string",
            "expiredate": "string",
            "host_modules": [
                "string"
            ],
            "remark": "string",
            "remote_id": 0,
            "status": 0,
            "tag_ids": [
                0
            ],
            "type": 0,
            "user_id": 0
        }
    }
]

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Query 参数
keyword
string 
搜索关键字
可选
示例值:
00:0C:29:1D:80:CC
keyword_field
string 
可选
搜索的关键字字段,可选的有:
name(缺省值,无需传值)、主机名;
description、备注;
mac、MAC地址;
ip、外网IP地址;
fastcode、识别码
示例值:
mac
limit
integer 
分页容量
可选
示例值:
10
offset
integer 
分页记录的位移
可选
示例值:
0
with_info
boolean 
是否返回设备信息
可选
with_state
boolean 
是否返回设备状态
可选
with_share
boolean 
是否返回共享状态
可选
online_status
integer 
可选
在线状态:0、所有;1、在线;2、离线
示例值:
1
sort
string 
可选
排序字段,传需要排序的字段(仅支持remote_id,online_status),如需倒序,在前面加-号,如:-remote_id
示例值:
-remote_id

返回响应

🟢200成功
application/json
OK
Headers
Content-Range
string 
可选
row [分页第几页]-[当前页主机数]-[主机总数]
Body
array of:
client
string 
客户端类型
可选
create_time
integer 
创建时间
可选
ent_id
integer 
可选
hostinfo
object (config.HostInfo) 
可选
envs
array[object (config.Env) {4}] 
可选
plugins
array[object (config.Plugin) {4}] 
可选
info
object (remote.Info) 
可选
avatar
string 
头像
可选
base_board
string 
主板
可选
configmodifiedtime
integer 
配置修改时间
可选
contactemail
string 
可选
cpu
string 
cpu
可选
description
string 
备注
可选
description_share
string 
可选
disk_drive
string 
硬盘
可选
memory
string 
内存
可选
name
string 
主机名
可选
network_adapter
string 
网卡
可选
os
string 
系统
可选
os_name
string 
设备系统
可选
pc_name
string 
设备名
可选
remote_id
integer 
主机ID
可选
tag_ids
string 
分组ID
可选
version
string 
版本
可选
versioncode
string 
可选
video_controller
string 
显卡
可选
ip
string 
可选
is_connected
boolean 
是否处于远控状态中
可选
is_granted
boolean 
是否是被授权的主机
可选
is_mob_granted
boolean 
可选
是否是移动授权的主机
is_multiple
boolean 
是否为批量处理
可选
is_package
boolean 
是否定制包相关
可选
is_share
boolean 
可选
lan_ip
string 
内网IP
可选
license
object (license.License) 
可选
account
string 
可选
code
string 
可选
is_bind
boolean 
可选
key
string 
可选
level
integer 
可选
password
string 
可选
remote_id
integer 
可选
service_id
integer 
可选
user_id
integer 
可选
license_code
string 
可选
limit_control
string 
是否限制控制
可选
mac
string 
mac地址
可选
owner_id
integer 
主机所有者账号ID
可选
remote_client
object (remote.RemoteClient) 
可选
client_id
string 
可选
mac
string 
可选
remote_id
integer 
可选
user_id
integer 
可选
remote_id
integer 
主机ID
可选
state
object 
状态信息
可选
addr
string 
主机地址
可选
fastcode
string 
识别码
可选
ip
string 
IP
可选
login_time
integer 
登录时间
可选
new_server
integer 
新的被控服务器
可选
origin_server_ip
string 
可选
原来的server_ip, 有这个上面的就没了
osname
string 
系统
可选
owner_id
integer 
账号ID
可选
serverip
string 
可选
serverip6
string 
可选
slsvr的ipv6地址
state
integer 
主机状态
可选
svr_version
string 
可选
version
string 
版本
可选
statuscode
integer 
可选
user
object 
共享信息
可选
account
string 
可选
expiredate
string 
可选
host_modules
array[string]
可选
remark
string 
可选
remote_id
integer 
可选
status
integer 
可选
tag_ids
array[integer]
可选
type
integer 
可选
user_id
integer 
可选
🟠400请求有误
上一页
创建/取消主机授权
下一页
获取单个主机基本信息
Built with