更新计算实例¶
更新当前工作区中一个计算实例的可修改配置。Serverless 实例不会因配置更新立即部署 Worker;Worker 按后续工作负载需求激活。
PUT https://moi.matrixorigin.cn/newmoi/compute-resources/{resource_id}
调用前准备¶
先查询计算实例详情,确认要更新的实例。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和计算实例 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$RESOURCE_ID:要更新的计算实例 ID。
路径参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
计算实例 ID。 |
请求体¶
字段路径中的 [] 表示数组中的每一项。例如,worker_images[].worker_type 表示 worker_images 数组中每一项的 worker_type 字段。
只提交要修改的字段。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
否 |
实例名称。 |
|
string |
否 |
实例说明。 |
|
string |
否 |
兼容性提示。 |
|
string |
否 |
计算规格 ID。 |
|
integer |
否 |
CPU 配置。 |
|
integer |
否 |
内存 GiB 配置。 |
|
integer |
否 |
GPU 配置。 |
|
integer |
否 |
仅接受 |
|
integer |
否 |
副本上限,必须大于 |
|
integer |
否 |
自动暂停等待时间。 |
|
object(对象数组) |
否 |
Worker 镜像选择。提交此字段时必须用完整列表替换原配置,并覆盖当前所有活跃的 |
|
string |
提交 |
Worker 类型。 |
|
string |
否 |
兼容别名;传入时应与 |
|
string |
提交 |
镜像 ID。 |
|
string |
提交 |
镜像运行平台。 |
|
string |
否 |
兼容的 Go Worker 镜像 ID。 |
|
string |
否 |
兼容的 Python Worker 镜像 ID。 |
|
string |
否 |
兼容的运行平台。 |
请求示例¶
curl -X PUT "https://moi.matrixorigin.cn/newmoi/compute-resources/$RESOURCE_ID" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
-d '{
"description": "updated",
"max_replicas": 3,
"auto_suspend_minutes": 30
}'
成功响应¶
成功时返回 200,data 为更新后的实例对象。保存成功不会立即部署 Worker。
{
"code": "OK",
"msg": "OK",
"data": {
"id": "cr-001",
"name": "data-processing",
"description": "updated",
"spec_id": "task-standard-small",
"status": "IDLE",
"status_message": "",
"min_replicas": 0,
"max_replicas": 3,
"current_replicas": 0
}
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
string |
计算实例 ID。 |
|
string |
所属工作区 ID。 |
|
string |
计算实例名称。 |
|
string |
实例说明;有值时返回。 |
|
string |
当前计算规格 ID。 |
|
string |
实例类型。 |
|
integer |
CPU 配置值。 |
|
integer |
以内存 GiB 表示的配置值。 |
|
integer |
GPU 配置值。 |
|
integer |
以毫核表示的 CPU 配置值。 |
|
integer |
以内存 MiB 表示的配置值。 |
|
integer |
GPU 数量。 |
|
integer |
单个 GPU 的显存 MiB。 |
|
integer |
GPU 核心数。 |
|
integer |
Serverless 实例固定为 |
|
integer |
最大副本数。 |
|
integer |
目标副本数。 |
|
integer |
当前副本数。 |
|
string |
Go Worker 镜像 ID;有值时返回。 |
|
string |
Python Worker 镜像 ID;有值时返回。 |
|
object(对象数组) |
Worker 镜像选择;有值时返回。 |
|
string |
Worker 类型。 |
|
string |
镜像 ID。 |
|
string |
运行平台。 |
|
string |
实例运行平台;有值时返回。 |
|
integer |
自动暂停等待时间。 |
|
boolean |
是否为工作区默认计算实例。 |
|
string |
更新后的当前生命周期状态。 |
|
string |
状态补充信息;有值时返回。 |
|
string |
服务端提供的缩放原因;有值时返回。 |
|
string |
最近一次激活时间;有值时返回。 |
|
string |
最近一次活跃时间;有值时返回。 |
|
string |
创建者标识;有值时返回。 |
|
string |
创建时间;有值时返回。 |
|
string |
最后更新时间;有值时返回。 |
错误响应¶
{
"code": "UPDATE_FAILED",
"msg": "服务器内部错误",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
请求体无法解析或字段组合无效。 |
检查字段类型、规格和副本范围。 |
|
— |
缺少或无效的访问凭据。 |
检查 API Key 和工作区 Header。 |
|
|
当前身份没有实例更新权限。 |
请求授予 |
|
|
实例不存在或不属于当前工作区。 |
核对 |
|
|
新名称与工作区中的已有实例冲突。 |
修改 |
|
|
服务端未能更新实例。 |
稍后重试。 |
后续操作¶
查询计算实例详情或查询 Worker 运行时确认变更进度。