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 授权 场景相关,区别于子账号/设备通道资源池接口)。
请求参数
| 参数名 | 参数类型 | 是否必填 | 默认值 | 合法值 | 参数说明 |
|---|---|---|---|---|---|
| token | String | 是 | 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"
}
}
响应字段
| 字段名 | 字段类型 | 字段说明 |
|---|---|---|
| quotaGb | String | 本月可用额度,单位 GB |
响应示例
{
"id": "123456",
"result": {
"data": {
"quotaGb": "100"
},
"code": "0",
"msg": "操作成功"
}
}
错误码
本接口可能返回下列码;完整分组见 错误码。
网关与鉴权(SN / TK / OP)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SN1001 | 签名校验异常 | 按 HTTP 开发规范 核对 sign |
TK1002 | token 无效或过期 | 重新获取 accessToken |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1009 | 权限不足 | 核对 token 与设备绑定/分享权限 |
OP1013 | 接口总次数超限 | 降低调用频率 |
OP1014 | 接口日限额超限 | 见 接口调用限额 |
DV1007 | 设备离线 | 等设备上线 |
更多见 错误码 · OP/SN/TK。
OAuth(OA)
| 错误码 | 说明 | 下一步 |
|---|---|---|
| OA1005 | 该 API 不支持 OAuth 用户操作 | 确认接口支持 OAuth 用户 token;见 OAuth 授权模块 |
| OA1007 | OAuth appId 无效 | 使用 OAuth 项目 Access Key 作为 system.appId,并用项目 Secret Key 签名 |
说明
- 与 saveOauthUserQuota 配对使用:先设置每月额度,再查询当前配置。
- 子账号或设备通道维度的流量池见本模块其余
*ResourcePool*接口。
