GetIndexMonitor - 获取知识库监控数据

更新时间:
复制为 MD 格式

调用GetIndexMonitor接口,查询指定知识库在特定时间范围内的监控数据。这些数据对于性能分析、容量规划和成本管理至关重要。 监控数据主要包含两大维度: 存储监控:获取知识库的索引存储限额和当前使用量。 检索(QPS)监控:获取查询时间段内总的及按时间窗口细分的检索性能指标,包括QPS峰值、总请求数、平均QPS,并细分为成功、失败和被限流的请求。

接口说明

  • RAM 用户(子账号)需要首先获取阿里云百炼的 API 权限(需要AliyunBailianDataFullAccess),并加入一个业务空间后,方可调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版阿里云百炼 SDK来调用本接口。
  • 调用本接口前,请确保您的知识库已经创建完成且未被删除(即知识库 IDIndexId有效)。
  • 本接口具有幂等性。
说明
  • 查询时间范围(EndTimestamp - StartTimestamp)最大支持 30 天。 返回数据中的时间窗口粒度会根据您查询的时间范围动态调整。
  • 调试

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

    授权信息

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

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

    请求语法

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

    请求参数

    名称类型必填描述示例值
    WorkspaceIdstring

    知识库所在工作空间 ID

    llm-3shx2gu255oqxxxx
    IndexIdstring

    目标知识库的唯一 ID

    kb-123456xxxx
    StartTimestamplong

    查询起始时间,秒级 Unix 时间戳

    1767604500
    EndTimestamplong

    查询结束时间,最大支持起始时间+30d,秒级 Unix 时间戳

    1767604500

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID

    778C0B3B-xxxx-5FC1-A947-36EDD13606AB
    Codestring

    状态码

    200
    Dataany

    响应的核心数据对象。

    storageMonitorData(Object): 知识库的存储监控数据。

    • indexStorageLimit(Number): 知识库的索引存储限额,单位为 GB。

    • indexStorageUsage(Number): 知识库当前已占用的索引存储额度,单位为 GB。

    qpsMonitorData (Object): 知识库在整个查询时间段内的检索(QPS)聚合监控数据。

    • peakQps(Integer): 整个时间段内的最高 QPS 峰值。

    • totalRequests(Integer): 整个时间段内的总请求次数。

    • avgQpsOfActiveSeconds(Number): 整个时间段内,所有活跃秒(即有调用的秒)的平均 QPS。

    • monitorData(Array): 按时间窗口划分的详细监控数据数组。数组中的每个对象代表一个时间窗口的统计信息。

      子属性
      • 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": { "storageMonitorData": Object{...}, "qpsMonitorData": Object{...} }, "success": true, "message": "success", "request_id": "65d34b79-b97e-478e-a0a3-xxx", "status": "SUCCESS" }
    Messagestring

    状态信息

    success
    Successboolean

    请求是否成功

    true
    Statusinteger

    接口返回的状态码

    SUCCESS

    示例

    正常返回示例

    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查看变更详情