fix doc
This commit is contained in:
parent
8d6e813608
commit
425981b7e2
@ -348,7 +348,38 @@ json_error(ErrCode, ErrMessage) when is_integer(ErrCode), is_binary(ErrMessage)
|
||||
}
|
||||
```
|
||||
|
||||
### 6 删除容器
|
||||
### 6 强制停止容器服务
|
||||
|
||||
**URL**:`/container/kill`
|
||||
**Method**:`POST`
|
||||
|
||||
#### 请求参数
|
||||
| 参数名 | 类型 | 必填 | 说明 |
|
||||
|--------|------|------|------|
|
||||
| uuid | binary (string) | ✅ | 主机唯一标识符 |
|
||||
| container_name | binary (string) | ✅ | 容器名称 |
|
||||
|
||||
### 请求示例
|
||||
```json
|
||||
{"uuid": "qbxmjyzrkpntfgswaevodhluicqzxplkm", "container_name": "my_nginx_new"}
|
||||
```
|
||||
|
||||
#### 响应参数
|
||||
| 字段 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| result | map | 停止结果 |
|
||||
|
||||
#### 示例响应
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"container_name": "sensor_service",
|
||||
"status": "stopped"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 7 删除容器
|
||||
|
||||
**URL**:`/container/remove`
|
||||
**Method**:`POST`
|
||||
@ -578,28 +609,6 @@ json_error(ErrCode, ErrMessage) when is_integer(ErrCode), is_binary(ErrMessage)
|
||||
}
|
||||
```
|
||||
|
||||
### 3️⃣ 强制停止 Endpoint
|
||||
|
||||
**URL**:`/endpoint/kill`
|
||||
**Method**:`POST`
|
||||
|
||||
#### 请求参数
|
||||
| 参数名 | 类型 | 必填 | 说明 |
|
||||
|--------|------|------|------|
|
||||
| id | integer | ✅ | Endpoint 唯一 ID |
|
||||
|
||||
#### 响应参数
|
||||
| 字段 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| result | string | 停止结果,如 `"success"` |
|
||||
|
||||
#### 示例响应
|
||||
```json
|
||||
{
|
||||
"result": "success"
|
||||
}
|
||||
```
|
||||
|
||||
#### 错误响应
|
||||
```json
|
||||
{
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user