获取Data Agent历史会话描述列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DMSUnit |
string |
否 |
当前 DMS 单元 |
cn-hangzhou |
| CreateStartTime |
integer |
否 |
会话创建开始时间 |
1770825600000 |
| CreateEndTime |
integer |
否 |
会话创建结束时间 |
1770912000000 |
| IsSaved |
boolean |
否 |
是否仅获取已收藏的会话 |
true |
| WorkspaceId |
string |
否 |
协作空间 ID |
20923*****7291 |
| QueryType |
string |
否 |
会话类型，指定协作空间的情况下必传 枚举值：
|
myFavorite |
| Title |
string |
否 |
Data Agent 标题（支持模糊查询） |
帮我分析一下这份数据 |
| PageNumber |
integer |
否 |
分页页码 |
1 |
| PageSize |
integer |
否 |
每页记录数 |
10 |
| CustomAgentId |
string |
否 |
自定义 Agent Id |
ca-4y3ca4khkcu**********ysf |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
E0D21075-CD3E-4D98-8264-**** |
| Data |
array<object> |
返回结构体 |
|
|
array<object> |
Data Agent 会话描述 |
||
| SessionId |
string |
Data Agent 会话 Id |
h8r********4fch |
| SessionStatus |
string |
会话状态 |
RUNNING |
| Title |
string |
标题 |
分析一下这份文件，给出报告。 |
| File |
string |
文件 Id |
f-8*******01m |
| SessionConfig |
object |
会话的配置项 |
|
| Language |
string |
语言
|
CHINESE |
| CustomAgentId |
string |
自定义 Agent Id |
ca-e*******ckd |
| CustomAgentStage |
string |
自定义 Agent 的使用阶段：
|
prod |
| Mode |
string |
模式：
|
ANALYSIS |
| EnableSearch |
boolean |
是否开启联网搜索 |
true |
| UserOssBucket |
string |
用户 OSS Bucket 名称
|
user-oss-bucket |
| CreateTime |
integer |
会话创建时间 |
1731645908000 |
| Saved |
boolean |
是否被当前登录人收藏 |
true |
| AgentId |
string |
当前 Agent Id |
cu0cs*******mf |
| AgentStatus |
string |
当前 Agent 状态 |
RUNNING |
| FavoriteInWorkspace |
boolean |
是否在工作空间中被当前登录人收藏 |
true |
| UserId |
string |
会话拥有人 Id |
2096****** |
| Success |
boolean |
请求是否成功，返回值如下：
|
true |
| ErrorCode |
string |
错误码，请求异常时返回 |
success |
| ErrorMessage |
string |
调用失败时，返回的错误信息。 |
UnknownError |
| Total |
integer |
总记录数。 |
3 |
| TotalPages |
integer |
总页数（页） |
1 |
| PageNumber |
integer |
当前页码 |
1 |
| PageSize |
integer |
当前页大小 |
10 |
示例
正常返回示例
JSON格式
{
"RequestId": "E0D21075-CD3E-4D98-8264-****",
"Data": [
{
"SessionId": "h8r********4fch",
"SessionStatus": "RUNNING",
"Title": "分析一下这份文件，给出报告。",
"File": "f-8*******01m",
"SessionConfig": {
"Language": "CHINESE",
"CustomAgentId": "ca-e*******ckd",
"CustomAgentStage": "prod",
"Mode": "ANALYSIS",
"EnableSearch": true,
"UserOssBucket": "user-oss-bucket"
},
"CreateTime": 1731645908000,
"Saved": true,
"AgentId": "cu0cs*******mf",
"AgentStatus": "RUNNING",
"FavoriteInWorkspace": true,
"UserId": "2096******"
}
],
"Success": true,
"ErrorCode": "success",
"ErrorMessage": "UnknownError",
"Total": 3,
"TotalPages": 1,
"PageNumber": 1,
"PageSize": 10
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。