API 数据源

添加API数据源

1. 在实例详情>表管理页，点击添加表。

2. 填写表的基础信息，点击下一步：

   表基础信息包括表名称、分片数和数据更新资源数三个配置项，填写完成后单击下一步。

   配置说明：

• 表名称：可自定义

• 数据分片数：分片数设置时，各索引表分片数需保持一致；或至少一个索引表分片数为1，其余索引表分片数一致，表分片数不超过256的正整数即可（建议不超过实例数据节点数的3倍）。

• 数据更新资源数：数据更新所用资源数，每个索引默认免费提供2个4核8G的更新资源，超出免费额度的资源将产生费用，详情可参考召回引擎版计费概述。

3. 数据同步，配置数据源，点击下一步：

   在全量数据来源中，选择API，然后单击下一步。

   配置参数说明：

• 数据源类型：选择API推送数据源，表示用户的数据通过API的方式推送至实例中。

4. 索引结构，对字段、索引进行设置，设置完毕后点击下一步：

   在字段设置区域，添加字段 id（类型 INT64，设为主键，勾选属性字段和搜索结果展示，数据压缩选择 equal）和字段 namespace（类型 STRING，勾选属性字段和搜索结果展示，数据压缩选择 uniq）。在索引设置区域，配置索引 id（类型 PRIMARYKEY128，包含字段 id）和索引 test_name（类型 STRING，包含字段 namespace）。

5. 确认创建，点击确认创建后，系统将自动创建配置好的表：

   系统提示：确认后将自动基于选定的并发资源进行索引构建，构建完成后的索引将自动在当前实例中启用。单击确认创建完成操作。

6. 展开变更流程新增数据源部署，可查看各变更节点的执行状态，包括参数检查、创建配置、创建消息队列、创建扫描计划、创建索引构建计划、创建清理计划和修改表状态等步骤。变更信息中显示对应的集群名称和数据源名称。

7. 当表状态在使用中时，即可在查询测试页面进行查询测试。

注意事项

• API数据源索引重建时会将以前推送的数据清空，从指定的时间戳开始追实时数据，所以API数据源全量要慎重。

• API数据源删除时要确认未使用状态才可以删除。