KopilotListConversationChatMessages - 查询历史对话

更新时间:
复制 MD 格式

查询指定会话的历史消息,并返回关联定时任务及任务配额信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alikafkakopilot:KopilotListConversationChatMessages

none

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

SessionId

string

否

会话 ID。

e356c91c-8220-425c-9d86-********

RegionId

string

是

地域 ID。

cn-beijing

PageSize

integer

否

每页返回的对话轮次上限,默认 10,范围 1–50;超过范围时按边界值处理。仅影响历史消息分页。

10

BeforeTurnId

integer

否

对话历史分页游标。首次查询不传时返回最新的 PageSize 轮;继续翻页时传入上次响应的 Data.NextBeforeTurnId,返回轮次 ID 小于该游标的更早记录。

2345

TaskPageSize

integer

否

关联定时任务列表每页条数,默认 20,范围 1–100;超过范围时按边界值处理。与历史消息的 PageSize 分页独立。

20

TaskCursor

string

否

关联定时任务列表的分页游标。首次查询不传;继续翻页时原样传入上次响应的 Data.ScheduledTaskInfo.NextTaskCursor。仅影响 Tasks 列表。

123

返回参数

名称

类型

描述

示例值

object

Schema of Response

Code

integer

返回码。返回 200 代表成功。

200

Data

object

调用成功时,返回的数据。

HasMore

boolean

是否还有更早的对话轮次。

true

Messages

array<object>

消息体列表。

object

消息体。

Content

string

消息实际内容。

test

CreateTime

string

创建时间的 Unix 时间戳,单位为毫秒。

17575885545677

Feedback

string

用户满意程度。

1

Role

string

角色标识。

assistant

TurnId

string

主键 ID。

2345

NextBeforeTurnId

integer

存在更早轮次时返回下一页游标;没有下一页时为空。继续查询时作为请求参数 BeforeTurnId 传入。

1

ScheduledTaskInfo

object

当前会话关联的定时任务详情,仅统计已启用、已暂停和待授权任务。

AsOf

string

概览生成时间,UTC ISO 8601 格式。

2026-09-17T12:00:00Z

EnabledCount

integer

关联任务中处于 ENABLED 状态的数量。

1

HasMoreTasks

boolean

是否还有下一页关联任务。

false

HasScheduledTask

boolean

当前会话是否关联已启用、已暂停或待授权的定时任务。

true

NextTaskCursor

string

下一页游标;没有下一页时为空。

123

TaskCount

integer

关联任务总数,仅统计 ENABLED、PAUSED、NEEDS_AUTH 状态。

1

Tasks

array<object>

当前页关联任务列表。

array<object>

单个定时任务信息。

ActiveRun

object

当前排队中或执行中的运行记录,无活动运行时为空。

FinishedAt

string

运行结束时间,UTC ISO 8601 格式;排队中和执行中通常为空。

2026-09-17T12:01:00Z

RunId

string

单次运行唯一标识。

run_0123456789abcdef0123456789abcdef

Status

string

单次运行状态:QUEUED 为排队中,RUNNING 为执行中。

RUNNING

LastCompletedRun

object

最近一次已结束的运行记录,包括失败的运行;没有记录时为空。

FinishedAt

string

运行结束时间,UTC ISO 8601 格式;尚未结束时为空。

2026-09-17T12:01:00Z

RunId

string

单次运行唯一标识。

run_0123456789abcdef0123456789abcdef

Status

string

最近已结束运行的状态,例如 SUCCEEDED 表示成功,FAILED 表示失败。

SUCCEEDED

Name

string

定时任务名称。

Kafka 资源巡检

NextRunAt

string

下次计划执行时间,UTC ISO 8601 格式;无下次计划时为空。

2026-09-17T12:15:00Z

ScheduleDescription

string

执行计划的可读说明。

每 900 秒

Status

string

定时任务状态。DRAFT 为草稿,ENABLED 为已启用,PAUSED 为已暂停,NEEDS_AUTH 为待授权,COMPLETED 为已完成。与运行状态独立。

ENABLED

TaskId

string

定时任务唯一标识。

task_0123456789abcdef0123456789abcdef

ScheduledTaskQuota

object

当前主账号在本环境中的定时任务数量配额,跨地域统计。

Limit

integer

对应任务或渠道的数量上限,以实际配置为准。

3

Remaining

integer

剩余数量,为上限减去已用数量,最小为 0。

2

Used

integer

已占用任务配额,统计 DRAFT、ENABLED、PAUSED、NEEDS_AUTH;已完成及已删除任务不占用。

1

SessionId

string

会话 ID。

87ce9505-7dec-4fd7-bc7c-e66d949bfdc9

TotalTurns

integer

该会话保存的对话轮次总数,不受本次分页大小限制。

2

RequestId

string

请求的 ID。

F69385B9-2139-5A07-AE64-37C4B6ED308E

Success

boolean

请求是否成功。

True

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Data": {
    "HasMore": true,
    "Messages": [
      {
        "Content": "test",
        "CreateTime": "17575885545677",
        "Feedback": "1",
        "Role": "assistant",
        "TurnId": "2345"
      }
    ],
    "NextBeforeTurnId": 1,
    "ScheduledTaskInfo": {
      "AsOf": "2026-09-17T12:00:00Z",
      "EnabledCount": 1,
      "HasMoreTasks": false,
      "HasScheduledTask": true,
      "NextTaskCursor": "123",
      "TaskCount": 1,
      "Tasks": [
        {
          "ActiveRun": {
            "FinishedAt": "2026-09-17T12:01:00Z",
            "RunId": "run_0123456789abcdef0123456789abcdef",
            "Status": "RUNNING"
          },
          "LastCompletedRun": {
            "FinishedAt": "2026-09-17T12:01:00Z",
            "RunId": "run_0123456789abcdef0123456789abcdef",
            "Status": "SUCCEEDED"
          },
          "Name": "Kafka 资源巡检",
          "NextRunAt": "2026-09-17T12:15:00Z",
          "ScheduleDescription": "每 900 秒",
          "Status": "ENABLED",
          "TaskId": "task_0123456789abcdef0123456789abcdef"
        }
      ]
    },
    "ScheduledTaskQuota": {
      "Limit": 3,
      "Remaining": 2,
      "Used": 1
    },
    "SessionId": "87ce9505-7dec-4fd7-bc7c-e66d949bfdc9",
    "TotalTurns": 2
  },
  "RequestId": "F69385B9-2139-5A07-AE64-37C4B6ED308E",
  "Success": true
}

错误码

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

变更历史

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