调用DescribeDataAgentSession获取DataAgent会话描述-数据管理 DMS-阿里云-数据管理 DMS-阿里云帮助中心

获取DataAgent会话描述信息

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:DescribeDataAgentSession

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DMSUnit	string	否	当前 DMS 单元	cn-hangzhou
SessionId	string	否	DataAgent 会话 ID，可通过 CreateDataAgentSession 获取。	c61n7gm******rj
WorkspaceId	string	否	工作空间 ID。	12****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	18**-*-*****7A3122F
Data	object	返回的结构体
SessionId	string	Agent 会话 Id	976*********p
SessionStatus	string	会话状态	RUNNING
AgentId	string	当前 Agent Id	cu0cs*******mf
AgentStatus	string	当前 Agent 状态	RUNNING
Title	string	标题	分析一下这份文件，给出报告。
ChatHistoryLocations	array<object>	会话回放历史
	object	会话回放的元素
Key	string	会话回放历史的 Key	testKey1
Url	string	会话回放历史的 OSS 下载链接	****
File	string	文件 Id	f-8*******01m
SessionConfig	object	会话的配置项
Language	string	语言 CHINESE 中文 ENGLISH 英语	CHINESE
CustomAgentId	string	自定义 Agent Id	ca-e*******ckd
CustomAgentStage	string	自定义 Agent 的使用阶段： debug 调试阶段 prod 正式生产阶段	debug
Mode	string	模式： ASK_DATA 问数模式 ANALYSIS 分析模式 INSIGHT 洞察模式	ANALYSIS
EnableSearch	boolean	是否开启联网搜索。	True
McpServerIds	array	会话配置中的 MCP 服务器 ID 列表
	string	会话配置中的 MCP 服务器 ID	2q1tu90**********6uttu2nw
KbUuidList	array	本次会话的知识库 ID 列表
	string	单个知识库 ID	asdf****zsdv
UserOssBucket	string	用户 OSS Bucket 名称分析过程文件、报告产物可上传到用户指定的 OSS Bucket	user-oss-bucket
EncryptType	string	产物存放到 OSS（含内置和用户）的加密类型	null
EncryptKey	string	产物存放到 OSS（含内置和用户）的加密秘钥，通常在 CreateDataAgentSession 中指定	ay***1Te
ReportWaterMark	string	报告水印	""
ReportPageWidth	integer	报告页面宽度	300mm
CreateTime	integer	会话创建时间	1731645908000
Saved	boolean	是否被当前登录人收藏	true
FavoriteInWorkspace	string	是否在工作空间中被当前登录人收藏	true
UserId	string	会话拥有人 Id	2096******
Artifacts	array<object>	会话产出的产物列表。当前只包含报告。
	object
Id	string	产物 ID，全局唯一。如果是通过 SendChatMessage 指定 MessageType 为 REPORT 产出的报告，则产物 ID 会和 SendChatMessage 接口返回值中的 MessageId 保持一致。	bab******33e1
Type	string	产物类型。当前可能为：[TextReport, WebReport]	WebReport
Status	string	产物状态。当前可能为如下枚举之一： PENDING，表示后端已收到任务，尚未启动 RUNNING，表示后端已启动任务，尚未完成 SUCCESS，表示任务已成功，可在 LIstFileUpload 接口中查询到文件信息 FAILED，表示任务已失败	PENDING
Name	string	产物名称，通常为工程拼接的字符串，会和 LIstFileUpload 接口的 name 字段对齐，可以通过该字段关联查询到产物文件的下载链接。	report_**_2026**
Description	string	产物的简要描述，可能为空。	a simple report
ReceiveTime	string	后端收到该产物请求的时间，UNIX 时间戳，精确到秒	1778743587
StartTime	string	后端实际开始运行该产物任务的时间。UNIX 时间戳，精确到秒	1778743587
FinishTime	string	后端完成该产物任务的时间。UNIX 时间戳，精确到秒	1778743587
DataSources	array<object>	当前会话用到的数据源列表。
	object
Category	string	数据源来源。当前包含如下枚举 CHAT: 来自对话中通过 CreateDataAgentSession 或 SendChatMessage 接口指定 CUSTOM_AGENT: 来自自定义 Agent 中预设的分析数据范围	CHAT
Detail	string	数据源详情。当 Category 是 CHAT 或者 CUSTOM_AGENT 的时候，Detail 的结构和 SendChatMessage 接口的 DataSources 中单个元素的结构是对齐的。	{}
RecallResults	array<object>	本次会话在知识库、记忆召回的结果
	object
Type	string	召回知识类别	memory
Content	string	召回知识块内容	sky is blue
Score	number	此条数据的相似度分数，其分数算法和创建索引时指定的算法(l2/ip/cosine)相关。	0.65
Success	boolean	返回值说明。 true：删除成功。 false：删除失败。	true
ErrorCode	string	错误码。	success
ErrorMessage	string	调用失败时，返回的错误信息。	UnknownError

示例

正常返回示例

JSON格式

{
  "RequestId": "18****-*****-*******7A3122F",
  "Data": {
    "SessionId": "976*********p",
    "SessionStatus": "RUNNING",
    "AgentId": "cu0cs*******mf",
    "AgentStatus": "RUNNING",
    "Title": "分析一下这份文件，给出报告。",
    "ChatHistoryLocations": [
      {
        "Key": "testKey1",
        "Url": "****"
      }
    ],
    "File": "f-8*******01m",
    "SessionConfig": {
      "Language": "CHINESE",
      "CustomAgentId": "ca-e*******ckd",
      "CustomAgentStage": "debug",
      "Mode": "ANALYSIS",
      "EnableSearch": true,
      "McpServerIds": [
        "2q1tu90**********6uttu2nw"
      ],
      "KbUuidList": [
        "asdf****zsdv"
      ],
      "UserOssBucket": "user-oss-bucket",
      "EncryptType": "null",
      "EncryptKey": "ay***1Te",
      "ReportWaterMark": "\"\"",
      "ReportPageWidth": 0
    },
    "CreateTime": 1731645908000,
    "Saved": true,
    "FavoriteInWorkspace": "true",
    "UserId": "2096******",
    "Artifacts": [
      {
        "Id": "bab******33e1",
        "Type": "WebReport",
        "Status": "PENDING",
        "Name": "report_****_2026****",
        "Description": "a simple report",
        "ReceiveTime": "1778743587",
        "StartTime": "1778743587",
        "FinishTime": "1778743587"
      }
    ],
    "DataSources": [
      {
        "Category": "CHAT",
        "Detail": "{}"
      }
    ],
    "RecallResults": [
      {
        "Type": "memory",
        "Content": "sky is blue",
        "Score": 0.65
      }
    ]
  },
  "Success": true,
  "ErrorCode": "success",
  "ErrorMessage": "UnknownError"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。