查询限额策略接口

查询组织的用户限额策略,返回每人积分上限、优先级、适用范围和默认策略标记。可用于确认现有限额设置,并取得修改或删除所需的策略编号。

所需权限

所需权限资源Scope资源服务
限额与计量读取(读取)quotaadmin.v1.quota.readqwenwork-biz-service

GET /api/openapi/v1/quota-policies

认证与请求头

使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。

名称位置类型必填说明示例
Authorizationheaderstring应用 API Key,使用 Bearer 方式传递。Bearer qwk_\\*
X-Request-Idheaderstring可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
keywordquerystring用于筛选此列表的搜索关键词。"<string>"
pagequeryinteger · int64请求的页码,从 1 开始。 默认值:1。 最小值:1。1
page_sizequeryinteger · int64每页返回的记录数量。 默认值:20。 最小值:1。 最大值:100。20

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

curl --request GET --url '<BASE_URL>/api/openapi/v1/quota-policies?keyword=<keyword>&page=1&page_size=20' --header 'Authorization: Bearer <API_KEY>'

响应

200 请求成功,返回当前或更新后的数据。

名称类型必填说明示例
itemsarray | null符合查询条件的当前页记录列表。[{"created_at":"2026-08-27T10:00:00Z","description":"<string>","id":0,"is_default":false,"name":"<string>","per_user_limit":0,"priority":0,"scopes":[{"id":"<string>","type":"user"}],"status":"enabled","updated_at":"2026-08-27T10:00:00Z"}]
items[].created_atstring · date-time此记录的创建时间。"2026-08-27T10:00:00Z"
items[].descriptionstring限额策略的用途说明。"<string>"
items[].idinteger · int64此记录的唯一标识,查询、更新或删除对应记录时使用。0
items[].is_defaultboolean是否为默认策略。false
items[].namestring限额策略的名称。"<string>"
items[].per_user_limitinteger · int64每位用户在一个周期内的积分上限;当前服务要求至少 500 积分。0
items[].priorityinteger · int64策略匹配的优先级,数值越小越先匹配。0
items[].scopesarray | null此限额策略适用的用户、部门和用户组。[{"id":"<string>","type":"user"}]
items[].scopes[].idstring与 type 对应的用户、部门或用户组标识。"<string>"
items[].scopes[].typestring范围类型:user 为用户,dept 为部门,user_group 为用户组。"user"
items[].statusstring此记录当前所处的状态。 可选值:enabled、disabled。"enabled"
items[].updated_atstring · date-time此记录最后一次更新的时间。"2026-08-27T10:00:00Z"
pageinteger · int64当前结果页的页码,从 1 开始。0
page_sizeinteger · int64每页返回的记录数。0
total_itemsinteger · int64符合查询条件的记录总数。0
{
  "items": [
    {
      "created_at": "2026-08-27T10:00:00Z",
      "description": "<string>",
      "id": 0,
      "is_default": false,
      "name": "<string>",
      "per_user_limit": 0,
      "priority": 0,
      "scopes": [
        {
          "id": "<string>",
          "type": "user"
        }
      ],
      "status": "enabled",
      "updated_at": "2026-08-27T10:00:00Z"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_items": 0
}

default 请求失败,返回错误码和错误详情。

名称类型必填说明示例
codestring用于程序判断错误原因的稳定业务错误码。"<string>"
detailstring便于阅读的错误说明。"<string>"
detailsOpenapiErrorDetails字段校验失败时的详细信息。{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring未通过校验的请求字段。"<string>"
details.reasonstring稳定的校验失败原因,用于判断字段为何不合法。"<string>"
details.suggestionstring建议采用的规范化字段值。"<string>"
errorstring稳定的 HTTP 错误类型。"<string>"
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}