调用GetIndexMonitor接口,查询指定知识库在特定时间范围内的监控数据。这些数据对于性能分析、容量规划和成本管理至关重要。 监控数据主要包含两大维度: 存储监控:获取知识库的索引存储限额和当前使用量。 检索(QPS)监控:获取查询时间段内总的及按时间窗口细分的检索性能指标,包括QPS峰值、总请求数、平均QPS,并细分为成功、失败和被限流的请求。
接口说明
调试
您可以在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 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
"Code": 200,
"Data": "{\n \"code\": \"Success\",\n \"status_code\": 200,\n \"data\": {\n \"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 | 查看变更详情 |
