用于停止指定ROS Agent V2会话中正在执行的任务。
接口说明
请求说明
调用此接口时，请确保
AgentVersion设置为V2以路由到正确的后端服务。SessionId是必填项，用来标识要停止的特定会话。在多进程环境下，如果目标会话位于调用进程内，则直接发送取消信号并等待清理完成；若由其他进程管理，则通过持久化活动会话状态向远端发起取消请求，并立即返回
Stopping状态。当没有活动任务时，API 将返回
NoActiveStream状态码，这不被视为错误情况。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SessionId |
string |
否 |
要停止的会话 ID。接口会校验该会话属于当前用户。 |
7f4e2a8c6d9b4a1f8e3c5b7d2a6f9012 |
| AgentVersion |
string |
否 |
传 V2 路由到 ROS Agent V2 后端。 |
V2 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
OpenAPI 请求 ID。 |
4C68F7A5-2D16-5C8F-A4B1-01E9C6A9B0D2 |
| Status |
string |
停止结果。取值：Stopped、Stopping、Failed、NoActiveStream。 |
Stopped |
| SessionId |
string |
本次停止操作对应的会话 ID。 |
7f4e2a8c6d9b4a1f8e3c5b7d2a6f9012 |
示例
正常返回示例
JSON格式
{
"RequestId": "4C68F7A5-2D16-5C8F-A4B1-01E9C6A9B0D2",
"Status": "Stopped",
"SessionId": "7f4e2a8c6d9b4a1f8e3c5b7d2a6f9012"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。