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

错误码对照表

本文描述 API 的公共错误返回,与对应的解决方法。公共错误与具体业务接口无关,一般为公共参数的缺失,项目状态异常,签名失败,或业务流控触发等场景返回。

公共错误的返回格式#

错误触发后,Response Body 会输出错误的详细信息,内容为JSON格式的字符串,包括字段:
error:错误的唯一代码,可以作为错误的识别标识,公共错误统一以 "oray_paas/" 作为前缀
msg:详细的错误信息,供开发人员阅读的自然语言信息
例:
{
  "error": "oray_paas/missing_app_key",
  "msg": "missing required HTTP header parameter [X-OPA-APP-KEY]"
}

公共错误对照表#

错误代码HTTP Status code说明
oray_paas/missing_app_key400缺少 AppKey 参数,详见平台签名校验
oray_paas/app_status_exception403应用项目状态异常,请检查以下内容
1. AppKey 参数是否传入错误
2. 相关服务配额是否已耗尽
3. 项目合约或授权是否已过期
oray_paas/invalid_request_signature403签名校验失败,无效的签名,详见平台签名校验,检查请求参数
oray_paas/limit_exceeded429请求频率超过应用服务限制,配合 Retry-After 响应头处理重试
oray_paas/app_service_forbidden403当前应用(AppKey)没有该服务接口的访问权限,请到管理平台检查您的项目授权
oray_paas/duplicate_nonce403重复的随机串,详见平台签名校验
oray_paas/service_deplicated404指定的 API(版本)已弃用,参见相关产品文档以、公告或服务通知

业务错误#

见具体的API接口文档
上一页
用户身份校验
下一页
身份授权
Built with