开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
  • API 参考
    • 公共约定
    • HTTP 开发规范
    • accessToken(管理员 Token)
    • API 请求示例
    • 错误码
    • 接口调用限额
    • 账号与授权
    • 设备接口
    • 直播地址
    • 推送配置
    • 云存储
    • 资源池额度管理
      • createResourcePool(创建资源池)
      • getResourcePool(查询资源池详情)
      • listResourcePoolByPage(分页查询资源池)
      • modifyResourcePool(修改资源池配置)
      • removeResourcePool(删除资源池)
      • bindSubAccountToResourcePool(绑定子账号到资源池)
      • bindDeviceToResourcePool(绑定设备通道到资源池)
      • unbindSubAccountFromResourcePool(从资源池移除子账号)
      • unbindDeviceFromResourcePool(从资源池移除设备通道)
      • listSubAccountResourcePoolConfigByPage(分页查询池中子账号)
      • listDeviceResourcePoolConfigByPage(分页查询池中设备通道)
      • getSubAccountResourcePoolConfig(查询子账号关联的资源池)
      • getDeviceResourcePoolConfig(查询设备通道关联的资源池)
      • queryOauthUserQuota(查询 OAuth 用户流量额度)
      • saveOauthUserQuota(设置 OAuth 用户流量额度)
    • 旧版接口(不再维护)
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
请求地址
请求格式
请求参数
请求示例
响应字段
响应示例
错误码
说明
相关参考

queryOauthUserQuota(查询 OAuth 用户流量额度)

queryOauthUserQuota:查询 OAuth 用户流量额度

请求地址

https://openapi-[DataCenter].easy4ip.com/openapi/queryOauthUserQuota

请求格式

POST JSON。见 请求约定 与 签名。params.token 须为终端用户 OAuth access token(Ot_ 前缀),由 oauthTokenV2 换取;不得使用管理员 At_ 或子账号 St_ token。

查询当前 OAuth 终端用户在本自然月可用的流量额度上限(与 OAuth 2.0 授权 场景相关,区别于子账号/设备通道资源池接口)。

请求参数

参数名参数类型是否必填默认值合法值参数说明
tokenString是Ot_ 前缀终端用户 OAuth access token

请求示例

{
    "system": {
        "ver": "1.0",
        "appId": "lcdxxxxxxxxx",
        "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
        "time": 1603350473,
        "nonce": "a4d59add-0f04-4b7e-9355-d1fb4e9dc22b"
    },
    "id": "d82a7fa7-655f-4bb8-ab75-72bb3dfa3a94",
    "params": {
        "token": "Ot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
}

响应字段

字段名字段类型字段说明
quotaGbString本月可用额度,单位 GB

响应示例

{
    "id": "123456",
    "result": {
        "data": {
            "quotaGb": "100"
        },
        "code": "0",
        "msg": "操作成功"
    }
}

错误码

本接口可能返回下列码;完整分组见 错误码。

网关与鉴权(SN / TK / OP)

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

更多见 错误码 · OP/SN/TK。

OAuth(OA)

错误码说明下一步
OA1005该 API 不支持 OAuth 用户操作确认接口支持 OAuth 用户 token;见 OAuth 授权模块
OA1007OAuth appId 无效使用 OAuth 项目 Access Key 作为 system.appId,并用项目 Secret Key 签名

说明

  • 与 saveOauthUserQuota 配对使用:先设置每月额度,再查询当前配置。
  • 子账号或设备通道维度的流量池见本模块其余 *ResourcePool* 接口。

相关参考

  • 开发规范
  • 公共约定
  • 本模块索引
getDeviceResourcePoolConfig(查询设备通道关联的资源池)
saveOauthUserQuota(设置 OAuth 用户流量额度)