创建数据源

创建一个数据源。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/search/v2/data_sources
HTTP Method	POST
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	search:data_source 查询、创建、修改和删除自定义搜索数据源、数据范式或数据项

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

请求体

名称	类型	必填	描述
name	string	是	data_source的展示名称 示例值："客服工单"
state	int	否	数据源状态，0-已上线，1-未上线。如果未填，默认是未上线状态。 示例值：0 可选值有： - 0: 已上线 - 1: 未上线
description	string	否	对于数据源的描述 示例值："搜索客服工单数据"
icon_url	string	否	数据源在 search tab 上的展示图标路径，建议使用png或jpeg格式，否则可能无法在客户端正常展示 示例值："https://www.xxx.com/open.jpg"
template	string	否	数据源采用的展示模版名称 示例值："search_common_card" 默认值：search_common_card
searchable_fields	string\[\]	否	【已废弃，如有定制需要请使用“数据范式”接口】描述哪些字段可以被搜索 示例值：【已废弃，如有定制需要请使用“数据范式”接口】["field1", "field2"]
i18n_name	i18n_meta	否	数据源的国际化展示名称
└ zh_cn	string	否	国际化字段：中文 示例值："任务"
└ en_us	string	否	国际化字段：英文 示例值："TODO"
└ ja_jp	string	否	国际化字段：日文 示例值："タスク"
i18n_description	i18n_meta	否	数据源的国际化描述
└ zh_cn	string	否	国际化字段：中文 示例值："任务"
└ en_us	string	否	国际化字段：英文 示例值："TODO"
└ ja_jp	string	否	国际化字段：日文 示例值："タスク"
schema_id	string	否	数据源关联的 schema 标识 示例值："custom_schema"

请求体示例

{
    "name": "客服工单",
    "description": "xxx",
    "icon_url": "yyy",
    "schema_id": "example_schema",
    "template": "",
    "state": 0
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ data_source	data_source	数据源实例
└ id	string	数据源的唯一标识
└ name	string	data_source的展示名称
└ state	int	数据源状态，0-已上线，1-未上线。如果未填，默认是未上线状态。 可选值有： - 0: 已上线 - 1: 未上线
└ description	string	对于数据源的描述
└ create_time	string	创建时间，使用Unix时间戳，单位为“秒”
└ update_time	string	更新时间，使用Unix时间戳，单位为“秒”
└ is_exceed_quota	boolean	是否超限
└ icon_url	string	数据源在 search tab 上的展示图标路径，建议使用png或jpeg格式，否则可能无法在客户端正常展示
└ template	string	数据源采用的展示模版名称
└ searchable_fields	string\[\]	【已废弃，如有定制需要请使用“数据范式”接口】描述哪些字段可以被搜索
└ i18n_name	i18n_meta	数据源的国际化展示名称
└ zh_cn	string	国际化字段：中文
└ en_us	string	国际化字段：英文
└ ja_jp	string	国际化字段：日文
└ i18n_description	i18n_meta	数据源的国际化描述
└ zh_cn	string	国际化字段：中文
└ en_us	string	国际化字段：英文
└ ja_jp	string	国际化字段：日文
└ schema_id	string	数据源关联的 schema 标识

响应体示例

{
    "code": "0",
    "msg": "success",
    "data": {
        "data_source": {
            "id": 6953903108179099667,
            "name": "客服工单",
            "description": "xxx",
            "icon_url": "yyy",
            "template": "",
            "state": 0,
            "is_exceed_quota": false
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1270001	系统内部错误	联系系统开发人员协助定位
400	1270002	参数错误	根据错误信息和文档排查非法参数
500	1270003	调用失败	如果重试后仍然失败，请联系系统开发人员
400	1270005	该功能仅对旗舰版可用	请联系销售人员升级套餐以使用此高级功能
400	1271005	数据源数量超过限制	联系管理员升级或者删除一些数据源
400	1271006	openAppID 已经关联应用	查看是否已经用该开放平台应用关联过数据源