# 查询知识列表接口 #### 场景描述 调用该接口，可根据搜索关键字查询标题或内容包含该关键字的知识列表。 该接口一次查询最多支持返回100条数据，如命中知识数多于100条，请多次轮询该接口，设置offset值实现返回更多数据。 #### 接口方法 该接口仅支持POST方法。 #### 接口URI https://域名/apiaccess/ccikbs/v1/columnkngapi/advancedSearch，例如域名是service.besclouds.com。 #### 请求说明 表1请求消息头参数说明 | 序号 | 名称 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | Content-Type | String | True | 固定填 application/json;charset=UTF-8（两种鉴权方式都填写）。 | | 2 | x-app-key | string | True | appKey字段，用户标识，请联系运营人员获取appKey。 | | 3 | Authorization | String | True | 鉴权信息， 格式如下所示。 Bearer *Access Token*。 Access Token的生成方式参见[C1 系统配置类接口鉴权方式](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0100.html#ZH-CN_TOPIC_0000002481113506)。 | 表2请求消息体参数说明 | 序号 | 名称 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | keyword | String | True | 搜索知识的关键字。 | | 2 | offset | Number | True | 分页查询偏移量，默认值0，即不需要偏移，最大值请不要超过100000。 | | 3 | limit | Number | True | 分页查询时单页最多的记录条数，最大值请不要超过100。 | | 4 | code | String | False | 栏目编码。为栏目或者知识在栏目知识树上的节点编码。 | | 5 | coluKngType | String | False | 栏目知识类型。取值范围： - 1：栏目 - 2：普通知识 - 3：问答知识 | | 6 | startTime | Number | False | 开始时间。(时间戳) | | 7 | endTime | Number | False | 结束时间。(时间戳) | | 8 | userName | String | True | 用于在AICC系统中查询栏目的操作员账号，该账号在AICC侧必须拥有"知识库 \> 知识栏目"和"知识库 \> 知识主页"中至少一个权限。 | #### 响应说明 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看[表3]。 表3响应消息体参数说明 | 序号 | 名称 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | resultCode | String | 请求返回的结果码。取值范围： - 0为成功 - 1为失败 | | 2 | description | String | 请求结果描述。 | | 3 | data | Object | 请求结果对象，参数说明详见[表4] | 表4data对象参数说明 | 序号 | 名称 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | total | String | 查询数量。 | | 2 | results | List | 参数说明详见[表5] | 表5results对象参数说明 | 序号 | 名称 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | adjs | String | 栏目知识附件。 | | 2 | code | String | 栏目编码。为栏目或者知识在栏目知识树上的节点编码。 | | 3 | coluKngType | String | 栏目知识类型。取值范围： - 1：栏目 - 2：普通知识 - 3：问答知识 | | 4 | orderId | String | 排序编号。 | | 5 | creatorId | String | 创建人工号。 | | 6 | modifierId | String | 修改人工号。 | | 7 | creatorName | String | 创建人名称。 | | 8 | beyondColuPath | String | 所属栏目路径。首层栏目所属路径为/。 | | 9 | contentInfo | String | 知识内容。 | | 10 | coluKngName | String | 栏目知识名称。 | | 11 | modifyTime | Number | 修改时间。 | | 12 | validEndTime | Number | 有效期结束时间。 | | 13 | summaryInfo | String | 概要信息。 | | 14 | serviceStatus | Number | 业务状态。取值范围： - 1：普通 - 2：热点 - 3：新业务 - 4：更新业务 - 5：过期 | | 15 | clickNum | Number | 点击次数。 | | 16 | keyword | String | 关键字。 | | 17 | coluKngId | String | 栏目知识ID。 | | 18 | curVersionNum | Number | 当前版本号。 | | 19 | validStartTime | Number | 有效期开始时间。 | | 20 | kngPath | String | 知识路径。 | | 21 | superCode | String | 栏目上级编码。 | | 22 | beyondColuId | String | 父栏目ID。 | | 23 | createTime | Number | 创建时间。 | | 24 | kngAdj | String | 栏目知识附件。 | | 25 | tenantId | String | 租间ID。 | #### 报文样例 - 请求头 ``` x-app-key: b*************c7b Authorization: Bearer 1fea*************1d6a15 Content-Type: application/json ``` - 请求参数 ``` { "keyword": "001", "offset": 0, "limit": 10, "code": "001", "coluKngType": "2", "startTime": 1658474893000, "endTime": 1658820502000, "userName": "aicc_test001" } ``` - 响应参数 ``` { "returnCode": "0", "description": "success", "data": { "total": 1, "results": [ { "adjs": null, "code": "001004", "coluKngType": 2, "orderId": 3, "creatorId": "1662469040313943431", "modifierId": "1662469040313943431", "creatorName": "lzd0906003", "beyondColuPath": "/lzd0916父栏目", "contentInfo": "业务知识 ", "coluKngName": "lzd父栏目0916005下的知识001", "modifyTime": "20220916153223", "validEndTime": "2022-12-16 14:22:34", "summaryInfo": "", "serviceStatus": 1, "clickNum": 0, "keyword": "", "coluKngId": "342ffe28003147f28b47da7d729d10e5", "curVersionNum": 1, "validStartTime": "2022-09-16 14:22:34", "kngPath": null, "superCode": "001", "beyondColuId": "63e3e4b42c94482b95e04e911f497fbb", "createTime": "2022-09-16 15:32:00", "kngAdj": null, "tenantId": "202209065604" } ] } } ```