查询计算资源管理列表

跨工作区查询当前管理目录中的计算资源,可按工作区、状态、名称或关键词筛选。

GET https://api.moi.matrixorigin.cn/v5/admin/compute-resources

调用前准备

准备当前部署配置的计算规格管理员身份及可访问的鉴权工作区。工作区Owner或Genesis管理scope不能替代。示例ID须换成获准读取或操作的目标,见计算实例。

按created_at倒序、id倒序分页;并发变更时不构成稳定快照。DELETED和IAM_CREATE_PENDING不返回,不能依靠此列表看到DELETED终态。管理项带workspace,移除allowed_actions。

查询参数

curl --get "https://api.moi.matrixorigin.cn/v5/admin/compute-resources" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $AUTH_WORKSPACE_ID" \
  --data-urlencode "workspace_id=target-workspace" \
  --data-urlencode "limit=50" \
  --data-urlencode "offset=0"

参数

类型

是否必填

说明

X-API-Key

string

是(示例)

有效个人访问令牌,对应当前部署已配置的计算规格管理员。

X-Workspace-ID

string

是

唯一非空鉴权工作区;与目标资源所属工作区、列表workspace_id分开。

workspace_id

string

否

目标工作区精确筛选,不是鉴权头。

status

string

否

有效状态枚举;DELETED与IAM_CREATE_PENDING不可筛选且始终被排除。

name

string

否

资源名称精确匹配。

keyword

string

否

去首尾空白后对资源名/描述/工作区ID及工作区名/账号/Owner做不区分大小写包含搜索;不含资源ID,%与_按字面处理。

limit

integer

否

默认50,1~200;显式0被拒绝。

offset

integer

否

默认0,不小于0。

成功响应

HTTP 200。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "items": [
      {
        "id": "cr-example",
        "workspace_id": "target-workspace",
        "name": "示例实例",
        "description": "",
        "kind": "task",
        "spec_id": "spec-example",
        "cpu": 1,
        "memory_gib": 4,
        "gpu": 0,
        "cpu_milli": 1000,
        "memory_mib": 4096,
        "gpu_count": 0,
        "gpu_memory_mib": 0,
        "gpu_cores": 0,
        "min_replicas": 0,
        "max_replicas": 2,
        "current_replicas": 0,
        "desired_replicas": 0,
        "go_worker_image_id": "",
        "python_worker_image_id": "",
        "worker_images": [
          {
            "worker_type": "python-worker",
            "image_id": "image-example",
            "platform": "linux/amd64"
          }
        ],
        "platform": "linux/amd64",
        "auto_suspend_minutes": 30,
        "scale_reason": "",
        "is_default": false,
        "status": "IDLE",
        "status_message": "",
        "created_by": "creator-example",
        "created_at": "2026-11-12T07:00:00Z",
        "updated_at": "2026-11-12T07:00:00Z",
        "workspace": {
          "id": "target-workspace",
          "name": "示例工作区",
          "owner_id": "owner-example",
          "account_name": "account-example"
        }
      }
    ],
    "total": 1,
    "limit": 50,
    "offset": 0
  }
}

字段

类型

说明

code

string

成功为OK。

msg

string

成功为OK。

data

object

本接口数据,见以下字段。

data.items

object(对象数组)

管理资源数组;每项有workspace且没有allowed_actions。

data.total

integer

本次筛选的总条数,不是本页条数。

data.limit

integer

本次分页条数。

data.offset

integer

本次偏移量。

data.items[].id

string

计算实例ID。

data.items[].workspace_id

string

实例实际所属工作区,与鉴权头分开。

data.items[].name

string

实例名称。

data.items[].description

string

实例描述,可为空字符串。

data.items[].kind

string

task或query。

data.items[].spec_id

string

关联规格ID。

data.items[].cpu

integer

兼容CPU规格字段,单位核;不与cpu_milli混用。

data.items[].memory_gib

integer

兼容内存规格字段,单位GiB。

data.items[].gpu

integer

兼容GPU规格字段。

data.items[].cpu_milli

integer

规格CPU,单位毫核。

data.items[].memory_mib

integer

规格内存,单位MiB。

data.items[].gpu_count

integer

规格GPU数量。

data.items[].gpu_memory_mib

integer

规格GPU显存,单位MiB。

data.items[].gpu_cores

integer

规格GPU核心字段。

data.items[].min_replicas

integer

配置的最小副本字段,不等同当前观测副本。

data.items[].max_replicas

integer

每个Worker类型的副本上限,不是所有类型的总和上限。

data.items[].current_replicas

integer

当前实例汇总副本字段;与按类型观测分开。

data.items[].desired_replicas

integer

实例目标副本字段,不表示已就绪。

data.items[].go_worker_image_id

string

兼容Go Worker镜像ID,可为空。

data.items[].python_worker_image_id

string

兼容Python Worker镜像ID,可为空。

data.items[].worker_images

object(对象数组),可省略

按Worker类型选择的镜像,可省略;每项字段见下表。

data.items[].platform

string

Worker平台配置。

data.items[].auto_suspend_minutes

integer

自动暂停分钟配置,不是本次操作耗时保证。

data.items[].scale_reason

string

最近扩缩或生命周期原因。

data.items[].is_default

boolean

是否默认实例,可为false。

data.items[].status

string

父实例状态;当前模型包含IDLE、DEPLOYING、SCALING、ACTIVE、DRAINING、SUSPENDED、TERMINATING、ERROR等,不与Worker状态合并。

data.items[].status_message

string

状态文本,可为空。

data.items[].py_requirements_txt

string,可省略

非空时回显规范化依赖文本;当前typed SDK模型未声明。

data.items[].py_requirements_sha

string,可省略

非空时回显文本SHA256;当前typed SDK模型未声明。

data.items[].py_deps

object,可省略

声明的可选观测对象;当前列表/更新转换器未赋值,不承诺从这里读取安装进度。

data.items[].created_by

string

创建主体。

data.items[].last_activation_at

string,可省略

最近激活时间,RFC3339,未记录时省略。

data.items[].last_active_at

string,可省略

最近活跃时间,RFC3339,未记录时省略。

data.items[].created_at

string

创建时间,RFC3339。

data.items[].updated_at

string

更新时间,RFC3339;不是调用者可提交的并发版本。

data.items[].workspace

object

管理工作区投影,四字段见公共对象。

嵌套对象与省略规则见公共对象。

错误响应

{"code": "INVALID_PARAMS", "msg": "workspace is required", "data": null}

HTTP / code

条件与处理

400 / INVALID_PARAMS

缺少身份/鉴权工作区或分页/状态筛选无效。

403 / ErrForbidden

已分类的管理员资格、主体或工作区访问拒绝。

503 / ErrServiceUnavailable

已分类的共享授权不可用,不概括所有目录/配置错误。

500 / ErrServer

未分类服务、目录或存储错误。

字段

类型

说明

code

string

按具体失败阶段分类。

msg

string

错误文本;共享错误可能本地化。

data

null或省略

直接计算错误为null;共享错误形态见错误恢复。

错误不代表所有阶段已回滚,见错误与恢复。

最后更新于