模型服务开放API文档
API列表
GET 分页查询密钥资源列表
GET /xmodel/model/v1/statistics/resourceOptions/{next}/{size}
请求参数 - GET 分页查询密钥资源列表
名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
next | path | integer | 是 | 当前页码,从 1 开始 |
size | path | integer | 是 | 每页条数 |
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构 - GET 分页查询密钥资源列表
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
» status | boolean | true | none | 请求状态 | |
» code | string | true | none | 返回 code | |
» msg | string | false | none | 提示信息 | |
» res | object | true | none | 分页结果 | |
»» current | integer | true | none | 当前页码 | |
»» elements | [object] | true | none | 密钥资源列表 | |
»»» allowedModels | [string] | false | none | 允许调用的模型列表, | |
»»» apiKeyName | string | false | none | API Key名称 | |
»»» createTime | string | false | none | 创建时间 | |
»»» dailyBudget | number | false | none | 日预算,0 表示不限制 | |
»»» dailySpend | number | false | none | 当日消费金额 | |
»»» ipWhitelist | [string] | false | none | IP 白名单 | |
»»» monthlyBudget | number | false | none | 月预算,0 表示不限制 | |
»»» monthlySpend | number | false | none | 当月消费金额 | |
»»» resourceId | string | false | none | 模型平台资源ID,可作为统计和账单筛选条件 | |
»»» status | string | false | none | 资源状态 | |
»» page | integer | true | none | 当前页码 | |
»» size | integer | true | none | 每页条数 | |
»» total | integer | true | none | 总记录数 |
POST 查询调用统计概览
POST /xmodel/model/v1/statistics/overview
请求参数 - POST 查询调用统计概览
名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
timeRange | body | string | 否 | 快捷时间范围,可选 |
startTime | body | string | 否 | 自定义开始时间,格式 |
endTime | body | string | 否 | 自定义结束时间,格式 |
resourceId | body | string | 否 | 模型平台资源ID |
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构 - POST 查询调用统计概览
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
» status | boolean | true | none | 请求状态,true 成功 false 失败 | |
» code | string | true | none | 返回 code,200 成功 | |
» msg | string | false | none | 提示信息 | |
» res | object | true | none | 返回参数 | |
»» totalRequests | integer | true | none | 当前筛选周期内总请求数 | |
»» totalTokens | integer | true | none | 当前筛选周期内总 Token 数 | |
»» rows | [object] | true | none | 按模型聚合的统计行 | |
»»» modelId | string | false | none | 模型 ID | |
»»» modelName | string | false | none | 模型名称 | |
»»» modelType | string | false | none | 模型类型 | |
»»» requestCount | integer | false | none | 请求数量 | |
»»» totalTokens | integer | false | none | 总 Token 数 | |
»»» usageUnit | string | false | none | 用量单位,文本模型通常为 Tokens |
POST 分页查询调用明细
POST /xmodel/model/v1/statistics/detail/{next}/{size}
请求参数 - POST 分页查询调用明细
名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
next | path | integer | 是 | 当前页码,从 1 开始 |
size | path | integer | 是 | 每页条数 |
timeRange | body | string | 否 | 快捷时间范围,可选 |
startTime | body | string | 否 | 自定义开始时间,格式 |
endTime | body | string | 否 | 自定义结束时间,格式 |
resourceId | body | string | 否 | 模型平台资源ID |
modelType | body | string | 否 | 模型类型 |
traceId | body | string | 否 | 请求链路追踪 ID |
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构 - POST 分页查询调用明细
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
» status | boolean | true | none | 请求状态 | |
» code | string | true | none | 返回 code | |
» msg | string | false | none | 提示信息 | |
» res | object | true | none | 分页结果 | |
»» total | integer | true | none | 总记录数 | |
»» size | integer | true | none | 每页条数 | |
»» current | integer | true | none | 当前页码 | |
»» elements | [object] | true | none | 调用明细列表 | |
»»» resourceId | string | false | none | 模型平台资源ID | |
»»» apiKeyName | string | false | none | API Key名称 | |
»»» modelId | string | false | none | 模型ID | |
»»» modelName | string | false | none | 模型名称 | |
»»» modelType | string | false | none | 模型类型 | |
»»» statusCode | integer | false | none | router 返回给调用方的 HTTP 状态码 | |
»»» promptTokens | integer | false | none | 输入 Token 数 | |
»»» completionTokens | integer | false | none | 输出 Token 数 | |
»»» cachedTokens | integer | false | none | 缓存 Token 数 | |
»»» totalTokens | integer | false | none | 总 Token 数 | |
»»» usageUnit | string | false | none | 用量单位 | |
»»» totalLatencyMs | integer | false | none | 总耗时,单位毫秒 | |
»»» callTime | string | false | none | 调用时间 |
POST 分页查询扣费记录列表
POST /xmodel/model/v1/bills/subscribeBillPageList/{next}/{size}
请求参数 - POST 分页查询扣费记录列表
名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
next | path | integer | 是 | 当前页码,从 1 开始 |
size | path | integer | 是 | 每页条数 |
resourceId | body | string | 否 | 模型平台资源ID,用于筛选单个 API Key 资源账单 |
timeRange | body | string | 否 | 快捷时间范围,可选 |
startTime | body | string | 否 | 自定义开始时间,格式 |
endTime | body | string | 否 | 自定义结束时间,格式 |
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构 - POST 分页查询扣费记录列表
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
» status | boolean | true | none | 请求状态 | |
» code | string | true | none | 返回 code | |
» msg | string | false | none | 提示信息 | |
» res | object | true | none | 返回参数 | |
»» pageInfo | object | true | none | 扣费记录分页数据 | |
»»» total | integer | true | none | 总记录数 | |
»»» size | integer | true | none | 每页条数 | |
»»» current | integer | true | none | 当前页码 | |
»»» elements | [object] | true | none | 扣费记录列表 | |
»»»» resourceId | string | false | none | 模型平台资源ID | |
»»»» apiKeyName | string | false | none | API Key名称 | |
»»»» productRuleName | string | false | none | 后付费产品规则名称 | |
»»»» billRule | string | false | none | 计费规则展示文案 | |
»»»» createTime | string | false | none | 扣费记录创建时间 | |
»»»» billRecordCode | string | false | none | 扣费记录编号 | |
»»»» startTime | string | false | none | 本次计费周期开始时间 | |
»»»» endTime | string | false | none | 本次计费周期结束时间 | |
»»»» state | string | false | none | 扣费状态,fee_success: "扣费成功",fee_fail: "扣费失败",bundle_deducted: "资源包抵扣",no_fee: "无扣费",fee_wait: "待扣费" | |
»»»» deductionAmount | number | false | none | 扣费金额 | |
»» totalBillAmount | number | true | none | 当前查询条件下的账单扣费总额 |
POST 查询扣费记录详情
POST /xmodel/model/v1/bills/subscribeBillDetail/{billRecordCode}
请求参数 - POST 查询扣费记录详情
名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
billRecordCode | path | string | 是 | 扣费记录编号 |
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构 - POST 查询扣费记录详情
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
» status | boolean | true | none | 请求状态 | |
» code | string | true | none | 返回 code | |
» msg | string | false | none | 提示信息 | |
» res | object | true | none | 返回参数 | |
»» subscribeBillRecord | object | true | none | 后付费扣费主记录 | |
»»» code | string | false | none | 扣费记录编号 | |
»»» createTime | string | false | none | 创建时间 | |
»»» startTime | string | false | none | 计费周期开始时间 | |
»»» endTime | string | false | none | 计费周期结束时间 | |
»»» billCode | string | false | none | 账单编号 | |
»»» deductionAmount | number | false | none | 扣费金额 | |
»» billGoodsRecordList | [object] | true | none | 用量商品扣费明细列表 | |
»»» basicPrice | number | false | none | 单价 | |
»»» billRecordCode | string | false | none | 扣费记录编号 | |
»»» billingAmount | number | false | none | 计费金额 | |
»»» createTime | string | false | none | 创建时间 | |
»»» goodsCode | string | false | none | 商品编码 | |
»»» goodsName | string | false | none | 计费单元/商品规则名称 | |
»»» modelName | string | false | none | 模型名称 | |
»»» usageAmount | number | false | none | 使用量 | |
»»» usageAmountUnit | string | false | none | 使用量单位 | |
»» resourceBundleRecordList | [object] | true | none | 资源包抵扣明细列表 | |
»»» billingUnit | string | false | none | 资源包计费单元 | |
»»» deductAmount | number | false | none | 本次抵扣量 | |
»»» deductTime | string | false | none | 抵扣时间 | |
»»» modelName | string | false | none | 模型名称 | |
»»» remainAmount | number | false | none | 抵扣后剩余额度 | |
»»» usageAmount | number | false | none | 使用量 | |
»»» usageAmountUnit | string | false | none | 使用量单位 |