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

获取单个/多个席位的模型调用数据明细

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

查询企业版 AgentPlanTeam 模式下,单个或多个席位的模型调用用量明细。用量按 QueryInterval 指定的时间粒度(天或小时)聚合。个人版套餐用量请改用 GetUsageDetails 接口。

鉴权#

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

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

请求参数#

Body 参数#

QueryInterval string 必选  |  聚合粒度

用量数据的聚合粒度。可选值:Day(按天)、Hour(按小时)。

SeatIDs string[] 必选  |  席位 ID 列表

待查询的席位 ID 列表,单次请求最多支持传入 1000 个。

Filter object  |  过滤条件

用量明细的过滤条件,可按模型、绑定用户、套餐档位以及时间范围筛选。

EndTime string 必选  |  结束时间

Filter.EndTime

查询时间窗口的结束时间,日期字符串,格式 YYYY-MM-DD。

StartTime string 必选  |  起始时间

Filter.StartTime

查询时间窗口的起始时间,日期字符串,格式 YYYY-MM-DD。

ModelID string  |  模型 ID

Filter.ModelID

限定要查询的模型 ID。

ModelName string  |  模型卡片名

Filter.ModelName

限定要查询的模型卡片名称。

ObjectName string[]  |  限定要查询的

Filter.ObjectName

对外展示的 Model 、 Harness 名称列表,不传则返回全部

PlanType string  |  套餐档位

Filter.PlanType

限定要查询的套餐档位。取值:Small、Medium、Large、Max。

UserName string  |  绑定用户名

Filter.UserName

限定席位绑定的子用户名,用于过滤该用户绑定期间的用量数据。

响应参数#

SeatUsageDetails object[]  |  明细列表

按请求顺序返回的席位用量明细列表。

Details object[]  |  调用明细

SeatUsageDetails.Details

该席位下各时间点、各模型的调用明细列表。

BillingType string  |  计费类型

SeatUsageDetails.Details.BillingType

用量的计费类型。可选值:WithinPlan(套餐内用量)、OutsideOfPlan(套餐外用量)。

ObjectName string  |  模型/Harness

SeatUsageDetails.Details.ObjectName

限定要查询的 Model、Harness 名称列表,不传则返回全部。

Time integer  |  时间点

SeatUsageDetails.Details.Time

该条用量记录所属的时间点,Unix 毫秒时间戳。

Unit string  |  用量单位

SeatUsageDetails.Details.Unit

Usage 的计量单位。常见取值:Tokens、Images。

Usage integer  |  用量数值

SeatUsageDetails.Details.Usage

该时间点上的计费用量,单位由 Unit 字段决定。

SeatID string  |  席位 ID

SeatUsageDetails.SeatID

该条明细对应的席位 ID。