AgentKit
AgentKit
文档指南
请输入
- 文档首页
AgentKitAgentKit开发者指南API参考Sandbox ToolGetSession - 查询工具会话详情
复制全文
下载 pdfGetSession - 查询工具会话详情
文档反馈
问问助手查询工具的会话详情。
请求参数
Action string 必选 示例值：GetSession
要执行的操作，取值：GetSession。
Version string 必选 示例值：2025-10-30
API的版本，取值：2025-10-30。
SessionId string 必选 示例值：s-3tigy72q3u3vj0x2****
会话ID。
ToolId string 必选 示例值：t-3tigy72q3u3vj0x2****
工具ID。
返回参数
Metadata object[] 示例值：--
会话 Label 元信息。
Key string 示例值：env
元数据的标签键。
Type string 示例值：String
元数据的标签类型，用于声明标签值（Value）的数据类型。
Value string 示例值：production
元数据的标签值。
CreatedAt string 示例值：2006-01-02T15:04:05Z07:00
会话创建时间。
Endpoint string 示例值：https://sd391h67itqkq7brr****.apigateway-cn-beijing.volceapi.com
会话公网访问端点。
ExpireAt string 示例值：2006-01-02T15:04:05Z07:00
会话过期时间。
InternalEndpoint string 示例值：https://sd391h67itqkq7brr****.apigateway-cn-beijing-inner.volceapi.com
会话私网访问端点。
Name string 示例值：session-test
会话名称。
SessionId string 示例值：s-3tigy72q3u3vj0x2****
会话ID。
SessionMeta object 示例值：--
会话元数据。
VncUrl string 示例值：http://sd3s4ng567ui2e1ad****.apigateway-cn-beijing.volceapi.com/terminal?faasInstanceName=vefaas-bf5xfrv4-qa6b0ee7db-d3vh9b033fo44goh****-sandbox
会话VNC访问链接。
WebshellUrl string 示例值：http://sd3s4ng567ui2e1ad****.apigateway-cn-beijing.volceapi.com/vnc/index.html?faasInstanceName=vefaas-bf5xfrv4-qa6b0ee7db-d3vh9b033fo44goh****-sandbox
会话Webshell访问链接。
Status string 示例值：Ready
会话状态，取值：
- Starting: 启动中。
- Ready: 运行中。
- Failed: 启动失败。
- Terminating: 终止中。
ToolType string 示例值：All-in-one
工具类型。取值：
- All-in-one：一体化工具集，即预置工具AIO Sandbox。
- Skill: Skill工具镜像，即预置工具Skills Sandbox。
- PersonalAssistant：预置工具OpenClaw。
- Private: 自定义工具。
TosMountPoints object[] 示例值：--
会话实例TOS挂载点信息。
BucketName string 示例值：bucket01
TOS存储桶名称。
BucketPath string 示例值：http://tos-cn-beijing.ivolces.com
TOS存储桶路径。
LocalMountPath string 示例值：/home/app
待挂载的工具实例本地目录。
UserSessionId string 示例值：session01
用户会话信息。
请求示例
POST https://agentkit.cn-beijing.volcengineapi.com?Action=GetSession&Version=2025-10-30 HTTP/1.1
Content-Type: application/json
{
"ToolId": "t-ye6xzwchkwoaroxxxxxx",
"SessionId": "s-ye6xzwchkwoaroxxxxxx"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202510271450109FD029A85C12E74BE556",
"Action": "GetSession",
"Version": "2025-10-30",
"Service": "agentkit",
"Region": "cn-beijing"
},
"Result": {
"SessionId": "s-ye7sfdm2o0c1kdto****",
"Status": "Ready",
"UserSessionId": "",
"Endpoint": "http://sd3s4ng567ui2e1ad****.apigateway-cn-beijing.volceapi.com/?faasInstanceName=vefaas-bf5xfrv4-qa6b0ee7db-d3vh9b033fo44goh****-sandbox",
"InternalEndpoint": "",
"ToolType": "All-in-one",
"UserSessionId": "session01",
"SessionMeta": {
"WebshellUrl": "http://sd3s4ng567ui2e1ad****.apigateway-cn-beijing.volceapi.com/terminal?faasInstanceName=vefaas-bf5xfrv4-qa6b0ee7db-d3vh9b033fo44goh****-sandbox",
"VncUrl": "http://sd3s4ng567ui2e1ad****.apigateway-cn-beijing.volceapi.com/vnc/index.html?faasInstanceName=vefaas-bf5xfrv4-qa6b0ee7db-d3vh9b033fo44goh****-sandbox"
},
"CreatedAt": "2025-10-27T14:44:12+08:00",
"ExpireAt": "2025-10-28T14:44:12+08:00"
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | MissingParameter.SessionId | The required parameter SessionId is not supplied. | session id不能为空。 |
400 | MissingParameter.ToolId | The required parameter ToolId is not supplied. | tool id不能为空。 |
404 | InvalidResource.NotFound | The specified resource does not exist. | 指定资源不存在。 |
最近更新时间：2026.09.23 18:59:28
这个页面对您有帮助吗？
有用
有用
无用
无用