确认组织使用按订阅周期计量的模式,并返回当前周期信息。当前实现只接受 cycle_mode=subscription-cycle,不保存自定义周期,也不能通过此接口修改重置时间。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
|---|
| 限额与计量管理(管理) | quota | admin.v1.quota.manage | qwenwork-biz-service |
PATCH /api/openapi/v1/metering-policy
认证与请求头
使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|
| Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_\\* |
| X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|
| cycle_mode | body | string | 必填 | 计量周期模式,当前为 subscription-cycle,即按订阅周期计量。 | "subscription-cycle" |
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
curl --request PATCH --url '<BASE_URL>/api/openapi/v1/metering-policy' --header 'Authorization: Bearer <API_KEY>' --header 'Content-Type: application/json' --data '{ "cycle_mode": "subscription-cycle"}'
响应
200 请求成功,返回当前或更新后的数据。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| cycle_mode | string | 是 | 计量周期模式,当前为 subscription-cycle,即按订阅周期计量。 | "subscription-cycle" |
| data_as_of | string · date-time | 是 | 本次数据对应的时间,用于判断数据的新鲜程度。 | "2026-08-27T10:00:00Z" |
| data_status | string | 是 | 数据状态:fresh 为新鲜数据,stale 表示返回了旧数据。 | "fresh" |
| next_reset_at | string · date-time | 是 | 下次重置周期用量的时间。 | "2026-08-27T10:00:00Z" |
| updated_at | string · date-time | 是 | 此记录最后一次更新的时间。 | "2026-08-27T10:00:00Z" |
{
"cycle_mode": "subscription-cycle",
"data_as_of": "2026-08-27T10:00:00Z",
"data_status": "fresh",
"next_reset_at": "2026-08-27T10:00:00Z",
"updated_at": "2026-08-27T10:00:00Z"
}
default 请求失败,返回错误码和错误详情。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 用于程序判断错误原因的稳定业务错误码。 | "<string>" |
| detail | string | 是 | 便于阅读的错误说明。 | "<string>" |
| details | OpenapiErrorDetails | 否 | 字段校验失败时的详细信息。 | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | 否 | 未通过校验的请求字段。 | "<string>" |
| details.reason | string | 否 | 稳定的校验失败原因,用于判断字段为何不合法。 | "<string>" |
| details.suggestion | string | 否 | 建议采用的规范化字段值。 | "<string>" |
| error | string | 是 | 稳定的 HTTP 错误类型。 | "<string>" |
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}