# 查询服务版本调用数据 #### 功能介绍 查询服务版本调用数据接口用于查询服务的所有版本及其相应的监控指标数据。仅保存30天内的统计数据。 #### 接口约束 - 区域限制：仅支持西南-贵阳一区域。 - API流量限制：所有用户对该API的总请求次数上限，1分钟内不超过1000次。 - 用户流量限制：单个用户对该API的请求次数上限，1分钟内不超过200次。 - 限流响应：超出限流阈值时，API将返回HTTP 429状态码（Too Many Requests）。 - 重试建议：遇到限流时，建议等待60秒后重试。 #### URI POST /v1/{project_id}/maas/monitoring/{service_id}/list-version-statistics 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：项目ID。关于如何获取项目ID，请参见[获取项目ID和名称](https://support.huaweicloud.com/api-maas/api-maas-0028.html)。 **约束限制**：不涉及。 **取值范围**：只能由小写英文字母和数字组成，长度32字符。 **默认取值**：不涉及。 | | service_id | 是 | String | **参数解释** ：服务ID。服务ID在创建服务时即可在返回体中获取，也可通过[获取服务列表接口](https://support.huaweicloud.com/api-maas/ListServices.html)获取当前用户拥有的服务，其中service_id字段即为服务ID。 **约束限制**：不涉及。 **取值范围**：长度 1-128 字符，仅支持大小写字母、数字、下划线 (_)、短横线 (-)。 **默认取值**：不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** ：用户Token。通过调用IAM服务的获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取方式请参见[认证鉴权](https://support.huaweicloud.com/api-maas/api-maas-0005.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | api_keys | 否 | Array of strings | **参数解释**：API Key标签列表，根据传入的API Key标签列表筛选。 MaaS的服务支持**API Key调用** 和**在线体验**两种方式。 **API Key标签** 获取方式：进入[API Key 管理](https://console.huaweicloud.com/modelarts/?#/model-studio/authmanage)页面，API Key列表中"标签"字段的值即为API Key的标签。如下图所示： ![](https://support.huaweicloud.com/api-maas/figure/zh-cn_image_0000002659094077.png "点击放大") **约束限制**：不涉及。 **取值范围**： - 查询**在线体验**调用数据时示例：api_keys: \[""\]。 - 查询**部分** **API Key**下的调用数据时，传入对应API Key的标签；示例：api_keys: \["test01"，"test02"\]。 - 查询**在线体验** 和**部分** **API Key**下的调用数据时，示例：api_keys: \["test01", "test02", ""\] - 查询**全部**调用数据时，不传该参数。 | | ips | 否 | Array of strings | **参数解释** ：IP地址列表，指已产生调用量的客户端源IP地址，不传则查询用户全部IP地址下的数据。可使用[查询IP列表接口](https://support.huaweicloud.com/api-maas/ListSourceIps.html)查询IP地址。 **约束限制**：需符合IP地址格式。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | start_time | 是 | Long | **参数解释**：开始时间，毫秒时间戳。 **约束限制**：结束时间与开始时间相差不超过30天。 **取值范围**：数值大于0，小于等于end_time的取值。 **默认取值**：不涉及。 | | end_time | 是 | Long | **参数解释**：结束时间，毫秒时间戳。 **约束限制**：结束时间与开始时间相差不超过30天。 **取值范围**：数值大于0。 **默认取值**：不涉及。 | | timezone | 否 | String | **参数解释**：时区。 **约束限制**：不涉及。 **取值范围**：遵循IANA时区规范（如Asia/Shanghai、UTC）。 **默认取值**：Asia/Shanghai（东八区）。 | | infer_type | 是 | String | **参数解释**：服务的推理类型。 **取值范围**：枚举类型，取值如下： - real_time：在线推理。 - batch：批量推理（批量推理当前处于受限使用阶段，如需使用请提交工单）。 **约束限制**：不涉及。 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**：查询到的版本总数。 **取值范围**：不涉及。 | | count | Integer | **参数解释**：查询到的版本数量。 **取值范围**：不涉及。 | | items | Array of [VersionStatItem] objects | **参数解释**：版本信息列表。 **取值范围**：不涉及。 | 表5VersionStatItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | service_id | String | **参数解释**：服务ID。 **取值范围**：不涉及。 | | version_id | String | **参数解释**：版本ID。 **取值范围**：不涉及。 | | version_name | String | **参数解释**：版本名称。 **取值范围**：不涉及。 | | request_count | Integer | **参数解释**：调用次数。 **取值范围**：不涉及。 | | error_count | Integer | **参数解释**：调用失败次数（当类型为批量推理时，该参数表示推理失败次数，批量推理当前处于受限使用阶段，如需使用请提交工单）。 **取值范围**：不涉及。 | | error_rate | Double | **参数解释**：调用失败率（当类型为批量推理时，该参数表示推理失败率，批量推理当前处于受限使用阶段，如需使用请提交工单）。 **取值范围**：0-1。 | | total_token | Double | **参数解释**：调用总Tokens数（千tokens）（当类型为批量推理时，该参数表示总tokens数，批量推理当前处于受限使用阶段，如需使用请提交工单）。 **取值范围**：不涉及。 | | prompt_token | Double | **参数解释**：输入Tokens数 (千tokens)。 **取值范围**：不涉及。 | | completion_token | Double | **参数解释**：输出Tokens数 (千tokens)。 **取值范围**：不涉及。 | | avg_latency | Double | **参数解释**：平均响应时延（毫秒）。 **取值范围**：不涉及。 | | avg_ttft | Double | **参数解释**：平均首Tokens时延（毫秒）。 **取值范围**：不涉及。 | | avg_tpot | Double | **参数解释**：平均增量Tokens时延（毫秒）。 **取值范围**：不涉及。 | | completion_tasks_count | Integer | **参数解释**：已完成任务数量。 **取值范围**：不涉及。 | | infer_times | Integer | **参数解释**：推理总量（次）（该参数与批量推理有关，批量推理当前处于受限使用阶段，如需使用请提交工单）。 **取值范围**：不涉及。 | | avg_consume_time | Double | **参数解释**：平均任务处理时长（分钟）（该参数与批量推理有关，批量推理当前处于受限使用阶段，如需使用请提交工单）。 **取值范围**：不涉及。 | | avg_generation_time | Double | **参数解释**：平均生成时长（秒），平均生成每图片/视频实际花费的时间，仅视频、图片生成类模型。 **取值范围**：不涉及。 | | cache_token | Double | **参数解释**：缓存命中的Tokens数 (千tokens)。 **取值范围**：不涉及。 | | cache_hit_ratio | Double | **参数解释**：缓存命中率， 缓存命中的Tokens数/输入的Tokens数 。 **取值范围**：0-1。 | | scc_count | Integer | **参数解释**：调用成功次数（当类型为批量推理时，该参数表示推理成功次数，批量推理当前处于受限使用阶段，如需使用请提交工单）。 **取值范围**：不涉及。 | | video_generate_duration | Double | **参数解释**：生成的视频的总时长（秒） **取值范围**：不涉及。 | | image_generate_nums | Integer | **参数解释**：生成的图片总张数（张） **取值范围**：不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** ：错误码，标识错误类型，详情请参考[MaaS错误码](https://support.huaweicloud.com/api-maas/ErrorCode.html)。 **取值范围**：不涉及。 | | error_msg | String | **参数解释** ：错误描述信息。详情请参考[MaaS错误码](https://support.huaweicloud.com/api-maas/ErrorCode.html)。 **取值范围**：不涉及。 | #### 请求示例 查询服务ID为{service_id}的东八区在线推理类型服务的版本信息以及指标数据。 ``` POST https://{endpoint}/v1/{project_id}/maas/monitoring/{service_id}/list-version-statistics { "start_time" : 1768406400000, "end_time" : 1769531307195, "timezone" : "Asia/Shanghai", "infer_type" : "real_time" } ``` #### 响应示例 **状态码：200** 成功响应。 ``` { "total" : 1, "count" : 1, "items" : [ { "service_id" : "4f6d50ec-0e80-4ea0-983b-d0ad1ede7596", "version_id" : "ac73463d-4453-4d62-a3d9-31b627a116b1", "version_name" : "Qwen2-7B-3.1", "request_count" : 6, "error_count" : 2, "error_rate" : 0.3333, "total_token" : 2.066, "prompt_token" : 0.277, "completion_token" : 1.789, "avg_latency" : 16439.75, "avg_ttft" : 326.46, "avg_tpot" : 29.58, "completion_tasks_count" : 0, "infer_times" : 0, "avg_consume_time" : 0, "avg_generation_time" : 0, "cache_token" : 0, "cache_hit_ratio" : 0, "scc_count" : 0, "video_generate_duration": 0, "image_generate_nums": 0 } ] } ``` **状态码：400** 失败响应。 ``` { "error_code" : "ModelArts.0104", "error_msg" : "参数无效，问题：结束时间不能早于开始时间。" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功响应。 | | 400 | 失败响应。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-maas/ErrorCode.html)。