GetIndexMonitor - 获取知识库监控数据

接口说明

本接口不支持国际站。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
sfm:GetIndexMonitor	get	全部资源 ``	无	无

请求语法

GET /{WorkspaceId}/rag/index/monitor HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	是	知识库所在工作空间 ID	llm-3shx2gu255oqxxxx
IndexId	string	是	目标知识库的唯一 ID	kb-123456xxxx
StartTimestamp	long	是	查询起始时间，秒级 Unix 时间戳	1767604500
EndTimestamp	long	是	查询结束时间，最大支持起始时间+30d，秒级 Unix 时间戳	1767604500

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	778C0B3B-xxxx-5FC1-A947-36EDD13606AB
Code	string	状态码	200
Data	any	响应的核心数据对象。pipelineCommercialType(String):知识库规格 standard：标准版 enterprise：旗舰版 storageMonitorData(Object): 知识库的存储监控数据 indexStorageLimit(Number): 知识库的索引存储限额，单位为 GB。 indexStorageUsage(Number): 知识库当前已占用的索引存储额度，单位为 GB。 pipelineCommercialCu（Integer）：表示旗舰版知识库的 RCU，如 2。qpsMonitorData (Object): 知识库在整个查询时间段内的检索（QPS）聚合监控数据 peakQps(Integer): 整个时间段内的最高 QPS 峰值 totalRequests(Integer): 整个时间段内的总请求次数 avgQpsOfActiveSeconds(Number): 整个时间段内，所有活跃秒（即有调用的秒）的平均 QPS monitorData(Array): 按时间窗口划分的详细监控数据数组。数组中的每个对象代表一个时间窗口的统计信息。 Details 子属性 successData(Object):该窗口内请求成功的统计数据。 limitData(Object): 该窗口内被限流的统计数据。 failData(Object): 该窗口内调用失败的统计数据。 peakQpsInWindowRange(Integer): 该窗口内的总 QPS 峰值（成功+限流+失败）。 totalRequests(Integer): 该窗口内的总请求数（成功+限流+失败）。 windowRange(Integer): 时间窗口的开始时间（秒级 Unix 时间戳）。 windowRangeEnd(Integer): 时间窗口的结束时间（秒级 Unix 时间戳）。 avgQpsOfActiveSeconds(Number): 该窗口内活跃秒的平均 QPS。 successData, limitData, failData 这三个对象的内部结构完全相同，具体如下： peakQpsInWindowRange(Integer): 对应状态下的 QPS 峰值。 totalRequests(Integer): 对应状态下的总请求数。 avgQpsOfActiveSeconds(Number): 对应状态下活跃秒的平均 QPS。	{ "code": "Success", "status_code": 200, "data": { "pipelineCommercialType": "standard", "storageMonitorData": Object{...}, "qpsMonitorData": Object{...} }, "success": true, "message": "success", "request_id": "65d34b79-b97e-478e-a0a3-xxx", "status": "SUCCESS" }
Message	string	状态信息	success
Success	boolean	请求是否成功	true
Status	integer	接口返回的状态码	SUCCESS

示例

正常返回示例 JSON格式

{
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Code": 200,
  "Data": "{\n    \"code\": \"Success\",\n    \"status_code\": 200,\n    \"data\": {\n\"pipelineCommercialType\": \"standard\",       \"storageMonitorData\": Object{...},\n        \"qpsMonitorData\": Object{...}\n    },\n    \"success\": true,\n    \"message\": \"success\",\n    \"request_id\": \"65d34b79-b97e-478e-a0a3-xxx\",\n    \"status\": \"SUCCESS\"\n}",
  "Message": "success",
  "Success": true,
  "Status": 0
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2026-01-14	新增 OpenAPI	查看变更详情

​接口说明

​调试

​授权信息

​请求语法

​请求参数

​返回参数

​示例

​错误码

​变更历史

接口说明

调试

授权信息

请求语法

请求参数

返回参数

示例

错误码

变更历史