查询计算实例指标

读取一个计算实例的用量指标。

GET https://moi.matrixorigin.cn/newmoi/compute-resources/{resource_id}/metrics

调用前准备

先查询计算实例详情，确认要查询的实例。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和计算实例 ID。

下方示例使用：

  • $AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。

  • $WORKSPACE_ID：目标工作区 ID，通过 X-Workspace-ID Header 传递。

  • $RESOURCE_ID：要查询的计算实例 ID。

data.breakdown 中的指标项会随服务实现演进，调用方应能接受新增字段。

路径参数

参数

类型

是否必填

说明

resource_id

string

是

计算实例 ID。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/compute-resources/$RESOURCE_ID/metrics" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

成功时返回 200，业务数据位于 data。请求的资源 ID 用于标识指标归属；当前接口可返回空指标对象。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "compute_resource_id": "cr-001",
    "total_credit": 0,
    "breakdown": {}
  }
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data

object

指标对象。

data.compute_resource_id

string

指标所属的计算实例 ID。

data.total_credit

integer

服务端返回的总 Credit 值。

data.breakdown

object

指标明细；其中的键和值由服务端提供，可能新增。

错误响应

{
  "code": "GET_METRICS_FAILED",
  "msg": "服务端错误",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

401

—

缺少或无效的访问凭据。

检查 API Key 和工作区 Header。

403

ErrForbidden

当前身份没有读取实例指标的权限。

使用有权限的凭据，或联系管理员授权。

500

GET_METRICS_FAILED

服务无法读取指标。

记录请求时间和错误信息后重试。

后续操作

查询计算实例详情以关联指标与实例当前状态。

最后更新于