POST https://ark.cn-beijing.volcengineapi.com/?Action=GetInferenceUsage&Version=2024-01-01
查询推理用量，支持按时间范围、接入点、模型等多维度过滤，返回 token 消耗及请求数等用量数据。
鉴权#
本接口支持鉴权方式如下，详情请参见 Base URL 及鉴权。
- Access Key 鉴权，请在 Access Key 管理 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。
请求参数#
Body 参数#
EndTime string 必选 | 结束日期
查询结束日期，格式为 yyyy-MM-dd，时区为北京时间（UTC+8）。需大于等于 StartTime。
QueryInterval string 必选 | 查询粒度
查询粒度。可取值：
Day：按天统计Hour：按小时统计
StartTime string 必选 | 起始日期
查询起始日期，格式为 yyyy-MM-dd，时区为北京时间（UTC+8）。
Filters object[] | 过滤条件
过滤条件数组，支持按鉴权 token、模型名称、接入点 ID、批量任务 ID 等字段过滤。多个过滤项之间为「与」关系。
Key string 必选 | 过滤字段
Filters.Key
过滤字段。目前支持：
AuthToken：鉴权 token。- 若为 jwt token 鉴权，则默认为
**** - 若为 apikey 鉴权：
- 传统格式 API Key：取前 8 位 +
****+ 后 12 位字符，示例：37efcc63****92c8fe4c880e - 新版方舟 API Key：取前 3 位 +
****+ 后 5 位字符，示例：ark****d5b88
- 传统格式 API Key：取前 8 位 +
- 若为 jwt token 鉴权，则默认为
ApikeyID：API Key 对应的资源 ID
ModelUnitID：模型单元 IDBillingStatus：计费方式。可取值：no_need_billing（无需付费，一般为客户未开通前体验的用量）、free_for_model_unit（模型单元用量）、free_for_free_quota/free_for_limit_boundary（超过安心体验边界的用量）、normal（正常后付费按量计费）、free_for_viptier（TPM 保障包用量）ModelName：模型名称ModelVersion：模型版本ModelEndpoint：接入点 IDBatchJobID：批量任务 IDEndpointName：接入点名称BatchType：批量推理类型
ValueLike string 必选 | 相似匹配值
Filters.ValueLike
相似匹配值，按前缀/包含等近似规则过滤。Values 与 ValueLike 不能同时传递。
Values string[] 必选 | 过滤值列表
Filters.Values
过滤值列表。若 Values 长度为 0，则表示不按 Key 过滤，但返回结果列中仍包含该 Key。
ProjectName string 默认值 default | 项目名称
资源所属的项目名称。若资源不在默认项目中，需填写正确的项目名称。
ShowWindowDetail boolean 默认值 false | 展示窗口详情
是否在返回结果中展示计费窗口详情（如窗口序列、窗口描述、窗口 token 上限等）。
响应参数#
Data string[] | 用量数据
用量数据，二维数组。每行对应一条记录，列顺序与 Fields 一致。
DataCount integer | 数据行数
返回的数据行数，即 Data 数组的长度。
Fields object[] | 列定义
返回数据的列定义，描述 Data 数组中每一列的类型与名称。
Name string | 列名称
Fields.Name
列名称。包括请求参数 Filters 内的所有字段。默认包括：
AccountID：账户 IDDay：日期Hour：小时InputTokens：输入 token 数OutputTokens：输出 token 数TotalTokens：总 token 数ReqCnt：请求数
若返回按窗口划分的数据，则额外包含：
BillingStatus：计费类型WindowMatchOrder：窗口序列WindowDescription：窗口描述WindowMaxInputTokens：窗口输入 token 上限WindowMaxOutputTokens：窗口输出 token 上限
Type string | 列类型
Fields.Type
列数据类型，如 string、integer 等。