查询环境下的知识库列表

最近更新时间:2025-03-20 11:56:15

我的收藏

1. 接口描述

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

查询知识库

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeKnowledgeSetList。
Version String 公共参数,本接口取值:2021-01-08。
Region String 公共参数,本接口不需要传递此参数。
EnvId String 环境ID
示例值:lowcode-sdf
Name String 知识库标识,精准查询
示例值:name
Title String 知识库名称,精准查询
示例值:title
Offset Integer 分页起始位
示例值:0
Limit Integer 查询条数
示例值:10
QueryMode String NoPage标识不分页
示例值:NoPage

3. 输出参数

参数名称 类型 描述
Data KnowledgeSetRsp 知识库列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询环境下的知识库列表

查询环境下的知识库列表

输入示例

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

{
    "EnvId": "lowcode-xxxx",
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "Data": {
            "KnowledgeSets": [
                {
                    "Name": "name",
                    "Title": "title",
                    "Desc": "desc",
                    "Active": "ENABLED",
                    "CreateTime": "2024-06-04 18:07:38",
                    "UpdateTime": "2024-06-04 18:09:29"
                }
            ],
            "Total": 1
        },
        "RequestId": "f549082e-0cff-4026-96f6-a570d9f1c22d"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。