# 查询资源监控指标详情 #### 功能介绍 查询资源监控指标详情接口用于查询MaaS在线推理模块**我的服务**类型资源监控指标信息。仅保存30天内的统计数据。 #### 接口约束 - 区域限制：仅支持西南-贵阳一区域。 - API流量限制：所有用户对该API的总请求次数上限，1分钟内不超过1000次。 - 用户流量限制：单个用户对该API的请求次数上限，1分钟内不超过200次。 - 限流响应：超出限流阈值时，API将返回HTTP 429状态码（Too Many Requests）。 - 重试建议：遇到限流时，建议等待60秒后重试。 #### URI GET /v1/{project_id}/maas/monitoring/{service_id}/detail-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 字符，仅支持大小写字母、数字、下划线 (_)、短横线 (-)。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start_time | 是 | Long | **参数解释**：开始时间，毫秒时间戳。 **约束限制**：须小于等于end_time的取值，结束时间与开始时间相差小于30天。 **取值范围**：数值大于0。 **默认取值**：不涉及。 | | end_time | 是 | Long | **参数解释**：结束时间，毫秒时间戳。 **约束限制**：结束时间与开始时间相差不超过30天。 **取值范围**：数值大于0。 **默认取值**：不涉及。 | | metric_name | 是 | String | **参数解释**：指标名称。 **约束限制**：不涉及。 **取值范围**：枚举类型，取值如下： - npu_util：NPU算力使用率。 - cpu_usage：CPU使用率。 - mem_usage：内存使用率。 - npu_mem_usage：NPU显存利用率。 - disk_read_rate：磁盘读取速率。 - disk_write_rate：磁盘写入速率。 - recv_bytes_rate：下行速率。 - send_bytes_rate：上行速率。 - running_task：正在运行的请求数。 - pending_task：排队请求数。 - kv_cache_usage：KV cache使用率。 - prompt_tps：输入TPS。 - completion_tps：输出TPS。 **默认取值**：不涉及。 | | timezone | 否 | String | **参数解释**：时区。 **约束限制**：不涉及。 **取值范围**：遵循IANA时区规范（如Asia/Shanghai、UTC）。 **默认取值**：Asia/Shanghai（东八区）。 | | model_id | 是 | String | **参数解释**：模型ID。在MaaS控制台界面，进入"模型推理 \> 在线推理"的"我的服务"页面，单击服务列表的服务名称，进入服务详情页，打开F12，进入"Network"页签，查看models接口响应体中的model_id的值。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** ：用户Token。通过调用IAM服务的获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取方式请参见[认证鉴权](https://support.huaweicloud.com/api-maas/api-maas-0005.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | points | Array of [DataPoint] objects | **参数解释**：监控指标的数据点，包含指标值和指标上报时间戳。 **取值范围**：不涉及。 | | metric_name | String | **参数解释**：指标名称。 **取值范围**：枚举类型，取值如下： - npu_util：NPU算力使用率。 - cpu_usage：CPU使用率。 - mem_usage：内存使用率。 - npu_mem_usage：NPU显存利用率。 - disk_read_rate：磁盘读取速率。 - disk_write_rate：磁盘写入速率。 - recv_bytes_rate：下行速率。 - send_bytes_rate：上行速率。 - running_task：正在运行的请求数。 - pending_task：排队请求数。 - kv_cache_usage：KV cache使用率。 - prompt_tps：输入TPS。 - completion_tps：输出TPS 。 | | unit | String | **参数解释**：指标单位。 **取值范围**：不涉及。 | 表5DataPoint | 参数 | 参数类型 | 描述 | |:---|:---|:---| | val | Double | **参数解释**：指标值。 **取值范围**：不涉及。 | | time | Long | **参数解释**：时间，毫秒时间戳。 **取值范围**：不涉及。 | **状态码：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}。模型ID为29f474eb-67bc-4a7c-9771-c98c568c1c8c的服务，在时间1769532157287到1769535757287的时候的输出TPS的数据。 ``` GET https://{endpoint}/v1/{project_id}/maas/monitoring/{service_id}/detail-statistics?start_time=1769532157287&end_time=1769535757287&metric_name=completion_tps&model_id=29f474eb-67bc-4a7c-9771-c98c568c1c8c&timezone=Asia/Shanghai ``` #### 响应示例 **状态码：200** 成功响应。 ``` { "points" : [ ], "metric_name" : "running_task", "unit" : "num" } ``` **状态码：400** 失败响应。 ``` { "error_msg" : "Database error.", "error_code" : "ModelArts.2010" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功响应。 | | 400 | 失败响应。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-maas/ErrorCode.html)。