帮你快速理解、总结文档立即下载
文档中心>腾讯云可观测平台

查询消息列表

最近更新时间:2026-08-26 01:55:16
我的收藏

1. 接口描述

接口请求域名: monitor.tencentcloudapi.com 。

查询消息列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:ListAIWorkbenchMessages。
Version 是 String 公共参数,本接口取值:2023-06-16。
Region 否 String 公共参数,本接口不需要传递此参数。
SessionId 否 String

会话 ID


示例值:ses-****
Cursor 否 String

游标分页的定位标记


示例值:ent-****
Limit 否 Integer

窗口大小


示例值:10
Direction 否 String

拉取顺序


示例值:forward

3. 输出参数

参数名称 类型 描述
Messages Array of MessageInfo

消息列表


注意:此字段可能返回 null,表示取不到有效值。
NextCursor String

下一个游标


注意:此字段可能返回 null,表示取不到有效值。
示例值:ent-****
HasMore Boolean

还有后续吗


示例值:false
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 按顺序获取历史会话

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListAIWorkbenchMessages
<公共请求参数>

{
    "SessionId": "ses-************",
    "Cursor": "ent-************"
}

输出示例

{
    "Response": {
        "HasMore": false,
        "Messages": [
            {
                "Content": "根据查询结果,最近三天(2023年10月18日至2023年10月20日)内没有云服务器的告警历史记录。这可能意味着:\n\n1. **系统运行正常**:云服务器在此期间未触发任何告警。\n2. **告警策略未配置**:可能未设置相关告警策略,导致未捕获异常情况。\n3. **数据延迟或未上报**:告警数据可能存在延迟或未及时上报。\n\n如果需要进一步确认,可以检查告警策略配置或扩大时间范围重新查询。",
                "ContentBlocks": [
                    {
                        "Data": "{\"messageId\":\"ent-v05jrikcax7p\",\"role\":\"assistant\",\"timestamp\":1775800599000,\"type\":\"TEXT_MESSAGE_START\"}",
                        "Type": "TEXT_MESSAGE_START"
                    }
                ],
                "EntryId": "ent-v05jrikcax7p",
                "Role": "assistant",
                "SessionId": "ses-ddgf8e7ne7ak",
                "Status": "completed"
            }
        ],
        "NextCursor": "ent-************",
        "RequestId": "0c3f9c3a-fac9-40b9-8249-79eb32271c4a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
UnauthorizedOperation 未授权操作。