面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/list-seat-afp-usage-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

查询席位 AFP 额度用量列表

POST https://ark.cn-beijing.volcengineapi.com/?Action=ListSeatAFPUsage&Version=2024-01-01

分页查询企业版 AgentPlanTeam 模式下席位的 AFP 额度用量。支持按席位 ID、绑定用户、套餐档位过滤,按指定窗口用量或创建时间排序。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。

请求参数#

Body 参数#

ProjectName string 必选  |  项目名称

待查询的项目空间名称。

Filter object  |  过滤条件

席位过滤条件。多个筛选条件之间为 AND 关系。

PlanType string[]  |  套餐档位

Filter.PlanType

按套餐档位过滤,可同时指定多个。取值:Small、Medium、Large、Max。

SeatIDs string[]  |  席位 ID 列表

Filter.SeatIDs

按席位 ID 过滤,单次请求最多传入 1000 个。

UserNames string[]  |  绑定用户名

Filter.UserNames

按席位绑定的用户名过滤,单次请求最多传入 1000 个。

PageNumber integer 默认值 1  |  起始页码

分页查询的起始页码,从 1 开始。

最小值:1

PageSize integer 默认值 10  |  每页大小

分页查询时每页返回的席位数量。

取值范围:[10, 100]

SortBy string 默认值 CreateTime  |  排序字段

排序字段。可选值:AFPFiveHour(按 5 小时 AFP 用量)、AFPWeekly(按周 AFP 用量)、AFPMonthly(按月 AFP 用量)、CreateTime(按创建时间)。

SortOrder string 默认值 Desc  |  排序方向

排序方向。可选值:Asc(升序)、Desc(降序)。

响应参数#

Items object[]  |  用量列表

当前页的席位 AFP 用量列表。

AFPDaily object  |  近一天用量

Items.AFPDaily

近 1 天滚动窗口的 AFP 用量。

Quota string  |  窗口总配额

Items.AFPDaily.Quota

该窗口内的 AFP 总配额。

ResetTime integer  |  下次重置时间

Items.AFPDaily.ResetTime

下一次额度重置的时间,Unix 毫秒时间戳。

SubscribeTime integer  |  窗口起始时间

Items.AFPDaily.SubscribeTime

当前计费窗口的起始时间,Unix 毫秒时间戳。

Used string  |  窗口已用量

Items.AFPDaily.Used

该窗口内已消耗的 AFP 配额。

AFPFiveHour object  |  5 小时用量

Items.AFPFiveHour

近 5 小时滚动窗口的 AFP 用量。

Quota string  |  窗口总配额

Items.AFPFiveHour.Quota

该窗口内的 AFP 总配额。

ResetTime integer  |  下次重置时间

Items.AFPFiveHour.ResetTime

下一次额度重置的时间,Unix 毫秒时间戳。

SubscribeTime integer  |  窗口起始时间

Items.AFPFiveHour.SubscribeTime

当前计费窗口的起始时间,Unix 毫秒时间戳。

Used string  |  窗口已用量

Items.AFPFiveHour.Used

该窗口内已消耗的 AFP 配额。

AFPMonthly object  |  近一月用量

Items.AFPMonthly

近 1 个月滚动窗口的 AFP 用量。

Quota string  |  窗口总配额

Items.AFPMonthly.Quota

该窗口内的 AFP 总配额。

ResetTime integer  |  下次重置时间

Items.AFPMonthly.ResetTime

下一次额度重置的时间,Unix 毫秒时间戳。

SubscribeTime integer  |  窗口起始时间

Items.AFPMonthly.SubscribeTime

当前计费窗口的起始时间,Unix 毫秒时间戳。

Used string  |  窗口已用量

Items.AFPMonthly.Used

该窗口内已消耗的 AFP 配额。

AFPWeekly object  |  近一周用量

Items.AFPWeekly

近 1 周滚动窗口的 AFP 用量。

Quota string  |  窗口总配额

Items.AFPWeekly.Quota

该窗口内的 AFP 总配额。

ResetTime integer  |  下次重置时间

Items.AFPWeekly.ResetTime

下一次额度重置的时间,Unix 毫秒时间戳。

SubscribeTime integer  |  窗口起始时间

Items.AFPWeekly.SubscribeTime

当前计费窗口的起始时间,Unix 毫秒时间戳。

Used string  |  窗口已用量

Items.AFPWeekly.Used

该窗口内已消耗的 AFP 配额。

PlanType string  |  套餐档位

Items.PlanType

该席位所属的套餐档位。取值:Small、Medium、Large、Max。

SeatID string  |  席位 ID

Items.SeatID

该条用量记录对应的席位 ID。

PageNumber integer  |  当前页码

当前返回结果对应的页码。

PageSize integer  |  每页大小

当前返回结果对应的每页大小。

ProjectName string  |  项目名称

当前查询的项目空间名称。

TotalCount integer  |  总记录数

符合筛选条件的席位总记录数。