zh:server_docs:robot_info:robot_robot_list

获取机器人列表

概述

  • API 用于获取机器人列表;

授权方式

数据维度授权 企业级授权 API 为企业级授权,企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式
接口维度授权 默认授权 API 为默认授权,您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式

请求

HTTP URL 路径 /v1/robot/robot_list
HTTP Method GET
参数 类型 必填 说明
Authorization string
  • 访问凭证 access_token
  • 格式:Bearer access_token
  • 示例:Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51
  • 请参考:鉴权方法
参数 类型 必填 参数说明
ov_corpid string 企业 id。多个企业 id 请使用英文逗号分隔。
robot_sn string 机器人 sn。如果传递了此参数则只返回传对应的机器人,多个 sn 请使用英文逗号分隔。
page int 分页参数。当前是第几页,从 1 开始,默认是 1。
page_rows int 分页参数。每页多少条数据,默认是 1。
# 请根据您的区域替换域名
curl --location 'https://openapi.orionstar.com/v1/robot/robot_list?ov_corpid=test_ov_corpid' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'

响应

参数 类型 参数说明
code int 错误代码。0 是成功,非 0 是失败,请参考 错误代码
msg string 错误描述,当失败的时候会给出具体的错误描述。
req_id string 日志跟踪 id,当遇到问题需要猎户星空协助查问题时候,请提供此跟踪 id 值。
data object 业务数据 data 对象,详见下述 响应体 data 对象
参数 类型 参数说明
total_count string 分页参数。一共有多少条数据。
robot_list array 机器人信息列表数据,此数组中的每个元素都是一个 robot 机器人信息对象,请参考 robot - 机器人信息对象
参数 类型 参数说明
ov_corpid string 所属企业 id
robot_uuid string 机器人 uuid
robot_sn string 机器人 sn
robot_name string 机器人名称
robot_version string 机器人 ROM 版本号,例如:V9.7.2024041200.1234US
robot_model string 机器人型号,例如:OS-R-DR01S
bind_time string 最后一次绑定到当前企业的时间。整数时间戳,单位是秒。例如:1711966681。
expires_time string 租期的截止时间,仅租用的机器人有效。整数时间戳,单位是秒。例如:1711966681。
online_status string 机器人在线状态。在线状态是根据机器人发送的心跳来判断的,状态更新会有大约 15 秒的延迟。
0:不在线
1:在线。
{
    "code": 0,
    "msg": "",
    "data": {
        "total_count": "10",
        "robot_list": [
            {
                "ov_corpid": "orion.ovs.entprise.12345678",
                "robot_uuid": "test_uuid",
                "robot_sn": "test_sn",
                "robot_name": "小豹",
                "robot_version": "V9.7.2024041200.1234US",
                "robot_model": "OS-R-DR01S",
                "bind_time": "1711966681",
                "online_status": "1"
            },
            // ... 省略其他 9 个机器人信息对象
        ]
    }
}
  • 最后更改: 2024-04-07 14:59 +0800