chenyanzhu/GBH_Ability
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新 api.md

Browse Source
This commit is contained in:
chenyanzhu 2025-09-26 03:11:47 +00:00
parent 87e8bd1a12
commit 62d85ee87e
1 changed files with 5 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
api.md
View File

@ -2,7 +2,7 @@
## 接口列表 ## 接口列表
- [躯干控制任务启动](#躯干控制任务启动) - [躯干控制任务启动](#躯干控制任务启动)
- [躯干控制任务取消](#躯干控制任务取消)
### task_type ### task_type
| task_type | 任务说明 | | task_type | 任务说明 |
| ----------------- | ----------- | | ----------------- | ----------- |
@ -27,7 +27,7 @@
| -------------- | ------ | -------------- | --------------------------------------- | | -------------- | ------ | -------------- | --------------------------------------- |
| task_id | string | 任务id | "e5672a6e-0bc2-4646-a019-dd914034e3ed" | | task_id | string | 任务id | "e5672a6e-0bc2-4646-a019-dd914034e3ed" |
示例请求 ### 示例请求
``` json ``` json
{ {
"task_type": 0, "task_type": 0,
@ -39,7 +39,7 @@
} }
} }
``` ```
示例返回 ### 示例返回
``` json ``` json
{ {
"task_id": "e5672a6e-0bc2-4646-a019-dd914034e3ed" "task_id": "e5672a6e-0bc2-4646-a019-dd914034e3ed"
@ -49,32 +49,6 @@
如果执行成功或执行中，在向能力框架查询到的任务执行情况status字段为running或finished 如果执行成功或执行中，在向能力框架查询到的任务执行情况status字段为running或finished
如果执行失败，在向能力框架查询到的任务执行情况status字段为error 如果执行失败，在向能力框架查询到的任务执行情况status字段为error
## 轮臂机器人头部控制任务取消 ### 异常处理
无
### 请求地址
`POST /api/task/cancel_task`
### 请求参数
| 字段名 | 类型 | 必填 | 默认值 | 说明 | 示例值 |
| ----------------- | ----------- | ---- | ----- |------------ | ------------------- |
| task_type | int64 | 是 | | 任务类型id | 0 |
### 响应参数
| 字段名 | 类型 | 说明 | 示例值 |
| -------------- | ------ | -------------- | --------------------------------------- |
| task_id | string | 任务id | "e5672a6e-0bc2-4646-a019-dd914034e3ed" |
示例请求
``` json
{
"task_type": 0,
}
```
示例返回
``` json
{
"task_id": "e5672a6e-0bc2-4646-a019-dd914034e3ed"
}
```
需要根据task_id向能力框架查询任务执行情况。
如果执行成功或执行中，在向能力框架查询到的任务执行情况status字段为running或finished
如果执行失败，在向能力框架查询到的任务执行情况status字段为error