有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

获取用户词库列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeKeywordsLibs。
Version String 公共参数,本接口取值:2019-03-21。
Region String 公共参数,本接口不需要传递此参数。
Limit Integer 单页条数,最大为100条
示例值:100
Offset Integer 条数偏移量
示例值:300
Filters.N Array of Filters 过滤器(支持LibName模糊查询,CustomLibIDs词库id列表过滤)

3. 输出参数

参数名称 类型 描述
TotalCount Integer 词库记录数
示例值:50
Infos Array of KeywordsLibInfo 词库详情
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取用户词库列表

获取用户词库列表

输入示例

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

{
    "Limit": "10",
    "Offset": "0",
    "Filters": [
        {
            "Name": "LibName",
            "Values": [
                "test"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "Infos": [
            {
                "ID": "abc",
                "LibName": "abc",
                "Describe": "abc",
                "CreateTime": "abc",
                "Suggestion": "abc",
                "MatchType": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。