接入API数据源

概述

交换数据空间支持把API作为一种数据源类型，并用于数据上传和下载。在使用API数据源前，需要先接入数据源。

操作步骤

1. 登录交换数据空间官网。
2. 单击“管理控制台”，进入交换数据空间控制台界面。
3. 单击“我的空间”，在交换数据空间实例中，选择实例，单击实例卡片上的“连接器”。
4. 选择连接器，单击连接器卡片上的“前往”，进入连接器控制台界面。
5. 选择界面左侧导航栏中的“连接器管理 > 数据源管理”，进入“数据源管理”界面。
6. 单击数据源列表上方“新增数据源”，进入“新增数据源”界面，设置API数据源的基本信息，具体参数如表1所示。

   表1 参数说明

   参数	说明
   数据源类型	API：数据资源需要通过调用API接口获取。
   数据源名称	自定义数据源名称，建议按照一定的命名规则填写任务名称，方便快速识别和查找。要求长度范围为2位~50位。
   用途	新增API数据源适用于“采集数据”，系统默认，无需填写。
   数据源描述	用户可以根据需要在文本框中输入对该数据源的描述信息。

7. 设置完成后，配置API数据源请求信息，具体参数如表2所示。

   表2 参数说明

   参数	说明
   请求方式	选择API的请求方式。
   URL	填写API的请求URL地址，例如“https://{ip:port}/v1/token”。
   认证方式	选择API的请求认证方式。
   是否需要分页	选择是否需要分页执行。 选择为“是”表明系统执行API时会分页执行，分页字段会累加，直至查不出数据。 选择为“否”表明不需要分页执行。
   分页参数位置	“是否需要分页”配置为“是”时需配置。 选择分页参数位置，支持选择Params、Headers、Body。
   分页字段	“是否需要分页”配置为“是”时需配置。 表示从哪一页开始读取的字段名，例如pageNum，则request参数中的Params或者Headers或者Body里面需要手工增加该字段名（例如pageNum）和初始值（例如1）。
   分页大小字段	响应信息“response类型”配置为“Json”时且“是否需要分页”配置为“是”时需配置。 表示每页读取多少条记录的字段，例如pageSize，则request参数中的Params或者Headers或者Body里面需要手工增加该字段名（例如pageSize）和初始值（例如100）。
   Params	配置调用接口请求参数。
   Headers	配置调用接口请求消息头信息
   Body	配置调用接口请求消息体

8. 设置响应信息的响应信息，具体参数如所示。

   表3 参数说明

   参数	说明
   response类型	系统默认选择为“Json”。
   数据根字段	response类型选择为“Json”需配置。 若response body中被读取对象是json array，则请将该值设置为该对象的路径，例如： { "a":{"b":[{"c":"xx","d":"xx"},{"c":"xx","d":"xx"}]} } 若要读取最底层的json array，则请将该值设置为：a.b； 若response body中被读取对象是json object，可以不设置该值，不过meta的字段名必须是全路径，例如： { "a": {"b":{"c":"xx","d":"xx"} } } 若不设置该值，则meta的字段名就是a.b.c和a.b.d，若将该值设置为a.b，则meta的字段名就是c和d。

9. 连接参数配置完成后，单击“测试”，测试数据源是否可以和EDS进行正常的连通。
   • 若测试结果为“测试连接成功”，则返回文件信息（文件名、类型、大小），则继续下一步。
   • 若测试结果为“测试连接失败”，则根据返回的响应信息检查数据源状态和数据源连接参数配置，然后单击“测试”，直到连接成功为止。

10. 测试成功后，单击“提交”，返回数据源列表界面。