服务用量查询接口

接口信息

  • URLhttps://console-api.ilivedata.com/api/usage/query

  • MethodPOST

  • 鉴权:必须

  • 响应格式:application/json

请求头

参数 类型 必填 说明
Salt Integer 随机字符串,长度6~32 个字符
X-TimeStamp String 当前秒级 Unix 时间戳。
Authorization String 接口签名。

请求参数

参数 类型 必填 说明
corp_cid String 企业 CID,从控制台获取。
start Integer 查询开始时间,秒级 Unix 时间戳。
end Integer 查询结束时间,秒级 Unix 时间戳。
timezone String 聚合时区,默认值为 UTC-0;当前控制器对 UTC-8 使用东八区日期计算。
projects String 项目 ID 列表,多个项目 ID 使用英文逗号分隔。不传或传空字符串时查询全部项目。

返回结果按天聚合,日期由 timezone 参数决定。

响应结果

请求参数合法且用户身份校验通过时,HTTP 状态码为 200

字段 类型 说明
code String 计费日期,按天聚合。
msg Integer 聚合时间点对应的秒级 Unix 时间戳。
data [Data](#### Data 结构) 项目 ID。

Data 结构

字段 类型 说明
date String 计费日期,按天聚合。
timestamp Integer 聚合时间点对应的秒级 Unix 时间戳。
project String 项目 ID。
service String 服务名称。
company_id Integer 子公司(应用)ID。
company_name String 子公司(应用)名称。
detail Detail 当日计费项明细。

Detail 结构

字段 类型 说明
itemID Integer 计费项 ID。0 为核心计费指标,1-4 为其他计费指标,5 为调用次数。
item String 计费项名称。
count Number 当日计费项的值。文本审核单位为请求次数,图片审核单位为过审模型张数。

视频审核和音频审核中的“语音长度”对应 count 单位均为毫秒。

错误码

HTTP 状态码 code msg
401 1003 请求未携带 Authorization。
401 1005 参数有误。
401 1009 Authorization 不正确。
401 10007 请求已过期。
200 999 系统异常。

请求鉴权

请求必须在 HTTP Header 中携带 Authorization,并通过 ApiAuth::validateCorporation() 校验。

时间戳 + Salt 鉴权

同时携带 X-TimeStamp 和 Salt 时,使用以下签名算法:

Authorization = MD5(SecretKey:Timestamp:Salt)

其中:

  • SecretKey:企业密钥。
  • Timestamp:X-TimeStamp Header 中的秒级 Unix 时间戳。
  • Salt:随机字符串。
  • 三个字段使用英文冒号连接。
  • MD5 输出为 32 位十六进制字符串,比较时不区分大小写。

时间戳与服务器标准时间的误差不能超过正负 5 分钟,否则签名失效。

示例

请求

{
  "corp_cid": "as2kljsdfgw",
  "start": 1785513600,
  "end": 1785600000
}

响应

{
    "code": 0,
    "msg": "success.",
    "data": [
        {
            "date": "2026-08-01",
            "timestamp": 1785513600,
            "project": "81900001",
            "service": "语音合成",
            "detail": [
                {
                    "itemID": 0,
                    "item": "使用量",
                    "count": 382541
                }
            ],
            "company_id": "1",
            "company_name": "北京云上曲率科技有限公司"
        }
    ]
}