停止浏览器 Session - StopBrowserSession
功能介绍
该 API 用于停止指定的浏览器 Session。停止时将触发以下动作:
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
PUT https://agentarts.com/v1/browsers/{browser_name}/sessions-stop
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| browser_name | 是 | String | 参数解释: 与会话关联的浏览器工具的唯一标识符。 浏览器工具名称获取方式: 1.进入 AgentArts 平台,在左侧导航栏选择"托管与运行 > 浏览器"。 2.在浏览器工具列表中"浏览器工具名称/ID"处获取名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 参数解释: 本次智能体工具调用对应的身份认证凭据。需要根据实际的智能体工具的入站身份认证方式获取对应的身份认证凭据。 API Key认证、IAM认证及OAuth 2.0认证具体请参见认证鉴权。 约束限制: 不涉及。 取值范围: 1-4096个字符,由字母、数字及特殊字符组成。 默认取值: 不涉及。 |
| X-Hw-Agentarts-Browser-Session-Id | 是 | String | 参数解释: 要使用的浏览器会话的唯一标识符。 约束限制: 必须是通过 StartBrowserSession 创建的活跃会话。如果会话已过期或已停止,请求将失败。 取值范围: 符合正则:^[a-zA-Z0-9_-]+$。 默认取值: 不涉及。 |
响应参数
状态码:204
无
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则规则 ^AgentArts.0402\d{4}$ |
| error_msg | String | 参数解释: 错误信息。 取值范围: 符合正则:^[a-zA-Z0-9\s一-鿿.,!?;:()'"-。,!?;:()]+$。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则规则 ^AgentArts.0402\d{4}$ |
| error_msg | String | 参数解释: 错误信息。 取值范围: 符合正则:^[a-zA-Z0-9\s一-鿿.,!?;:()'"-。,!?;:()]+$。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则规则 ^AgentArts.0402\d{4}$ |
| error_msg | String | 参数解释: 错误信息。 取值范围: 符合正则:^[a-zA-Z0-9\s一-鿿.,!?;:()'"-。,!?;:()]+$。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则规则 ^AgentArts.0402\d{4}$ |
| error_msg | String | 参数解释: 错误信息。 取值范围: 符合正则:^[a-zA-Z0-9\s一-鿿.,!?;:()'"-。,!?;:()]+$。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 满足正则规则 ^AgentArts.0402\d{4}$ |
| error_msg | String | 参数解释: 错误信息。 取值范围: 符合正则:^[a-zA-Z0-9\s一-鿿.,!?;:()'"-。,!?;:()]+$。 |
请求示例
/v1/browsers/my-browser/sessions-stop
响应示例
状态码:204
无
状态码:401
{
"error_code" : "AgentArts.04020002",
"error_msg" : "Authentication failed: invalid token"
} 状态码:403
{
"error_code" : "AgentArts.04020003",
"error_msg" : "Authentication failed: you have no permission."
} 状态码:404
{
"error_code" : "AgentArts.04020004",
"error_msg" : "Resource not found: session_id=sess-xxx"
} 状态码:429
{
"error_code" : "AgentArts.04020006",
"error_msg" : "Request throttled: too many requests"
} 状态码:500
{
"error_code" : "AgentArts.04020000",
"error_msg" : "System error. Please retry."
} 状态码
| 状态码 | 描述 |
|---|---|
| 204 | No Content |
| 401 | 认证失败 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 429 | 请求频率超限 |
| 500 | 内部系统错误 |
错误码
请参见错误码。