You need to enable JavaScript to run this app.
文档中心
AgentKit

AgentKit

复制全文
下载 pdf
Tool
ViewAsyncCommand - 查询异步命令执行结果
复制全文
下载 pdf
ViewAsyncCommand - 查询异步命令执行结果
获取由ExecAsyncCommand启动的异步任务的的执行状态、输出和退出码。​
接口说明​
建议采用轮询方式调用此接口,直到任务状态变为Succeeded或Failed。​
轮询策略:建议设置合理的轮询间隔(如1~3秒),并设置最大查询次数或超时时间,避免无限轮询。​
注意事项​
注意​
调用本接口时,服务地址与其他接口不同,请区分不同地域使用https://agentkit.<regionid>.volces.com。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
​
参数​
类型​
是否必选​
示例值​
描述​
ToolId​
String​
是​
t-yebi0bt****​
工具ID。​
TaskId​
String​
是​
task-e8a4g****​
要查询的异步任务ID,来源于ExecAsyncCommand接口的返回。​
UserSessionId​
String​
否​
s-yecrbt****​
指定执行请求的会话ID。建议与对应的ExecAsyncCommand调用保持一致。​
SessionId​
String​
否​
指定执行请求的会话ID。​
指定执行请求的用户会话信息。建议与对应的ExecAsyncCommand调用保持一致。​
Ttl​
Integer​
否​
1800​
沙箱实例的存活时间(TTL),单位为秒。​
  • 单位:秒。​
  • 取值范围:60~86400。​
  • 默认值为:1800。​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
​
参数​
类型​
示例值​
描述​
ToolId​
String​
t-yebi0bt****​
工具 ID。​
UserSessionId​
String​
session-1​
执行请求的用户会话信息。​
SessionId​
String​
s-yecrbt****​
执行请求的会话ID。​
TaskId​
String​
task-e8a4g****​
本次异步执行的任务ID。​
Status​
String​
Succeeded​
任务的当前状态,取值:​
  • Running:命令仍在执行中。​
  • Succeeded:命令成功执行完毕。​
  • Failed:命令执行失败。​
  • Unknown:任务状态未知,可能任务ID不存在或已过期。​
Output​
String​
Hello, World!\n​
命令的标准输出(stdout)和标准错误输出(stderr)的组合内容。​
Command​
String​
sleep 5 && echo 'Hello, World!'​
执行的Shell命令。​
ExitCode​
Integer​
0​
命令执行后的退出码,取值:​
  • 0:命令成功执行。​
  • 非0:命令执行过程中出现错误。具体值依赖于执行的命令和程序。​
说明​
在Status返回Running时,此字段无意义。​
​
请求示例​
​
POST https://agentkit.cn-beijing.volces.com?Action=ViewAsyncCommand&Version=2025-10-30 HTTP/1.1​
Content-Type: application/json​
​
{​
"ToolId": "t-yebi0bt****",​
"UserSessionId": "session-1",​
"TaskId": "task-e8a4g****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20240122163005010225****",​
"Action": "ViewAsyncCommand",​
"Version": "2025-10-30",​
"Service": "agentkit",​
"Region": "cn-beijing"​
},​
"Result": {​
"ToolId": "t-yebi0bt****",​
"UserSessionId": "session-1",​
"SessionId": "s-yecrbt****",​
"TaskId": "task-e8a4g****",​
"Output": "Hello, World!\\n",​
"Status": "Succeeded",​
"Command": "sleep 5 && echo 'Hello, World!'",​
"ExitCode": 0​
}​
}​
​
错误码​
​
HttpCode​
错误码​
错误信息​
描述​
400​
MissingParameter.ToolId​
The required parameter ToolId is not supplied.​
请求中缺少必要的ToolId参数。请检查并提供。​
400​
MissingParameter.TaskId​
The required parameter TaskId is not supplied.​
请求中缺少必要的TaskId参数。请检查并提供。​
​
​
最近更新时间:2026.02.05 18:10:49
这个页面对您有帮助吗?
有用
有用
无用
无用