Skip to main content

读取企业额度接口

读取组织共享额度池的积分总量、已用积分和剩余积分，以及当前订阅周期结束时间。data_status 和 data_as_of 用于判断返回数据的新鲜程度。

  • Scope：admin.v1.quota.read
  • 权限项：限额与计量读取（quota）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/quota-balance

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

此接口没有额外请求参数。

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/quota-balance' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
data_as_ofstring · date-time是数据更新时间"2026-08-27T10:00:00Z"
data_statusstring是数据状态"fresh"
period_ends_atstring · date-time是周期结束时间"2026-08-27T10:00:00Z"
remaining_quotainteger · int64是剩余额度0
total_quotainteger · int64是总额度0
unitstring是计量单位"credit"
updated_atstring · date-time是更新时间"2026-08-27T10:00:00Z"
used_quotainteger · int64是已用额度0
{
  "data_as_of": "2026-08-27T10:00:00Z",
  "data_status": "fresh",
  "period_ends_at": "2026-08-27T10:00:00Z",
  "remaining_quota": 0,
  "total_quota": 0,
  "unit": "credit",
  "updated_at": "2026-08-27T10:00:00Z",
  "used_quota": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}