GetUsage - 查询推理服务调用量--火山方舟大模型服务平台-火山引擎

文档中心

立即注册

导航

GetUsage - 查询推理服务调用量

最近更新时间：2024.11.27 20:39:22首次发布时间：2024.11.27 11:33:25

查询模型推理服务调用量

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetUsage	要执行的操作，取值：GetUsage。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
ProjectName	String	否	default	项目
EndpointIds	Array of String	否	test-ep-id	接入点 id
StartTime	Integer	是	1731945600	开始时间
EndTime	Integer	是	1731945600	结束时间
Interval	Integer	是	3600	查询粒度，按天：86400，按小时：3600

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
UsageResults	Array of Object	[ { "Name": "PromptTokens", "MetricItems": [ { "Values": [ { "Timestamp": 1731945600, "Value": 1529525715 } ] } ] }, { "Name": "CompletionTokens", "MetricItems": [ { "Values": [ { "Timestamp": 1731945600, "Value": 40207324 } ] } ] } ]	查询结果

请求示例

POST /?Action=GetUsage&Version=2024-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241127T122746Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241127/cn-beijing/ark/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "StartTime": 1731945600,
  "EndTime": 1731945600,
  "Interval": 3600
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241127202732193099028068A496B2",
    "Action": "GetUsage",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "UsageResults": [
      {
        "Name": "PromptTokens",
        "MetricItems": [
          {
            "Tags": [
              {
                "Key": "EndpointId",
                "Value": "test-ep-id"
              }
            ],
            "Values": [
              {
                "Timestamp": 1731949200,
                "Value": 20826827
              }
            ]
          }
        ]
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.{{Parameter}}	The required parameter {{Parameter}} is missing.	缺少必要的请求参数。请确认请求参数后重试。
400	InvalidParameter.{{Parameter}}	The specified parameter {{Parameter}} is invalid.	请求参数值不合法。请检查参数值的正确性后重试。
404	NotFound.{{Parameter}}	The specified {{ResourceType}} {{ResourceContent}} is not found.	指定资源找不到。请确认参数后重试。
500	InternalError	The request has failed due to an unknown error.	未知错误，请稍后重试。如果多次尝试仍失败，请提交工单。