BLB准备

1. 开通负载均衡 BLB 服务。点击去开通。
2. 在负载均衡 BLB 中创建应用型实例。详见创建应用型BLB实例。

换绑BLB应用型实例

1. 选择对应文件夹旁边操作按钮，单击修改业务流程。
2. 在应用型实例选择需要换绑的选项后确定即换绑成功。注意：换绑后，业务流程下所有API均需要重新发布，请谨慎换绑。
3. 换绑BLB应用型实例后，API内容已修改，API变为待发布状态，支持重新发布。

API网关准备

开通API网关

数据共享服务需通过API网关转发到 EDAP 的，因此需要确保当前用户或子用户已经开通了 API 网关服务的权限。目前在完成实名认证后即可开通，开通 API网关。

创建API网关分组

API 网关的分组管理功能可以高效地、便捷地管理一组具有关联的 API。

操作步骤：

1. 登录并进入 API 网关 API GW。

2. 在左侧导航栏，单击API网关-分组管理，分组管理文档。
3. 单击新建分组。

4. 填写分组名称和分组描述信息，单击确认，即可完成分组创建。
5. 在创建完API网关分组后，会默认为每个网关分组提供一个内网域名。如需使用自定义域名，可点击下方绑定域名按钮，具体操作流程绑定自定义域名流程。

表一 表单项说明

名称	描述	使用限制
分组名称	网关分组名称	必填，分组名称必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~50个字符
描述	网关分组描述	非必填，0-180个字符

创建后端密钥

为保证后端收到的请求来源可靠，网关提供后端密钥签名验证功能，创建密钥并将密钥绑定到具体的 API 上即可开启后端签名。在登陆用户的“安全认证”页中，有对应的 Access Key 和 Secret Key ，获取 AK/SK文档。

操作步骤：

1. 登录并进入 API 网关 API GW。
2. 在左侧导航栏，单击API网关-后端密钥管理，后端密钥管理文档。
3. 单击“创建密钥”。
4. 填写完成后端密钥的信息。例如，创建密钥 xwd_test_sc。

表二 表单项说明

名称	描述	使用限制
密钥名称	密钥名称	必填，支持汉字，英文，数字，下划线，且只能以英文或汉字开头，4~50个字符
Key	Access Key	必填，支持字母，数字，下划线，中划线，！，@，#，$，%，字母或数字开头，16~64个字符
Secret	Secret Key	必填
确认secret	Secret Key	必填

创建EDAP数据共享API

新建业务流程

业务流程为 EDAP 数据共享中一组相同的 API 的分组集合，在新建业务流程时需要关联一个 API 网关分组。

操作步骤：

1. 登录并进入百度智能云数据湖管理与分析EasyDAP。

2. 在左侧导航栏，单击数据服务>API创建。

3. 单击新建按钮，下拉选择新建业务流程。

4. 填写业务流程名，并选择在 API 网关中创建的网关分组。例如，这里创建名为 xwd_test_group 的业务流程，并关联 xwd_test API 网关分组。

表三 创建业务流程说明

名称	描述	使用限制
业务名称	业务流程名称	必填，最大长度限制 100 字符
API 分组	选择在 API 网关中新建的网关分组	必填
应用型BLB实例	请选择已开通的BLB应用型实例	必填
描述	业务流程描述	非必填，最大长度限制 300 字符

新建API

向导模式

操作步骤：

1. 登录并进入百度智能云数据湖管理与分析EasyDAP。
2. 在左侧导航栏，单击数据服务-API创建。
3. 悬浮创建好的业务流程名，点击选新建API，或者单击上方的新建按钮，选择新建API。
4. 选择向导模式或脚本模式，并填写api名称业务流程等详细信息。

表四 配置项说明

名称	描述	使用限制
API名称	API 名称	必填，长度限制 4 - 50 字符
业务流程	选择配置该 API 存储的业务流程	必填
API Path	通过 API 网关访问该 API 的 HTTP 路径	必填，在同一个网关分组中 Path 需唯一。Path 必须以 / 开始，只能包含字母、数字、下划线、中划线，Path 中 / 不超过 70 个
协议	通过 API 网关访问的协议，支持 HTTP 和 HTTPS 两种方式	必填
请求方式	通过 HTTP 访问 API 的 METHOD，支持 HTTP GET 和 POST 两种方式	必填
返回类型	JSON返回参数的响应体的格式，目前支持	必填
描述	API 描述	非必填，最大长度限制 150 字符

选择表：

参数	输入规范
数据源类型	下拉选择，可选Doris/Greenplum/Clickhouse/ MySQL
数据源名称	下拉选择，与数据源管理中对应数据源类型的已有数据源目录保持一致
数据表名称	下拉选择，与选定数据源类型中的数据表名称保持一致

参数配置：

参数	输入规范
字段名称	--
字段类型	--
描述	--
设为请求参数	默认不选
设为返回参数	默认不选
添加到排序字段	默认不选

字段排序：

参数	输入规范
排序	--
字段名称	--
排序方式	下拉选择，默认升序
排序操作	--

请求参数/返回参数：

参数	输入规范
参数名称	与参数配置表中被选为请求参数的字段名称保持一致
参数显示名	--
参数类型	下拉选择，默认同步选定的数据表内参数配置对应的字段
参数位置	下拉选择：query/body，默认为query
是否必填	默认必填
操作符	下拉选择，可选列表：= / LIKE / IN / NOT IN / != / > / < / >= / <=，默认为=
示例值	默认为空
默认值	默认为空
描述	--
添加行数筛选	默认不选

返回行数筛选：

参数	输入规范
返回起始行	默认为空，仅可填写正整数
返回终止行	默认为空，仅可填写正整数
操作	--

转换为脚本模式

点击“转为脚本模式”可将向导模式API转换为脚本模式，向导模式已编辑的参数配置信息将会以代码的形式同步到脚本模式界面。

配置API

在新建完 API 之后，需要选择对应的需要查询的数据源，EDAP 提供了更为灵活的 SQL 脚本模式来查询数据并发布成数据共享服务。

操作步骤：

1. 登录并进入百度智能云数据湖管理与分析EasyDAP。
2. 在左侧导航栏，单击数据服务-API创建。
3. 选择创建好的业务流程和API。例如，这里选择创建的 xwd_test_api_01。

表五 表单项说明

名称	描述	使用限制
数据源类型	选择需要查询的数据源类型	必填，目前支持 Doris、MySQL、ClickHouse、GreenPlum 数据源
数据源	选择数据源类型下的需要查询的数据源连接	必填
查询 SQL	用于查询数据源 SQL 语句，其中 SELECT 后字段为返回参数，SQL 语句中由 ${ } 中的字段为请求参数。 例如：select empno, ename, job, mgr, hiredate, sal, comm, deptno from emp where empno= ${param_empno} 请求参数：param_empno 返回参数：empno, ename, job, mgr, hiredate, sal, comm, deptno	必填 支持同一数据源下的单表查询、多表关联查询和嵌套查询 不支持多条SQL语句 只支持 SELECT 查询语句，不支持 INSERT、UPDATE 和 DELETE 等语法 不支持 SELECT * 语法，必须明确指定查询的列 如果查询列的列名带有表名前缀或使用聚合函数（min、max、sum和count等），必须取别名作为返回参数名

4. 配置请求参数：在根据规则配置完成 SQL 模版之后，单击右侧请求参数，并单击自动解析会根据规则解析出对应的请求参数。请求参数页面表单展示分页参数，用户可通过勾选（选择是否需要开启结果分页）。

注意：

• 可通过勾选框开启结果分页，默认为关闭状态。前两行pageNum和pageSize作为分页参数，其【参数位置】、【示例值】、【默认值】均为可编辑状态，【示例值】和【默认值】默认对应填写10和1；
• 若不开启结果分页，将默认一次性返回所有数据且上限为1000；
• 开启结果分页可将API返回的数据分成多页，可以根据特定的需求获取所需的数据，而不必一次性获取所有数据；若开启结果分页，建议添加排序信息以确保每次查询返回顺序相同的结果。

表六 表单项说明

名称	描述	使用限制
参数名称	默认为 SQL 中 ${} 中的参数。 pageSize pageNum totalNum	必填
参数类型	参数类型，支持 STRING、INT、LONG、FLOAT、DOUBLE、BOOLEAN 类型	必填
参数位置	指定在通过 HTTP 请求时候解析该参数的位置，支持 QUERY、BODY 两种类型	必填 QUERY：最终的请求参数需要放在url中，如 http://xxxx/v1/data-service-api/default/queryStu?age=10" BODY：最终的请求参数放在请求body中，使用json的方式发送，如 curl -X POST http://xxxx -d '{"age":10}'
是否必填	参数是否必填
示例值	给调用者提供参数的示例值	非必填，示例值需满足参数类型
默认值	参数默认值	非必填，示例值需满足参数类型
描述	pageSize:每页的数据条数，即一页中最多展示多少条数据 pageNum:当前页码，即请求返回的是第几页的数据 totalNum:总数据条数，即满足查询条件的数据总共有多少条。	必填

5. 配置返回参数：在根据规则配置完成 SQL 模版之后，单击右侧返回参数，并单击自动解析会根据规则解析出对应的返回参数。

表七 表单项说明

名称	描述	使用限制
参数名称	SELECT 查询的字段名或别名	必填
参数类型	参数类型，支持 STRING、INT、LONG、FLOAT、DOUBLE、BOOLEAN 类型	必填
示例值	给调用者提供参数的示例值	非必填，示例值需满足参数类型
描述	对于返回参数的描述	非必填

测试API

测试 API，可用于验证所配置的查询语句是否满足预期，且只有在测试完 API 之后才能发布 API。

操作步骤：

1. 登录并进入百度智能云数据湖管理与分析EasyDAP。
2. 在左侧导航栏，单击数据服务-API创建。
3. 选择创建好的业务流程和API。
4. 单击对应的 API，进入到 API 配置界面。例如，这里测试 API xwd_test_api_01，输入参数值。
5. 在设置了对应的参数值之后，单击开始测试，可以看到对应查询出来的数据。

发布API

只有测试 API 成功了，才会允许发布 API。发布 API 即将发布到 API 网关供数据使用者调用。

操作步骤：

1. 登录并进入百度智能云数据湖管理与分析EasyDAP。
2. 在左侧导航栏，单击数据服务-API创建。
3. 选择创建好的业务流程和API。
4. 单击对应的 API，进入到 API 配置界面。
5. 单击发布按钮，发布 API。