# 更新计算资源管理配置

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

以配置管理员身份更新目标计算资源，返回普通资源对象。

```text
PUT https://api.moi.matrixorigin.cn/v5/admin/compute-resources/{id}
```

## 调用前准备

准备当前部署配置的计算规格管理员身份及可访问的鉴权工作区。工作区Owner或Genesis管理scope不能替代。示例ID须换成获准读取或操作的目标，见[计算实例](../../../../../developer/cli/tasks/compute-resources.md)。

只提交需要变更的字段。标量省略/null保留，显式零值和空字符串参与更新校验；worker_images为空数组会拒绝。请求{}或null并非可靠空操作：当前实现仍可能清空status_message并更新时间。

## 请求参数

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
curl -X PUT "https://api.moi.matrixorigin.cn/v5/admin/compute-resources/cr-example" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $AUTH_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  --data '{"description":"更新说明"}'
```

:::::
:::::{tab-item} 参数说明

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `X-API-Key` | string | 是（示例） | 有效个人访问令牌，对应当前部署已配置的计算规格管理员。 |
| `X-Workspace-ID` | string | 是 | 唯一非空鉴权工作区；与目标资源所属工作区、列表workspace_id分开。 |
| `id` | string | 是 | 目标资源ID；服务从管理仓库解析实际工作区。 |
| `name` | string | 否 | 去除首尾空白后不能为空。 |
| `description` | string | 否 | 原样保存；显式空字符串清空。 |
| `kind` | string | 否 | task或query；提交时按最终spec_id要求规格启用且类型相符，并重新应用规格。 |
| `spec_id` | string | 否 | 去首尾空白，规格必须存在；显式修改时要求启用且类型相符，规格值覆盖同请求CPU/内存/GPU兼容字段。 |
| `cpu` | integer | 否 | 最终值大于0，单位核；单独设置不自动同步cpu_milli。 |
| `memory_gib` | integer | 否 | 最终值大于0，单位GiB；单独设置不自动同步memory_mib。 |
| `gpu` | integer | 否 | 最终值不小于0；单独设置不自动同步gpu_count。 |
| `worker_images` | object（对象数组） | 否 | 替换完整镜像选择；省略/null保留，[]进入校验并被拒绝。需覆盖当前ACTIVE目录所有Worker类型，每类型一次；ID、类型、平台匹配。不要求is_default=true。嵌套字段见公共对象。 |
| `min_replicas` | integer | 否 | 当前更新校验要求最终值为0。 |
| `max_replicas` | integer | 否 | 最终值大于0且不小于min_replicas；每Worker类型上限。 |
| `go_worker_image_id` | string | 否 | 兼容镜像字段，空字符串可清空；不等同完整worker_images替换。 |
| `python_worker_image_id` | string | 否 | 兼容镜像字段，空字符串可清空；不等同完整worker_images替换。 |
| `platform` | string | 否 | 去首尾空白后不能为空；镜像选择的平台另需与镜像目录匹配。 |
| `auto_suspend_minutes` | integer | 否 | 最终值不小于0；显式0保留，超过60截为60。 |
| `py_requirements_txt` | string | 否 | 省略/null保留，显式空字符串清除文本与SHA。非空需Python Worker、已配置校验器和启用能力，受当前动态大小/行数/来源规则约束。 |

:::::
::::::
:::::::

## 成功响应

HTTP 200。

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "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",
    "allowed_actions": [],
    "created_at": "2026-11-12T07:00:00Z",
    "updated_at": "2026-11-12T07:00:00Z"
  }
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功为OK。 |
| `msg` | string | 成功为OK。 |
| `data` | object | 本接口数据，见以下字段。 |
| `data.id` | string | 计算实例ID。 |
| `data.workspace_id` | string | 实例实际所属工作区，与鉴权头分开。 |
| `data.name` | string | 实例名称。 |
| `data.description` | string | 实例描述，可为空字符串。 |
| `data.kind` | string | task或query。 |
| `data.spec_id` | string | 关联规格ID。 |
| `data.cpu` | integer | 兼容CPU规格字段，单位核；不与cpu_milli混用。 |
| `data.memory_gib` | integer | 兼容内存规格字段，单位GiB。 |
| `data.gpu` | integer | 兼容GPU规格字段。 |
| `data.cpu_milli` | integer | 规格CPU，单位毫核。 |
| `data.memory_mib` | integer | 规格内存，单位MiB。 |
| `data.gpu_count` | integer | 规格GPU数量。 |
| `data.gpu_memory_mib` | integer | 规格GPU显存，单位MiB。 |
| `data.gpu_cores` | integer | 规格GPU核心字段。 |
| `data.min_replicas` | integer | 配置的最小副本字段，不等同当前观测副本。 |
| `data.max_replicas` | integer | 每个Worker类型的副本上限，不是所有类型的总和上限。 |
| `data.current_replicas` | integer | 当前实例汇总副本字段；与按类型观测分开。 |
| `data.desired_replicas` | integer | 实例目标副本字段，不表示已就绪。 |
| `data.go_worker_image_id` | string | 兼容Go Worker镜像ID，可为空。 |
| `data.python_worker_image_id` | string | 兼容Python Worker镜像ID，可为空。 |
| `data.worker_images` | object（对象数组），可省略 | 按Worker类型选择的镜像，可省略；每项字段见下表。 |
| `data.platform` | string | Worker平台配置。 |
| `data.auto_suspend_minutes` | integer | 自动暂停分钟配置，不是本次操作耗时保证。 |
| `data.scale_reason` | string | 最近扩缩或生命周期原因。 |
| `data.is_default` | boolean | 是否默认实例，可为false。 |
| `data.status` | string | 父实例状态；当前模型包含IDLE、DEPLOYING、SCALING、ACTIVE、DRAINING、SUSPENDED、TERMINATING、ERROR等，不与Worker状态合并。 |
| `data.status_message` | string | 状态文本，可为空。 |
| `data.py_requirements_txt` | string，可省略 | 非空时回显规范化依赖文本；当前typed SDK模型未声明。 |
| `data.py_requirements_sha` | string，可省略 | 非空时回显文本SHA256；当前typed SDK模型未声明。 |
| `data.py_deps` | object，可省略 | 声明的可选观测对象；当前列表/更新转换器未赋值，不承诺从这里读取安装进度。 |
| `data.created_by` | string | 创建主体。 |
| `data.allowed_actions` | string（字符串数组） | 普通资源投影字段，更新结果可为[]；管理列表会移除此字段，不用它判断管理员资格。 |
| `data.last_activation_at` | string，可省略 | 最近激活时间，RFC3339，未记录时省略。 |
| `data.last_active_at` | string，可省略 | 最近活跃时间，RFC3339，未记录时省略。 |
| `data.created_at` | string | 创建时间，RFC3339。 |
| `data.updated_at` | string | 更新时间，RFC3339；不是调用者可提交的并发版本。 |

嵌套对象与省略规则见[公共对象](compute-admin-crud-objects.md)。
:::::
::::::
:::::::

## 错误响应

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{"code": "INVALID_PARAMS", "msg": "invalid compute resource request", "data": null}
```

:::::
:::::{tab-item} 字段说明

| HTTP / code | 条件与处理 |
| --- | --- |
| 400 / INVALID_PARAMS | 缺少必需上下文、JSON不可解析或多余第二份JSON。未知JSON属性当前未严格拒绝，不表示支持该字段。 |
| 403 / ErrForbidden | 已分类的管理员资格、主体或工作区访问拒绝。 |
| 503 / ErrServiceUnavailable | 已分类的共享授权不可用，不概括所有目录/配置错误。 |
| 500 / ErrServer | 当前管理handler统一使用共享服务映射；资源不存在、规格/参数/依赖校验等未单独分类，不套普通更新的404/409/UPDATE_UNAVAILABLE。 |

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 按具体失败阶段分类。 |
| `msg` | string | 错误文本；共享错误可能本地化。 |
| `data` | null或省略 | 直接计算错误为null；共享错误形态见错误恢复。 |

:::::
::::::
:::::::

错误不代表所有阶段已回滚，见[错误与恢复](compute-admin-crud-errors-recovery.md)。
