查询计算实例详情¶
读取一个计算实例的配置、容量和生命周期状态。
GET https://moi.matrixorigin.cn/newmoi/compute-resources/{resource_id}
调用前准备¶
先列出计算实例或创建计算实例,取得 resource_id。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和计算实例 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$RESOURCE_ID:要查询的计算实例 ID,取自列表或创建接口的响应。
路径参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
计算实例 ID。 |
请求示例¶
curl "https://moi.matrixorigin.cn/newmoi/compute-resources/$RESOURCE_ID" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
成功响应¶
成功时返回 200,data 为计算实例对象。
{
"code": "OK",
"msg": "OK",
"data": {
"id": "cr-001",
"name": "data-processing",
"kind": "task",
"spec_id": "task-standard-small",
"status": "ACTIVE",
"status_message": "",
"min_replicas": 0,
"max_replicas": 2,
"current_replicas": 1
}
}
响应字段如下。
字段路径中的 [] 表示数组中的每一项。例如,data.worker_images[].worker_type 表示 data.worker_images 数组中每一项的 worker_type 字段。
字段 |
类型 |
说明 |
|---|---|---|
|
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": "NOT_FOUND",
"msg": "对象不存在",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
— |
缺少或无效的访问凭据。 |
检查 API Key 和工作区 Header。 |
|
|
当前身份没有读取实例的权限。 |
使用有权限的凭据,或联系管理员授权。 |
|
|
实例不存在,或不属于当前工作区。 |
检查 |
后续操作¶
根据 status 查询 Worker 运行时、更新计算实例或执行生命周期操作。