Skip to main content

查询个人限额详情

根据用户 ID 实时查询最终限额及配置来源,同时返回有效个人配置和匹配的策略组配置。

  • Scope:admin.v1.quota.read
  • 权限项:限额与计量读取(quota)
  • 权限类型:读取
  • 接口:GET/api/openapi/v1/individual-quota-configs/{user_id}
根据用户 ID 实时查询最终限额及配置来源,同时返回有效个人配置和匹配的策略组配置。 有效个人限额优先于策略组,即使个人额度更小;没有有效个人限额时使用命中的最高优先级有效策略组,最后兜底默认组。 per_user_limit 使用整数积分。此结果为当前规则解析,不代表上游异步下发已经完成。 cycle_used_credits 为当前计量周期已落库的已用积分,保留四位小数,不是累计历史用量。 用量直接复用现有业务查询;上游无配额记录或查询失败时返回 null,仍返回已解析的限额及来源;仅确认已用量为零时返回 0。 限额配置与上游用量不是原子快照;修改限额或有效期不会重置已用量。

认证与请求头

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

请求参数

名称位置类型必填说明示例
user_idpathstring · uuid必填用户 ID"<uuid>"

请求示例

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

响应

200 OK

合法用户没有个人配置或个人配置已到期时,仍返回策略组或默认组额度;individual_quota 为 null。 用户不在当前组织时返回 404 / user_quota_not_found;目录、数据库或规则查询失败正常报错,不能按零额度处理。 此接口响应已从个人记录改为最终限额详情,不再返回个人记录的 ID、revision、创建及更新信息。
名称类型必填说明示例
user_idstring · uuid是用户 ID。"<uuid>"
per_user_limitinteger · int64是当前规则解析的最终额度,单位为整数积分。1000
cycle_used_creditsnumber | null否当前计量周期已落库的已用积分,保留四位小数;不可用为 null。10.2631
sourceQuotaSource是最终额度的配置来源。-
individual_quotaConfiguredUserQuota | null是有效个人配置的额度与来源;未配置或到期为 null。-
policy_group_quotaConfiguredUserQuota是去掉个人覆盖后命中的策略组或默认组配置。-

individual_quota 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
per_user_limitinteger · int64是有效个人配置额度。
sourceobject是个人配置来源,结构同 source。

individual_quota.source 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
expires_atstring · date-time否当前周期个人配置的 UTC 截止时间;永久或策略组省略。
idstring是来源配置 ID;个人为 UUID,策略组为字符串形式的 ID。
namestring是来源名称。
typestring是individual:个人;policy_group:策略组;default_group:默认组。
validitystring否个人来源有效期:permanent 或 current_cycle;策略组省略。

policy_group_quota 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
per_user_limitinteger · int64是策略组或默认组额度。
sourceobject是策略组或默认组来源,结构同 source。

policy_group_quota.source 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
expires_atstring · date-time否当前周期个人配置的 UTC 截止时间;永久或策略组省略。
idstring是来源配置 ID;个人为 UUID,策略组为字符串形式的 ID。
namestring是来源名称。
typestring是individual:个人;policy_group:策略组;default_group:默认组。
validitystring否个人来源有效期:permanent 或 current_cycle;策略组省略。

source 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
expires_atstring · date-time否当前周期个人配置的 UTC 截止时间;永久或策略组省略。
idstring是来源配置 ID;个人为 UUID,策略组为字符串形式的 ID。
namestring是来源名称。
typestring是individual:个人;policy_group:策略组;default_group:默认组。
validitystring否个人来源有效期:permanent 或 current_cycle;策略组省略。
{
  "user_id": "<uuid>",
  "per_user_limit": 1000,
  "cycle_used_credits": 10.2631,
  "source": {
    "type": "individual",
    "id": "<quota_uuid>",
    "name": "Individual quota",
    "validity": "permanent"
  },
  "individual_quota": {
    "per_user_limit": 1000,
    "source": {
      "type": "individual",
      "id": "<quota_uuid>",
      "name": "Individual quota",
      "validity": "permanent"
    }
  },
  "policy_group_quota": {
    "per_user_limit": 8000,
    "source": {
      "type": "policy_group",
      "id": "12",
      "name": "研发组"
    }
  }
}

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>"
}