# 获取汇总统计 #### 功能介绍 获取汇总统计接口用于查询在线推理服务调用的汇总数据，包括：总调用次数、总调用失败次数、总调用Tokens数、输入Tokens数、输出总Tokens数等。仅保存30天内的统计数据。 #### 接口约束 - 区域限制：仅支持西南-贵阳一区域。 - API流量限制：所有用户对该API的总请求次数上限，1分钟内不超过1000次。 - 用户流量限制：单个用户对该API的请求次数上限，1分钟内不超过200次。 - 限流响应：超出限流阈值时，API将返回HTTP 429状态码（Too Many Requests）。 - 重试建议：遇到限流时，建议等待60秒后重试。 #### URI POST /v1/{project_id}/maas/monitoring/show-statistics 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：项目ID。关于如何获取项目ID，请参见[获取项目ID和名称](https://support.huaweicloud.com/api-maas/api-maas-0028.html)。 **约束限制**：不涉及。 **取值范围**：只能由小写英文字母和数字组成，长度32字符。 **默认取值**：不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** ：用户Token。通过调用IAM服务的获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取方式请参见[认证鉴权](https://support.huaweicloud.com/api-maas/api-maas-0005.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | service_type | 是 | Integer | **参数解释**：服务类型。 **约束限制**：不涉及。 **取值范围**：枚举类型，取值如下： - 2：预置服务，在"预置服务"页签开通的模型服务。具体操作，请参见[开通预置服务](https://support.huaweicloud.com/model-call-maas/model-call-052.html)。 - 4：自定义接入点，在"自定义接入点"页签创建的接入点服务。更多信息，请参见[创建自定义接入点](https://support.huaweicloud.com/model-call-maas/model-call-048.html)。 **默认取值**：不涉及。 | | 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：批量推理（批量推理当前处于受限使用阶段，如需使用请提交工单）。 **约束限制**：不涉及。 **默认取值**：不涉及。 | | model_type | 否 | String | **参数解释**：模型类型。 **取值范围**：模型类型取值如下： - Text Generation：文本生成类模型。 - Video Generation：视频生成类模型。 - Image Generation：图像生成类模型。 - Vector Model：文本向量化。 - Embedding： Embedding模型。 - Image Understanding：图像理解类模型。 - Rerank：重排序类模型。 **约束限制**：不涉及。 **默认取值**：Text Generation。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_request_count | Integer | **参数解释**：总调用次数。 **取值范围**：不涉及。 | | total_error_count | Integer | **参数解释**：总调用失败次数。 **取值范围**：不涉及。 | | total_token | Double | **参数解释**：总调用Tokens数（当类型为批量推理时，该参数表示总推理tokens数，批量推理当前处于受限使用阶段，如需使用请提交工单）。 **取值范围**：不涉及。 | | total_prompt_token | Double | **参数解释**：输入总Tokens数。 **取值范围**：不涉及。 | | total_completion_token | Double | **参数解释**：输出总Tokens数。 **取值范围**：不涉及。 | | total_completion_tasks | Integer | **参数解释**：已完成批量推理任务数量（该参数与批量推理有关，批量推理当前处于受限使用阶段，如需使用请提交工单）。 **取值范围**：不涉及。 | | total_infer_count | Integer | **参数解释**：推理总量，服务推理的总次数（该参数与批量推理有关，批量推理当前处于受限使用阶段，如需使用请提交工单）。 **取值范围**：不涉及。 | | video_generate_duration | Double | **参数解释**：生成的视频的总时长（秒）。 **取值范围**：不涉及。 | | image_generate_nums | Integer | **参数解释**：生成的图片总张数（张）。 **取值范围**：不涉及。 | **状态码：400** 表5响应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)。 **取值范围**：不涉及。 | #### 请求示例 查询用户自定义接入点类型服务在线推理时间在1761753600000到1761806407404之间的调用统计信息。 ``` POST https://{endpoint}/v1/{project_id}/maas/monitoring/show-statistics { "service_type" : 4, "start_time" : 1761753600000, "end_time" : 1761806407404, "timezone" : "Asia/Shanghai", "infer_type" : "real_time" } ``` #### 响应示例 **状态码：200** 成功响应 ``` { "total_request_count" : 202, "total_error_count" : 6, "total_token" : 78.035, "total_prompt_token" : 70.265, "total_completion_token" : 7.77, "total_completion_tasks" : 0, "total_infer_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)。