Skip to content

查询当前组织的当日额度 ​

查询当前组织接口调用的当日额度(按北京时间自然日,API 与 MCP 连接共用):建码、表单和模板、上传素材各自的 used、reserved、remaining,以及频率上限。未启用限额时返回 enabled=false;查询本身不扣业务日额度。

请求 ​

text
POST https://open.cli.im/api/v2/rpc/usage/get
项目要求
最低权限只读,见权限档位
需要的 scope不需要,有效凭证即可
组织 Key可以调用

请求参数 ​

没有参数,请求体传 {}。

请求示例 ​

示例里的 ID、幂等键等换成实际值。

bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/usage/get' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{}'

响应 ​

成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。

字段类型一定返回说明
data.enabledboolean是是否启用了额度限制。为 false 时不返回其余字段
data.datestring否额度所属日期(北京时间),如 2026-11-18
data.reset_atinteger否额度重置时间(Unix 秒),即下一个北京时间零点
data.planstring否当前组织适用的额度方案
data.protectedany否是否处于保护状态
data.policy_revisionany否额度策略的版本
data.enforcedboolean否超出额度时是否拒绝请求;false 表示只统计不拦截
data.dailyobject否当日额度
data.daily.qrcode_dailyobject是建码
data.daily.qrcode_daily.limitinteger是上限
data.daily.qrcode_daily.usedinteger是已用
data.daily.qrcode_daily.reservedinteger是进行中的操作暂占
data.daily.qrcode_daily.remaininginteger是剩余
data.daily.form_template_dailyobject是新建表单和模板
data.daily.form_template_daily.limitinteger是上限
data.daily.form_template_daily.usedinteger是已用
data.daily.form_template_daily.reservedinteger是进行中的操作暂占
data.daily.form_template_daily.remaininginteger是剩余
data.daily.upload_dailyobject是上传素材
data.daily.upload_daily.limitinteger是上限
data.daily.upload_daily.usedinteger是已用
data.daily.upload_daily.reservedinteger是进行中的操作暂占
data.daily.upload_daily.remaininginteger是剩余
data.daily.read_dailyobject是读取。超出后降低频率,不会拒绝
data.daily.read_daily.limitinteger是上限
data.daily.read_daily.usedinteger是已用
data.daily.read_daily.degradedboolean是是否已超出并降低频率
data.rates_per_secondobject否每秒请求数上限
data.rates_per_second.read_ratenumber是读接口
data.rates_per_second.write_ratenumber是写接口
data.rates_per_second.control_ratenumber是凭证和额度查询
data.rates_per_second.degraded_read_ratenumber是读取超出当日额度后的读接口
data.batch_maxinteger否单次批量建码的最大条数

响应示例 ​

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "enabled": true,
    "date": "2026-11-18",
    "reset_at": 1795017600,
    "plan": "standard",
    "protected": false,
    "policy_revision": 3,
    "enforced": true,
    "daily": {
      "qrcode_daily": {
        "limit": 1000,
        "used": 12,
        "reserved": 2,
        "remaining": 986
      },
      "form_template_daily": {
        "limit": 100,
        "used": 1,
        "reserved": 0,
        "remaining": 99
      },
      "upload_daily": {
        "limit": 500,
        "used": 3,
        "reserved": 0,
        "remaining": 497
      },
      "read_daily": {
        "limit": 10000,
        "used": 240,
        "degraded": false
      }
    },
    "rates_per_second": {
      "read_rate": 10,
      "write_rate": 2,
      "control_rate": 2,
      "degraded_read_rate": 1
    },
    "batch_max": 100
  }
}

本页由 openapi.json 生成。全部接口见接口清单。