根据名称控制容器状态
此接口用于根据容器实例名称改变容器的运行状态。
接口描述
通信协议：HTTP
URL: PUT /api/v1/container
传参方式： body
请求参数
| 字段名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 容器实例的名称 |
| action | enum | 是 | 给容器实例下发的行为，具体说明如下： start：启动 stop：停止 restart：重启 pause：暂停 unpause：继续 |
响应参数
响应参数 data 字段的类型为 Transaction[ ]。
Transaction
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | string | 事务 ID，用于查询当前操作任务对应事务的进度及结果 |
| status | enum | 事务的结果及状态 running: 当前事务运行中 failure：当前事务操作失败 success： 当前事务操作成功 |
| data | Object | 根据情况，事务可能会携带的数据 |
| timestamp | number | 事务生成的时间戳 |
请求示例
curl --location --request PUT 'http://localhost:3001/api/v1/container' \
--header 'Content-Type: application/json' \
--data-raw '{
"id":"instance_uZ5vO5plwE-MRSNe","action":"stop"
}'
响应示例
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": {
"id": "trx_W49wog91BYrcsA-h",
"timestamp": 1705054275739,
"status": "running",
"data": {}
}
}
错误码
具体请参见 错误码说明。
京公网安备11010802043204号