调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListAgentkitSessionIDs	要执行的操作，取值：ListAgentkitSessionIDs。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
ProtectStatus	Array of String	否	["Protecting"]	防护状态筛选。Protecting：心跳在线；Unprotected：心跳离线或不存在；其他值当前不产生筛选条件
SessionID	String	否	session-id-001	会话实例 ID，精确匹配，可通过 ListAgentkitSessionIDs 接口获取；与 SessionIDList 同时传入时取交集
SessionIDList	Array of String	否	["session-id-001","session-id-002"]	会话实例 ID 列表，可通过 ListAgentkitSessionIDs 接口获取；与 SessionID 同时传入时取交集
SessionName	String	否	production-session	会话实例名称，不区分大小写的模糊匹配
SyncType	Array of String	否	["Automatic"]	集成方式。Manual：手动添加；Automatic：自动同步
ToolID	String	否	tool-id-001	工具 ID，精确匹配，可通过 ListAIApplicationBasicInfo 接口获取
ToolName	String	否	OpenClaw	工具名称，不区分大小写的模糊匹配
SessionStatus	Array of String	否	["Ready"]	会话实例状态。Starting：启动中；Failed：启动失败；Ready：运行中；Terminating：终止中
ToolType	Array of String	否	["PersonalAssistant"]	工具类型。All-in-one：一体化工具集；Skill：Skill 工具镜像；Private：自定义工具；PersonalAssistant：个人助手

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
SessionIDList	Array of String	["session-id-001","session-id-002"]	符合筛选条件的去重会话实例 ID 列表，可用于其他 SessionID 参数

请求示例

POST /?Action=ListAgentkitSessionIDs&Version=2024-05-08 HTTP/1.1
Host: seccenter.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241120T080538Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "ProtectStatus": [
    "Protecting"
  ],
  "SessionID": "session-id-001",
  "SessionIDList": [
    "session-id-001",
    "session-id-002"
  ],
  "SessionName": "production-session",
  "SessionStatus": [
    "Ready"
  ],
  "SyncType": [
    "Automatic"
  ],
  "ToolID": "tool-id-001",
  "ToolName": "OpenClaw",
  "ToolType": [
    "PersonalAssistant"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListAgentkitSessionIDs",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "SessionIDList": [
      "session-id-001",
      "session-id-002"
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter	The required parameter %s is missing.	请求参数缺失，请检查参数是否已正确传入。
400	InvalidParameter	The specified parameter %s is invalid.	请求参数错误，请检查参数传递内容是否正确。
400	OperationDenied	Operation is denied because the specified resource is in use.	不允许的操作，请检查当前资源是否被占用
500	InternalError	The request has failed due to an unknown error.	服务器内部错误，请稍后重试或联系技术支持。
500	DBOperateError	The request has failed because database return error: %s	数据库操作异常，请稍后重试或联系技术支持。

最近更新时间：2026.08.21 20:38:56

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码